oracle.apps.fnd.applcp.migrate.modeler
Class FlexfieldEntity

java.lang.Object
  oracle.apps.fnd.applcp.migrate.modeler.FlexfieldEntity

public class FlexfieldEntity
extends java.lang.Object

An entity that provides the data source for a flexfield.

Nested Class Summary

class

FlexfieldEntity.AttributeInfo Entity attribute information.

Constructor Summary

FlexfieldEntity(java.lang.String entityFullName)
Construct a reference to a flexfield entity.

FlexfieldEntity(java.lang.String entityFullName, boolean asDBTable)
Constructs a reference to a flexfield entity.

Method Summary

FlexfieldEntity.AttributeInfo	getAttributeInfo(SegmentDef seg) Gets the information of an entity attribute for the segment.
FlexfieldEntity.AttributeInfo	getAttributeInfoByColumn(java.lang.String colName) Gets the information of an entity attribute by the database column name.
FlexfieldEntity.AttributeInfo	getAttributeInfoByName(java.lang.String attrName) Gets the information of an entity attribute by its name.
java.lang.Class	getAttributeJavaType(SegmentDef seg) Gets the java type of the entity attribute that maps to the given segment.
java.lang.String	getAttributeName(SegmentDef seg) Gets the name of the entity attribute that maps to the given segment.
java.lang.String	getDBObjectName() Gets the underlying DB object name of the entity.
oracle.jbo.server.EntityDefImpl	getDef() Gets the definition of the entity.
java.lang.String	getDefinitionFullName() Gets the full name of the entity.
java.util.List<java.lang.String>	getKeyNames() Gets the list of entity primary key names and the discriminator attribute names.
java.lang.String	getShortName() Gets the short name of the entity.
boolean	isPrimaryKey(SegmentDef seg) Returns true if the entity attribute that maps to the given segment is a primary key.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlexfieldEntity

public FlexfieldEntity(java.lang.String entityFullName)

Construct a reference to a flexfield entity.

Parameters:

entityFullName - the full name of the entity definition

FlexfieldEntity

public FlexfieldEntity(java.lang.String entityFullName,
                       boolean asDBTable)

Constructs a reference to a flexfield entity.

Parameters:

entityFullName - the full name of the entity definition

asDBTable - true if this entity is treated as the database table registered with the flexfield definition. If set to true, the segment attributes must be named after their corresponding database columns in all uppercase.

Method Detail

getDef

public final oracle.jbo.server.EntityDefImpl getDef()

Gets the definition of the entity.

Returns:

the definition of the entity

getDefinitionFullName

public final java.lang.String getDefinitionFullName()

Gets the full name of the entity.

Returns:

the full name of the entity

getShortName

public final java.lang.String getShortName()

Gets the short name of the entity.

Returns:

the short name of the entity

getDBObjectName

public java.lang.String getDBObjectName()

Gets the underlying DB object name of the entity.

Returns:

the underlying DB object name of the entity

getAttributeName

public java.lang.String getAttributeName(SegmentDef seg)

Gets the name of the entity attribute that maps to the given segment. Subclasses may override getEntityAttributeInfo(SegmentDef) to select a different entity attribute.

Parameters:

seg - a segment

Returns:

the name of the entity attribute; null if no attribute is mapped to the given segment

Throws:

BCModelerException - if no entity attribute is found for the given segment

isPrimaryKey

public boolean isPrimaryKey(SegmentDef seg)

Returns true if the entity attribute that maps to the given segment is a primary key. Subclasses may override getEntityAttributeInfo(SegmentDef) to select a different entity attribute.

Parameters:

seg - the segment

Returns:

true if the entity attribute is a primary key

Throws:

BCModelerException - if no entity attribute is found for the given segment

See Also:

getAttributeInfo(SegmentDef)

getAttributeJavaType

public java.lang.Class getAttributeJavaType(SegmentDef seg)

Gets the java type of the entity attribute that maps to the given segment. Subclasses may override getEntityAttributeInfo(SegmentDef) to select a different entity attribute.

Parameters:

seg - the segment

Returns:

the java type of the entity attribute

Throws:

BCModelerException - if no entity attribute is found for the given segment

See Also:

getAttributeInfo(SegmentDef)

getAttributeInfoByName

public final FlexfieldEntity.AttributeInfo getAttributeInfoByName(java.lang.String attrName)

Gets the information of an entity attribute by its name.

Parameters:

attrName - the name of the attribute

Returns:

the information of the attribute

getAttributeInfoByColumn

public final FlexfieldEntity.AttributeInfo getAttributeInfoByColumn(java.lang.String colName)

Gets the information of an entity attribute by the database column name.

Parameters:

colName - the database column name

Returns:

the information of the attribute

getAttributeInfo

public FlexfieldEntity.AttributeInfo getAttributeInfo(SegmentDef seg)

Gets the information of an entity attribute for the segment.

Parameters:

seg - the segment definition

Returns:

the information of the attribute

getKeyNames

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

Gets the list of entity primary key names and the discriminator attribute names.

Returns:

the list of entity primary key names and discriminator attribute names