org.carewebframework.shell.ancillary

Class RelatedClassMap

java.lang.Object

org.carewebframework.shell.ancillary.RelatedClassMap

public class RelatedClassMap
extends Object

Defines cardinality relationships between layout elements. This is used to constrain parent-child relationships.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelatedClassMap.Cardinality Represents cardinality from source class to target class.

Constructor Summary

Constructors

Constructor and Description
RelatedClassMap()

Method Summary

Modifier and Type	Method and Description
void	addCardinality(Class<? extends ElementBase> sourceClass, Class<? extends ElementBase> targetClass, int maxOccurrences) Adds cardinality relationship between source and target classes.
org.carewebframework.shell.ancillary.RelatedClassMap.Cardinalities	getCardinalities(Class<? extends ElementBase> sourceClass) Returns the cardinalities associated with this class or a superclass.
RelatedClassMap.Cardinality	getCardinality(Class<? extends ElementBase> sourceClass, Class<? extends ElementBase> targetClass) Returns the cardinality between two element classes.
int	getTotalCardinality(Class<? extends ElementBase> sourceClass) Returns the sum of cardinalities across all related classes.
boolean	hasRelated(Class<? extends ElementBase> sourceClass) Returns true if the specified class has any related classes (i.e., has a total cardinality > 0).
boolean	isRelated(Class<? extends ElementBase> sourceClass, Class<? extends ElementBase> targetClass) Returns true if targetClass or a superclass of targetClass is related to sourceClass.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RelatedClassMap

public RelatedClassMap()

Method Detail

getCardinalities

public org.carewebframework.shell.ancillary.RelatedClassMap.Cardinalities getCardinalities(Class<? extends ElementBase> sourceClass)

Returns the cardinalities associated with this class or a superclass.

Parameters:

sourceClass - Class whose relation is sought.

Returns:

The cardinalities, or null if none found.

addCardinality

public void addCardinality(Class<? extends ElementBase> sourceClass,
                           Class<? extends ElementBase> targetClass,
                           int maxOccurrences)

Adds cardinality relationship between source and target classes.

Parameters:

sourceClass - The source class.

targetClass - Class to be registered.

maxOccurrences - Maximum occurrences for this relationship.

hasRelated

public boolean hasRelated(Class<? extends ElementBase> sourceClass)

Returns true if the specified class has any related classes (i.e., has a total cardinality > 0).

Parameters:

sourceClass - The source class.

Returns:

True if the specified class has any related classes.

getTotalCardinality

public int getTotalCardinality(Class<? extends ElementBase> sourceClass)

Returns the sum of cardinalities across all related classes.

Parameters:

sourceClass - The source class.

Returns:

The sum of cardinalities across all related classes.

isRelated

public boolean isRelated(Class<? extends ElementBase> sourceClass,
                         Class<? extends ElementBase> targetClass)

Returns true if targetClass or a superclass of targetClass is related to sourceClass.

Parameters:

sourceClass - The primary class.

targetClass - The class to test.

Returns:

True if targetClass or a superclass of targetClass is related to sourceClass.

getCardinality

public RelatedClassMap.Cardinality getCardinality(Class<? extends ElementBase> sourceClass,
                                                  Class<? extends ElementBase> targetClass)

Returns the cardinality between two element classes.

Parameters:

sourceClass - The primary class.

targetClass - The class to test.

Returns:

The cardinality in the class relationship (never null).