Package org.faktorips.runtime.model.type

Class TableUsage

java.lang.Object

org.faktorips.runtime.model.type.ModelElement

org.faktorips.runtime.model.type.TypePart

org.faktorips.runtime.model.type.TableUsage

public class TableUsage
extends TypePart

Describes the model information for a table usage.

Constructor Summary

Constructors

Constructor	Description
TableUsage(Type parent, Method getter)

Method Summary

Modifier and Type	Method	Description
ITable<?>	getTable(IProductComponent productComponent, Calendar effectiveDate)	Returns the table the given product component references for this table usage.
String	getTableName(IProductComponent productComponent, Calendar effectiveDate)	Returns the name of the table for the given product component that references a table usage.
TableStructure	getTableStructure()
void	setTableName(String tableName, IProductComponent productComponent, Calendar effectiveDate)	Sets the name of the table for the given product component that references a table usage.
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, getDeprecation, getDescription, getDocumentation, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getName, getRelevantProductObject, invokeField, invokeMethod, isDeprecated

Methods inherited from class java.lang.Object

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

Constructor Details

TableUsage

public TableUsage(Type parent,
 Method getter)

Method Details

getTable

public ITable<?> getTable(IProductComponent productComponent,
 Calendar effectiveDate)

Returns the table the given product component references for this table usage. If this table usage is changing over time (resides in the generation) the date is used to retrieve the correct generation. If the date is null the latest generation is used. If the table usage is not changing over time the date will be ignored.

Parameters:

productComponent - The product component that holds the table instance

effectiveDate - the date to determine the product component generation. If null the latest generation is used. Is ignored if the table usage configuration is not changing over time.

Returns:

The table instance hold by the product component and is identified by this table usage

getTableName

public String getTableName(IProductComponent productComponent,
 Calendar effectiveDate)

Returns the name of the table for the given product component that references a table usage. If this table usage is changing over time (resides in the generation) the date is used to retrieve the correct generation. If the date is null the latest generation is used. If the table usage is not changing over time the date will be ignored.

Parameters:

productComponent - The product component that holds the table instance

effectiveDate - the date to determine the product component generation. If null the latest generation is used. Is ignored if the table usage configuration is not changing over time.

Returns:

The name of the table for this table usage in the product component

Since:

24.7

setTableName

public void setTableName(String tableName,
 IProductComponent productComponent,
 Calendar effectiveDate)

Sets the name of the table for the given product component that references a table usage. If this table usage is changing over time (resides in the generation) the date is used to retrieve the correct generation. If the date is null the latest generation is used. If the table usage is not changing over time the date will be ignored.

Parameters:

tableName - The name of the table for this table usage in the product component

productComponent - The product component that holds the table instance

effectiveDate - the date to determine the product component generation. If null the latest generation is used. Is ignored if the table usage configuration is not changing over time.

Since:

24.7

getTableStructure

public TableStructure getTableStructure()

Returns:

the model for the table structure referenced in this table usage.

Throws:

UnsupportedOperationException - if this table usage uses multiple table structures.

toString

public String toString()

Overrides:

toString in class ModelElement