org.faktorips.runtime.model.type

Class ProductCmptType

java.lang.Object

org.faktorips.runtime.model.type.ModelElement

org.faktorips.runtime.model.type.Type

org.faktorips.runtime.model.type.ProductCmptType

All Implemented Interfaces:

IModelElement, IModelType

public class ProductCmptType
extends Type

Corresponds to a design time IProductCmptType.

Nested Class Summary

Nested classes/interfaces inherited from class org.faktorips.runtime.model.type.Type

Type.AnnotatedElementMatcher<T extends Annotation>

Field Summary

Fields

Modifier and Type	Field and Description
static String	KIND_NAME The name of the design time implementation class.

Constructor Summary

Constructors

Constructor and Description
ProductCmptType(String name, AnnotatedDeclaration annotatedDeclaration)

Method Summary

Modifier and Type	Method and Description
ProductAssociation	getAssociation(String name) Returns the association with the given name declared in this type or one of it's super types.
List<ProductAssociation>	getAssociations() Returns the type's associations including those defined in it's super types.
ProductAttribute	getAttribute(String name) Returns the attribute with the given name declared in this type or one of it's super types.
List<ProductAttribute>	getAttributes() Returns a list containing the type's attributes including those defined in the type's super types.
ProductAssociation	getDeclaredAssociation(int index) Returns the association at the given index.
ProductAssociation	getDeclaredAssociation(String name) Returns the association with the given name declared in this type.
List<ProductAssociation>	getDeclaredAssociations() Returns a list containing all associations declared in this type.
ProductAttribute	getDeclaredAttribute(int index) Returns the declared attribute at the given index.
ProductAttribute	getDeclaredAttribute(String name) Returns the attribute with the given name declared in this type.
List<ProductAttribute>	getDeclaredAttributes() Returns a list containing all attributes declared in this model type.
protected List<Method>	getDeclaredMethods()
TableUsage	getDeclaredTableUsage(String name) Returns the TableUsage with the given name which is declared in this type.
List<TableUsage>	getDeclaredTableUsages() Returns a list of TableUsages which are declared in this type.
Class<?>	getGenerationDeclarationClass()
Class<?>	getGenerationJavaClass()
Class<?>	getGenerationJavaInterface()
protected String	getKindName()
PolicyCmptType	getPolicyCmptType() Returns the policy component type which is configured by this product component type.
ProductCmptType	getSuperType() Returns this type's super type or null if it has none.
TableUsage	getTableUsage(String name) Returns the TableUsage for the specified name.
List<TableUsage>	getTableUsages() Returns a list of TableUsages which are declared in this type or in any super type.
boolean	hasDeclaredTableUsage(String name) Returns whether the TableUsage for the specified name is declared in this type.
boolean	isAssociationDeclared(String name) Returns whether the association with the given name is declared in this type.
boolean	isAttributeDeclared(String name) Returns whether the attribute with the given name is declared in this type.
boolean	isChangingOverTime() Returns whether this product component type is changing over time.
boolean	isConfigurationForPolicyCmptType() Returns whether this product component type is a configuration for a policy component type.

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

getAnnotatedDeclaration, getDeclarationClass, getJavaClass, getJavaInterface, getMessageHelper, getMessageKey, isAssociationPresent, isAttributePresent, isSuperTypePresent, searchDeclaredMethod, toString

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.IModelElement

getDescription, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getName

Field Detail

KIND_NAME

public static final String KIND_NAME

The name of the design time implementation class. Don't ask about the 2.

See Also:

Constant Field Values

Constructor Detail

ProductCmptType

public ProductCmptType(String name,
                       AnnotatedDeclaration annotatedDeclaration)

Method Detail

getKindName

protected String getKindName()

Specified by:

getKindName in class Type

getDeclaredMethods

protected List<Method> getDeclaredMethods()

Overrides:

getDeclaredMethods in class Type

isChangingOverTime

public boolean isChangingOverTime()

Returns whether this product component type is changing over time.

Returns:

true if it has generations else false

isConfigurationForPolicyCmptType

public boolean isConfigurationForPolicyCmptType()

Returns whether this product component type is a configuration for a policy component type.

Returns:

true if this type configures a policy component type, false if not

getPolicyCmptType

public PolicyCmptType getPolicyCmptType()

Returns the policy component type which is configured by this product component type. If this product component class has no configuration it throws a NullPointerException.

Returns:

The configured policy component type

Throws:

NullPointerException - if the product component type is not a configuration for a policy component type

See Also:

isConfigurationForPolicyCmptType()

getTableUsage

public TableUsage getTableUsage(String name)

Returns the TableUsage for the specified name. May look in super types if there is no table usage in this type.

Parameters:

name - The name of the table usage

Returns:

The TableUsage with the specified name

Throws:

IllegalArgumentException - if there is no table usage with the specified name

getDeclaredTableUsages

public List<TableUsage> getDeclaredTableUsages()

Returns a list of TableUsages which are declared in this type. In contrast to getTableUsages() this does not return table usages of super types.

Returns:

A list of TableUsages declared in this type

getDeclaredTableUsage

public TableUsage getDeclaredTableUsage(String name)

Returns the TableUsage with the given name which is declared in this type. Any table usage defined in the super types will not be returned.

Parameters:

name - The name of the TableUsage

Returns:

TableUsage declared in this type with the given name

Throws:

IllegalArgumentException - if this type does not have a declared table usage with the given name

hasDeclaredTableUsage

public boolean hasDeclaredTableUsage(String name)

Returns whether the TableUsage for the specified name is declared in this type.

getTableUsages

public List<TableUsage> getTableUsages()

Returns a list of TableUsages which are declared in this type or in any super type.

Returns:

All TableUsages accessible in this product type.

getGenerationJavaClass

public Class<?> getGenerationJavaClass()

getGenerationJavaInterface

public Class<?> getGenerationJavaInterface()

getGenerationDeclarationClass

public Class<?> getGenerationDeclarationClass()

getSuperType

public ProductCmptType getSuperType()

Description copied from class: Type

Returns this type's super type or null if it has none.

Specified by:

getSuperType in interface IModelType

Specified by:

getSuperType in class Type

getDeclaredAttribute

public ProductAttribute getDeclaredAttribute(int index)

Description copied from class: Type

Returns the declared attribute at the given index.

Specified by:

getDeclaredAttribute in interface IModelType

Overrides:

getDeclaredAttribute in class Type

getDeclaredAttribute

public ProductAttribute getDeclaredAttribute(String name)

Description copied from class: Type

Returns the attribute with the given name declared in this type. Attributes defined in the type's super types are not returned.

Specified by:

getDeclaredAttribute in interface IModelType

Specified by:

getDeclaredAttribute in class Type

Parameters:

name - the name of the attribute

Returns:

the attribute if it was found in this type

See Also:

Type.isAttributeDeclared(String)

getDeclaredAttributes

public List<ProductAttribute> getDeclaredAttributes()

Description copied from class: Type

Returns a list containing all attributes declared in this model type. Attributes defined in the type's super types are not returned.

Specified by:

getDeclaredAttributes in interface IModelType

Specified by:

getDeclaredAttributes in class Type

Returns:

the list of attributes declared in this type

getAttribute

public ProductAttribute getAttribute(String name)

Description copied from class: Type

Returns the attribute with the given name declared in this type or one of it's super types.

Specified by:

getAttribute in interface IModelType

Overrides:

getAttribute in class Type

getAttributes

public List<ProductAttribute> getAttributes()

Description copied from class: Type

Returns a list containing the type's attributes including those defined in the type's super types.

Specified by:

getAttributes in interface IModelType

Specified by:

getAttributes in class Type

Returns:

the list of all attributes declared in this type or in any supertype

isAttributeDeclared

public boolean isAttributeDeclared(String name)

Description copied from class: Type

Returns whether the attribute with the given name is declared in this type. Attributes defined in the type's super types are not considered.

Specified by:

isAttributeDeclared in class Type

Parameters:

name - the name of the attribute

Returns:

true if the attribute is declared in this type, false if not

getDeclaredAssociation

public ProductAssociation getDeclaredAssociation(int index)

Description copied from class: Type

Returns the association at the given index. Associations defined in the type's super types are not returned.

Specified by:

getDeclaredAssociation in interface IModelType

Overrides:

getDeclaredAssociation in class Type

getDeclaredAssociation

public ProductAssociation getDeclaredAssociation(String name)

Description copied from class: Type

Returns the association with the given name declared in this type. Associations defined in the type's super types are not considered. The name could either be the singular or the plural name.

Specified by:

getDeclaredAssociation in interface IModelType

Specified by:

getDeclaredAssociation in class Type

Parameters:

name - the name of the association

Returns:

the association if it was found in this type

See Also:

Type.isAssociationDeclared(String)

getDeclaredAssociations

public List<ProductAssociation> getDeclaredAssociations()

Description copied from class: Type

Returns a list containing all associations declared in this type. Associations defined in the type's super types are not returned.

Specified by:

getDeclaredAssociations in interface IModelType

Specified by:

getDeclaredAssociations in class Type

Returns:

the list of associations declared in this type

isAssociationDeclared

public boolean isAssociationDeclared(String name)

Description copied from class: Type

Returns whether the association with the given name is declared in this type. Associations defined in the type's super types are not considered.

Specified by:

isAssociationDeclared in class Type

Parameters:

name - the name of the association

Returns:

true if the association is declared in this type, false if not

See Also:

Type.isAssociationPresent(String)

getAssociation

public ProductAssociation getAssociation(String name)

Description copied from class: Type

Returns the association with the given name declared in this type or one of it's super types. The name could either be the singular or the plural name.

Specified by:

getAssociation in interface IModelType

Overrides:

getAssociation in class Type

getAssociations

public List<ProductAssociation> getAssociations()

Description copied from class: Type

Returns the type's associations including those defined in it's super types.

Specified by:

getAssociations in interface IModelType

Specified by:

getAssociations in class Type

Returns:

the list of all associations declared in this type or in any super type