org.faktorips.runtime.internal

Class ProductComponent

java.lang.Object

org.faktorips.runtime.internal.RuntimeObject

org.faktorips.runtime.internal.ProductComponent

All Implemented Interfaces:

IClRepositoryObject, IXmlPersistenceSupport, IProductComponent, IProductComponentLinkSource, IRuntimeObject

public abstract class ProductComponent
extends RuntimeObject
implements IProductComponent, IXmlPersistenceSupport

Base class for all product components.

Deliberately implements IXmlPersistenceSupport directly. Letting IProductComponent extend IXmlPersistenceSupport would have published it, which is undesired.

Constructor Summary

Constructors

Constructor and Description
ProductComponent(IRuntimeRepository repository, String id, String productKindId, String versionId) Creates a new product component with the indicate id, kind id and version id.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitPropertiesFromXml(Map<String,Element> map) Initializes the properties with the data in the map.
protected void	doInitReferencesFromXml(Map<String,List<Element>> linkElements)
IProductComponentGeneration	getGenerationBase(Calendar effectiveDate) Returns the generation that is effective on the given date or null if no generation is effective on that date.
String	getId() Returns the product component's id that uniquely identifies it in the repository it belongs to.
String	getKindId() Returns the id of the product component kind that this product component belongs to.
IProductComponentGeneration	getLatestProductComponentGeneration() Returns the latest product component generation of the provided product component or null if non available.
IProductComponentLink<? extends IProductComponent>	getLink(String linkName, IProductComponent target) Returns the IProductComponentLink for the association with the given role name to the given product component or null if no such association exists.
List<IProductComponentLink<? extends IProductComponent>>	getLinks() Returns a List of all the IProductComponentLinks from this product component generation to other product components.
IRuntimeRepository	getRepository() Returns the repository this product component belongs to.
DateTime	getValidTo() Returns the date when this product component expires.
String	getVersionId() Returns the version id that identifies this product component in its kind.
void	initFromXml(Element cmptElement) Initializes the generation with the data from the xml element.
void	setValidTo(DateTime validTo)
String	toString()
Element	toXml(Document document) Creates an XML Element that represents this product component's data.
Element	toXml(Document document, boolean includeGenerations) Creates an XML Element that represents this product component's data.
protected void	writePropertiesToXml(Element element) Subclasses override this method to write their properties into the given XML element.
protected void	writeReferencesToXml(Element element) This is a utility method called by generated code.

Methods inherited from class org.faktorips.runtime.internal.RuntimeObject

getExtensionPropertyIds, getExtensionPropertyValue, initExtensionPropertiesFromXml, writeExtensionPropertiesToXml, writeExtensionPropertiesToXml

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.faktorips.runtime.IProductComponent

createPolicyComponent

Methods inherited from interface org.faktorips.runtime.IRuntimeObject

getExtensionPropertyIds, getExtensionPropertyValue

Constructor Detail

ProductComponent

public ProductComponent(IRuntimeRepository repository,
                String id,
                String productKindId,
                String versionId)

Creates a new product component with the indicate id, kind id and version id.

Parameters:

repository - The component registry the component uses to resolve references to other components.

id - The component's runtime id.

productKindId - The component's kind id

versionId - The component's version id

Throws:

NullPointerException - if repository, id, productKindId, or versionId is null.

Method Detail

getKindId

public String getKindId()

Description copied from interface: IProductComponent

Returns the id of the product component kind that this product component belongs to.

Specified by:

getKindId in interface IProductComponent

getVersionId

public String getVersionId()

Description copied from interface: IProductComponent

Returns the version id that identifies this product component in its kind.

Specified by:

getVersionId in interface IProductComponent

getId

public final String getId()

Description copied from interface: IProductComponent

Returns the product component's id that uniquely identifies it in the repository it belongs to.

Specified by:

getId in interface IProductComponent

getValidTo

public DateTime getValidTo()

Description copied from interface: IProductComponent

Returns the date when this product component expires. Returning null means no end of the validity period.

Specified by:

getValidTo in interface IProductComponent

setValidTo

public void setValidTo(DateTime validTo)

getRepository

public IRuntimeRepository getRepository()

Description copied from interface: IProductComponent

Returns the repository this product component belongs to. This method never returns null.

Specified by:

getRepository in interface IProductComponent

Specified by:

getRepository in interface IProductComponentLinkSource

Returns:

The IRuntimeRepository that was used to create this IProductComponentLinkSource

getGenerationBase

public IProductComponentGeneration getGenerationBase(Calendar effectiveDate)

Description copied from interface: IProductComponent

Returns the generation that is effective on the given date or null if no generation is effective on that date.

Specified by:

getGenerationBase in interface IProductComponent

getLatestProductComponentGeneration

public IProductComponentGeneration getLatestProductComponentGeneration()

Description copied from interface: IProductComponent

Returns the latest product component generation of the provided product component or null if non available.

Specified by:

getLatestProductComponentGeneration in interface IProductComponent

initFromXml

public void initFromXml(Element cmptElement)

Initializes the generation with the data from the xml element.

Specified by:

initFromXml in interface IClRepositoryObject

Throws:

NullPointerException - if cmptElement is null.

doInitReferencesFromXml

protected void doInitReferencesFromXml(Map<String,List<Element>> linkElements)

Parameters:

linkElements - the XML elements used to initialize ProductComponentLink instances.

doInitPropertiesFromXml

protected void doInitPropertiesFromXml(Map<String,Element> map)

Initializes the properties with the data in the map.

Parameters:

map - the map of property elements

toString

public String toString()

Overrides:

toString in class Object

toXml

public Element toXml(Document document)

Creates an XML Element that represents this product component's data.

Throws an UnsupportedOperationException if the support for toXml ("Generate toXml Support") is not activated in the FIPS standard builder.

Specified by:

toXml in interface IXmlPersistenceSupport

Parameters:

document - a document, that can be used to create XML elements.

Returns:

an Element that represents this object as XML element

toXml

public Element toXml(Document document,
            boolean includeGenerations)

Creates an XML Element that represents this product component's data.

Throws an UnsupportedOperationException if the support for toXml ("Generate toXml Support") is not activated in the FIPS standard builder.

Parameters:

document - a document, that can be used to create XML elements.

includeGenerations - true if the created XML element should include the data of all the product component's generations, false if generations should be ignored when creating the XML output.

writePropertiesToXml

protected void writePropertiesToXml(Element element)

Subclasses override this method to write their properties into the given XML element.

The standard implementation throws an UnsupportedOperationException if the support for toXml ("Generate toXml Support") is not activated in the FIPS standard builder. Generated classes override but do NOT call super.

Parameters:

element - the XML element to write the properties to

getLink

public IProductComponentLink<? extends IProductComponent> getLink(String linkName,
                                                         IProductComponent target)

Description copied from interface: IProductComponent

Returns the IProductComponentLink for the association with the given role name to the given product component or null if no such association exists.

Specified by:

getLink in interface IProductComponent

getLinks

public List<IProductComponentLink<? extends IProductComponent>> getLinks()

Description copied from interface: IProductComponent

Returns a List of all the IProductComponentLinks from this product component generation to other product components.

Specified by:

getLinks in interface IProductComponent

writeReferencesToXml

protected void writeReferencesToXml(Element element)

This is a utility method called by generated code. The given Element is the element representing this ProductComponentGeneration.

Parameters:

element - the element all table usages should be added to

Since:

3.8