org.faktorips.runtime.model.type

Class Association

java.lang.Object

org.faktorips.runtime.model.type.ModelElement

org.faktorips.runtime.model.type.TypePart

org.faktorips.runtime.model.type.Association

All Implemented Interfaces:

IModelElement, IModelTypeAssociation

Direct Known Subclasses:

PolicyAssociation, ProductAssociation

public abstract class Association
extends TypePart
implements IModelTypeAssociation

An association between two Types.

Nested Class Summary

Nested classes/interfaces inherited from interface org.faktorips.runtime.modeltype.IModelTypeAssociation

IModelTypeAssociation.AssociationType

Constructor Summary

Constructors

Constructor and Description
Association(Type type, Method getterMethod)

Method Summary

Methods

Modifier and Type	Method and Description
abstract Association	createOverwritingAssociationFor(Type subType)
AssociationKind	getAssociationKind() Returns what kind of association this is.
IModelTypeAssociation.AssociationType	getAssociationType() Deprecated. Use getAssociationKind()
protected Method	getGetterMethod()
String	getInverseAssociation() Returns the name of the inverse association if it is defined.
String	getLabelForPlural(Locale locale) Returns the plural label for this model element in the specified locale.
Association	getMatchingAssociation() Returns the matching product respectively policy component type association or null if no matching association is defined for this association.
String	getMatchingAssociationName() Returns the name of the matching product respectively policy component type association or null if no matching association is defined for this association.
String	getMatchingAssociationSource() Returns the qualified name of source type of the matching association or null if no matching association is defined.
Type	getMatchingAssociationSourceType() Returns the Type identified by getMatchingAssociationSource()
int	getMaxCardinality() Returns the maximum cardinality for this association.
int	getMinCardinality() Returns the minimum cardinality for this association.
String	getNamePlural() Returns the plural form of this model type's name or the empty String if no plural for the name is set.
Type	getTarget() Returns the target Type of this association.
String	getUsedName() Returns the singular or plural form of this association's name as used in code generation depending on cardinality.
boolean	isDerivedUnion() Returns if this association is a derived union.
boolean	isMatchingAssociationPresent() Returns true if the association has a matching association.
boolean	isProductRelevant() Deprecated. Since 3.18, use isMatchingAssociationPresent
boolean	isSubsetOfADerivedUnion() Returns if this association is a subset of a derived union.
String	toString()

Methods inherited from class org.faktorips.runtime.model.type.TypePart

getMessageHelper, getMessageKey, getModelType, getType, getTypeName

Methods inherited from class org.faktorips.runtime.model.type.ModelElement

createMessageHelper, getDescription, getDocumentation, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getName, getRelevantProductObject, invokeField, invokeMethod

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.faktorips.runtime.modeltype.IModelTypeAssociation

getModelType

Methods inherited from interface org.faktorips.runtime.modeltype.IModelElement

getDescription, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getName

Constructor Detail

Association

public Association(Type type,
           Method getterMethod)

Method Detail

getLabelForPlural

public String getLabelForPlural(Locale locale)

Returns the plural label for this model element in the specified locale. If there is no plural label in the specified locale, it tries to find the plural label in the default locale. If there is also no plural label in the default locale the element's plural name is returned.

Specified by:

getLabelForPlural in interface IModelTypeAssociation

Returns:

the label for the given locale or the element's name if no label exists for the given locale nor in the default locale

getAssociationKind

public AssociationKind getAssociationKind()

Returns what kind of association this is.

getAssociationType

@Deprecated
public IModelTypeAssociation.AssociationType getAssociationType()

Deprecated. Use getAssociationKind()

Returns what kind of association this is.

Specified by:

getAssociationType in interface IModelTypeAssociation

getMinCardinality

public int getMinCardinality()

Returns the minimum cardinality for this association. 0 if no minimum is set.

Specified by:

getMinCardinality in interface IModelTypeAssociation

getMaxCardinality

public int getMaxCardinality()

Returns the maximum cardinality for this association. Integer.MAX_VALUE if no maximum is set.

Specified by:

getMaxCardinality in interface IModelTypeAssociation

getNamePlural

public String getNamePlural()

Returns the plural form of this model type's name or the empty String if no plural for the name is set.

Specified by:

getNamePlural in interface IModelTypeAssociation

getTarget

public Type getTarget()

Returns the target Type of this association.

Specified by:

getTarget in interface IModelTypeAssociation

getUsedName

public String getUsedName()

Returns the singular or plural form of this association's name as used in code generation depending on cardinality.

Specified by:

getUsedName in interface IModelTypeAssociation

isDerivedUnion

public boolean isDerivedUnion()

Returns if this association is a derived union.

Specified by:

isDerivedUnion in interface IModelTypeAssociation

isSubsetOfADerivedUnion

public boolean isSubsetOfADerivedUnion()

Returns if this association is a subset of a derived union.

Specified by:

isSubsetOfADerivedUnion in interface IModelTypeAssociation

getInverseAssociation

public String getInverseAssociation()

Returns the name of the inverse association if it is defined.

Specified by:

getInverseAssociation in interface IModelTypeAssociation

Returns:

The name of the inverse association or null if there is no inverse association or it is a product component associations

isProductRelevant

@Deprecated
public boolean isProductRelevant()

Deprecated. Since 3.18, use isMatchingAssociationPresent

Returns if this association is product relevant.

Specified by:

isProductRelevant in interface IModelTypeAssociation

isMatchingAssociationPresent

public boolean isMatchingAssociationPresent()

Returns true if the association has a matching association. For policy associations that means it is configured by the product component. For product component associations that means it configures a policy association.

Specified by:

isMatchingAssociationPresent in interface IModelTypeAssociation

Returns:

true if this association has a matching association.

See Also:

getMatchingAssociationName()

getMatchingAssociationName

public String getMatchingAssociationName()

Returns the name of the matching product respectively policy component type association or null if no matching association is defined for this association.

Example: Taking two policy component types called 'Policy' and 'Coverage' with a composition association between them. Policy is constrained by the product component type 'Product' and coverage by 'CoverageType'. There is also an association from 'Product' to 'CoverageType'. The product association configures the policy association. If this is a model type association for the policy association this method returns the name of the matching product association and vice versa.

Specified by:

getMatchingAssociationName in interface IModelTypeAssociation

Returns:

The name of the matching association

getMatchingAssociation

public Association getMatchingAssociation()

Returns the matching product respectively policy component type association or null if no matching association is defined for this association.

Example: Taking two policy component types called 'Policy' and 'Coverage' with a composition association between them. Policy is constrained by the product component type 'Product' and coverage by 'CoverageType'. There is also an association from 'Product' to 'CoverageType'. The product association configures the policy association. If this is a association for the policy association this method returns the matching product association and vice versa.

Returns:

The matching association

getMatchingAssociationSource

public String getMatchingAssociationSource()

Returns the qualified name of source type of the matching association or null if no matching association is defined.

Example: Taking two policy component types called 'Policy' and 'Coverage' with a composition association between them. Policy is constrained by the product component type 'Product' and coverage by 'CoverageType'. There is also an association from 'Product' to 'CoverageType'. The product association configures the policy association. If this is a model type association for the policy association this method returns the qualified name of the source of the matching product association and vice versa. The source is the type which defines the matching association.

Specified by:

getMatchingAssociationSource in interface IModelTypeAssociation

Returns:

The qualified name of the matching association source

getMatchingAssociationSourceType

public Type getMatchingAssociationSourceType()

Returns the Type identified by getMatchingAssociationSource()

Specified by:

getMatchingAssociationSourceType in interface IModelTypeAssociation

Returns:

The Type of the matching association source

See Also:

getMatchingAssociationSource()

getGetterMethod

protected Method getGetterMethod()

createOverwritingAssociationFor

public abstract Association createOverwritingAssociationFor(Type subType)

toString

public String toString()

Overrides:

toString in class ModelElement