Package org.openl.rules.data

Class ForeignKeyColumnDescriptor

java.lang.Object

org.openl.rules.data.ColumnDescriptor

org.openl.rules.data.ForeignKeyColumnDescriptor

public class ForeignKeyColumnDescriptor
extends ColumnDescriptor

Handles column descriptors that are represented as foreign keys to data from other tables.

Author:

DLiauchuk

Nested Class Summary

Nested classes/interfaces inherited from class org.openl.rules.data.ColumnDescriptor

ColumnDescriptor.ColumnGroupKey

Constructor Summary

Constructors

Constructor	Description
ForeignKeyColumnDescriptor(IOpenField field, IdentifierNode foreignKeyTable, IdentifierNode foreignKey, IdentifierNode[] foreignKeyTableAccessorChainTokens, ICell foreignKeyCell, StringValue displayValue, OpenL openl, boolean constructor, IdentifierNode[] fieldChainTokens, int columnNum)

Method Summary

Modifier and Type	Method	Description
DomainOpenClass	getDomainClassForForeignTable(IDataBase db)
IdentifierNode	getForeignKey()
CellKey	getForeignKeyCellCoordinate()
IOpenField	getForeignKeyField(IOpenClass type, IDataBase db)
IdentifierNode	getForeignKeyTable()
Object	getLiteralByForeignKey(IOpenClass fieldType, ILogicalTable valuesTable, IDataBase db, IBindingContext bindingContext)	Method is using to load data from foreign table, using foreign key (see DataTableBindHelper.getForeignKeyTokens(IBindingContext, ILogicalTable, int)).
boolean	isReference()	Returns TRUE if instance has foreign key table.
void	populateLiteralByForeignKey(Object target, ILogicalTable valuesTable, IDataBase db, IBindingContext cxt, IRuntimeEnv env)	Method is using to load data from foreign table, using foreign key (see DataTableBindHelper.getForeignKeyTokens(IBindingContext, ILogicalTable, int)).

Methods inherited from class org.openl.rules.data.ColumnDescriptor

buildGroupKey, getColumnIdx, getColumnValue, getDisplayName, getField, getFieldChainTokens, getFieldValue, getGroupKey, getLiteral, getName, getRuntimeEnv, getType, getUniqueIndex, isConstructor, isPrimaryKey, isSupportMultirows, isValuesAnArray, isValuesAnArray, populateLiteral, setFieldValue, setGroupKey, setSupportMultirows

Methods inherited from class java.lang.Object

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

Constructor Detail

ForeignKeyColumnDescriptor

public ForeignKeyColumnDescriptor(IOpenField field,
                                  IdentifierNode foreignKeyTable,
                                  IdentifierNode foreignKey,
                                  IdentifierNode[] foreignKeyTableAccessorChainTokens,
                                  ICell foreignKeyCell,
                                  StringValue displayValue,
                                  OpenL openl,
                                  boolean constructor,
                                  IdentifierNode[] fieldChainTokens,
                                  int columnNum)

Method Detail

getLiteralByForeignKey

public Object getLiteralByForeignKey(IOpenClass fieldType,
                                     ILogicalTable valuesTable,
                                     IDataBase db,
                                     IBindingContext bindingContext)
                              throws Exception

Method is using to load data from foreign table, using foreign key (see DataTableBindHelper.getForeignKeyTokens(IBindingContext, ILogicalTable, int)). Is used when data table is represents AS a constructor (see ColumnDescriptor.isConstructor()).

Throws:

Exception

isReference

public boolean isReference()

Returns TRUE if instance has foreign key table.

Overrides:

isReference in class ColumnDescriptor

populateLiteralByForeignKey

public void populateLiteralByForeignKey(Object target,
                                        ILogicalTable valuesTable,
                                        IDataBase db,
                                        IBindingContext cxt,
                                        IRuntimeEnv env)
                                 throws Exception

Method is using to load data from foreign table, using foreign key (see DataTableBindHelper.getForeignKeyTokens(IBindingContext, ILogicalTable, int)). Is used when data table is represents as NOT a constructor (see ColumnDescriptor.isConstructor()).

Throws:

Exception

getDomainClassForForeignTable

public DomainOpenClass getDomainClassForForeignTable(IDataBase db)
                                              throws SyntaxNodeException

Throws:

SyntaxNodeException

getForeignKeyTable

public IdentifierNode getForeignKeyTable()

getForeignKey

public IdentifierNode getForeignKey()

getForeignKeyCellCoordinate

public CellKey getForeignKeyCellCoordinate()

getForeignKeyField

public IOpenField getForeignKeyField(IOpenClass type,
                                     IDataBase db)