Package org.faktorips.runtime.model.table

Class TableStructure

java.lang.Object

org.faktorips.runtime.model.type.ModelElement

org.faktorips.runtime.model.table.TableStructure

public class TableStructure
extends ModelElement

Description of a runtime table's name, kind and columns.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	KIND_NAME

Constructor Summary

Constructors

Constructor	Description
TableStructure(java.lang.Class<? extends ITable<?>> tableObjectClass)

Method Summary

Modifier and Type	Method	Description
TableColumn	getColumn(java.lang.String columnName)
java.util.List<java.lang.String>	getColumnNames()
java.util.List<TableColumn>	getColumns()
TableStructureKind	getKind()
protected MessagesHelper	getMessageHelper()
protected java.lang.String	getMessageKey(DocumentationKind messageType)
java.lang.Object	getValue(java.lang.Object tableRow, java.lang.String columnName)
java.lang.Object	getValue(java.lang.Object tableRow, TableColumn column)	This method retrieves the value of a table cell in a given row and column.
java.util.List<java.lang.Object>	getValues(java.lang.Object tableRow)
java.lang.String	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

Field Detail

KIND_NAME

public static final java.lang.String KIND_NAME

See Also:

Constant Field Values

Constructor Detail

TableStructure

public TableStructure(java.lang.Class<? extends ITable<?>> tableObjectClass)

Method Detail

getKind

public TableStructureKind getKind()

Returns:

TableStructureKind indicating if the table is single content or multiple content

getColumns

public java.util.List<TableColumn> getColumns()

Returns:

columns of the table as TableColumn

getColumn

public TableColumn getColumn(java.lang.String columnName)

Parameters:

columnName - name of the column in table

Returns:

TableColumn of the column with the given name

getColumnNames

public java.util.List<java.lang.String> getColumnNames()

Returns:

names of all columns

getValue

public java.lang.Object getValue(java.lang.Object tableRow,
                                 TableColumn column)

This method retrieves the value of a table cell in a given row and column.

Parameters:

tableRow - an instance of the table row class matching the kind of the tableObjectClass

column - model of the table column

Returns:

the value of the table cell at in given tableRow and column

See Also:

TableColumn.getValue(Object)

getValue

public java.lang.Object getValue(java.lang.Object tableRow,
                                 java.lang.String columnName)

See Also:

getValue(Object, TableColumn)

getValues

public java.util.List<java.lang.Object> getValues(java.lang.Object tableRow)

Returns:

a list of all values in tableRow

See Also:

getValue(Object, TableColumn)

getMessageHelper

protected MessagesHelper getMessageHelper()

Specified by:

getMessageHelper in class ModelElement

getMessageKey

protected java.lang.String getMessageKey(DocumentationKind messageType)

Specified by:

getMessageKey in class ModelElement

toString

public java.lang.String toString()

Overrides:

toString in class ModelElement