org.openl.rules.table.xls.builder

Class DataTableField

java.lang.Object

org.openl.rules.table.xls.builder.DataTableField

Direct Known Subclasses:

DataTablePredefinedTypeVariable, DataTableUserDefinedTypeField

public abstract class DataTableField
extends Object

A class, containing description of Data Table's field columns (or variables)

Author:

NSamatov

Constructor Summary

Constructors

Constructor and Description
DataTableField(String name, String businessName) Create a field with a given technical name and business name

Method Summary

Modifier and Type	Method and Description
List<DataTableField>	getAggregatedFields() Get a list of an aggregated fields that will be filled instead of referencing with a foreign key
protected abstract List<DataTableField>	getAvailableFields() Get available fields of a complex object
String	getBusinessName() Get a business name of a field
String	getForeignKey() Get a foreign key for a field
String	getForeignKeyColumn() Get a foreign key column name for a field
String	getForeignKeyTable() Get a foreign key table name for a field
String	getName() Get a technical name of a field
abstract String	getTypeName() Get the field's type name
abstract boolean	isComplex() Determine, if a field is a complex object
boolean	isFillChildren() Returns a method of filling data for a field
void	setAggregatedFields(List<DataTableField> aggregatedFields) Set a list of an aggregated fields that will be filled instead of referencing with a foreign key
void	setBusinessName(String businessName) Set business name of a field
void	setForeignKeyColumn(String foreignKeyColumn) Set a foreign key column name for a field
void	setForeignKeyTable(String foreignKeyTable) Set a foreign key table name for a field
void	useAggregatedFields() Use an aggregated fields instead of a foreign key
void	useForeignKey() Use a foreign key instead of an aggregated fields

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTableField

public DataTableField(String name,
                      String businessName)

Create a field with a given technical name and business name

Parameters:

name - technical name of a field

businessName - business name of a field

Method Detail

getName

public String getName()

Get a technical name of a field

Returns:

technical name of a field

getBusinessName

public String getBusinessName()

Get a business name of a field

Returns:

business name of a field

setBusinessName

public void setBusinessName(String businessName)

Set business name of a field

Parameters:

businessName - business name of a field

getForeignKeyTable

public String getForeignKeyTable()

Get a foreign key table name for a field

Returns:

foreign key table name for a field

setForeignKeyTable

public void setForeignKeyTable(String foreignKeyTable)

Set a foreign key table name for a field

Parameters:

foreignKeyTable - foreign key table name for a field

getForeignKeyColumn

public String getForeignKeyColumn()

Get a foreign key column name for a field

Returns:

foreign key column name for a field

setForeignKeyColumn

public void setForeignKeyColumn(String foreignKeyColumn)

Set a foreign key column name for a field

Parameters:

foreignKeyColumn - foreign key column name for a field

getForeignKey

public String getForeignKey()

Get a foreign key for a field

Returns:

foreign key for a field

getAggregatedFields

public List<DataTableField> getAggregatedFields()

Get a list of an aggregated fields that will be filled instead of referencing with a foreign key

Returns:

list of an aggregated fields

setAggregatedFields

public void setAggregatedFields(List<DataTableField> aggregatedFields)

Set a list of an aggregated fields that will be filled instead of referencing with a foreign key

Parameters:

aggregatedFields - list of an aggregated fields

isFillChildren

public boolean isFillChildren()

Returns a method of filling data for a field

Returns:

if true then data is filled using aggregated fields else data is filled using foreign keys

useAggregatedFields

public void useAggregatedFields()

Use an aggregated fields instead of a foreign key

See Also:

useForeignKey()

useForeignKey

public void useForeignKey()

Use a foreign key instead of an aggregated fields

See Also:

useAggregatedFields()

getTypeName

public abstract String getTypeName()

Get the field's type name

Returns:

type name

isComplex

public abstract boolean isComplex()

Determine, if a field is a complex object

Returns:

true, if a field is a complex

getAvailableFields

protected abstract List<DataTableField> getAvailableFields()

Get available fields of a complex object

Returns:

list of a child fields inside this complex object