oracle.apps.fnd.applcp.migrate.modeler.common
Class KeyFlexfieldDefImpl

java.lang.Object
  oracle.apps.fnd.applcp.migrate.modeler.common.KeyFlexfieldDefImpl

All Implemented Interfaces:

FlexfieldDef, UIHints

public class KeyFlexfieldDefImpl
extends java.lang.Object

Definition of a key flexfield.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.fnd.applcp.migrate.modeler.common.FlexfieldDef

FlexfieldDef.MetadataType, FlexfieldDef.Parameter

Field Summary

protected static java.lang.String	_IS_CC_ID_SEGMENT The name of the property indicating that a segment represents a CCID column.
protected static java.lang.String	_IS_DATA_SET_NUMBER_SEGMENT The name of the property indicating that a segment represents a data set number column.
protected static java.lang.String	_IS_SIN_SEGMENT The name of the property indicating that a segment represents a structure instance number column.
protected static java.lang.String	_IS_STRUCTURE_CODE_SEGMENT The name of the property indicating that a segment represents a structure code column.

Constructor Summary

protected

KeyFlexfieldDefImpl(java.lang.Long appID, java.lang.String appShortName, java.lang.String code) Constructs a key flexfield definition implementation.

Method Summary

protected void	addSegmentDefList(java.lang.String discrValue, SegmentDefList list) Adds the segment definition list for a discriminator value.
java.lang.Long	getApplicationID() Gets the application ID with which this flexfield is associated.
java.lang.String	getApplicationModuleName() Gets the name of the application module associated with this flexfield.
java.lang.String	getApplicationName() Gets the full name of the application where this flexfield is defined.
java.lang.String	getApplicationShortName() Gets the short name of the application where this flexfield is defined.
java.lang.String	getControlType() This method always returns null.
java.lang.String	getDelimiter() Gets the default delimiter.
java.lang.String	getDescription() Gets the description.
ContextValueDef[]	getDiscriminatorSegmentValues() Gets the list of values of a discriminator segment.
int	getDisplayWidth() This method always returns -1.
FlexfieldEntityUsage	getEntityUsage(java.lang.String entityDefFullName) Gets a flexfield entity usage.
java.lang.String	getLabel() Gets the Label.
java.lang.String	getName() Gets the name of this flexfield.
java.util.Map<java.lang.String,FlexfieldDef.Parameter>	getParameterMap() Gets a map of the flexfield parameters.
SegmentDefList	getSegmentDefs(java.lang.String discrValue) Gets the list of segments for a discriminator value.
java.util.List<SegmentDef.ValueAttribute>	getSegmentValueAttributes(java.lang.String labelCode) Gets a list of segment value attributes for a label.
java.util.Map<java.lang.String,java.lang.String>	getStructureInstanceToDefCodeMap() Gets the map from structure instance codes to structure codes.
java.lang.String	getTableName() Gets the name of the database object where the flexfield is used.
java.lang.String	getTitle() Gets the title.
java.lang.String	getType() Gets the type of this flexfield.
UIHints	getUIHints() Returns this object.
java.lang.String	getUsageName() Gets the name of the flexfield usage.
java.lang.String	getUsageType() Gets the type of the usage.
static boolean	isCCIDSegment(SegmentDef segment) Returns true if the given segment is a CCID segment.
static boolean	isDataSetNumberSegment(SegmentDef segment) Returns true if the given segment is a data set number segment.
boolean	isDynamicCombinationCreationAllowed() Returns true if dynamic combination creation is allowed.
boolean	isHidden() This method always returns false.
boolean	isMonomorphic() Returns true if this flexfield does not have a discriminator.
boolean	isReadOnly() This method always returns false.
boolean	isReferenced() This method always returns false.
static boolean	isStructureCodeSegment(SegmentDef segment) Returns true if the given segment is a structure code segment
static boolean	isStructureInstanceNumberSegment(SegmentDef segment) Returns true if the given segment is a structure instance number segment.
protected static void	markAsCCIDSegment(SegmentDefImpl segment) Marks the given segment as a CCID segment.
protected static void	markAsDataSetNumberSegment(SegmentDefImpl segment) Marks the given segment as a data set number segment.
protected static void	markAsStructureCodeSegment(SegmentDefImpl segment) Marks the given segment as a structure code segment.
protected static void	markAsStructureInstanceNumberSegment(SegmentDefImpl segment) Marks the given segment as a structure instance number segment.
protected void	putSegmentValueAttributeList(java.lang.String labelCode, java.util.List<SegmentDef.ValueAttribute> list) Puts the value attribute list for a label.
protected void	removeSegmentDefList(java.lang.String discrValue) Removes the segment definition list associated with a discriminator value.
protected void	setApplicationID(java.lang.Long id) Sets the application ID that corresponds to the application short name.
protected void	setApplicationModuleName(java.lang.String name) Sets the name of the application module associated with this flexfield.
protected void	setApplicationName(java.lang.String name) Sets the application name.
protected void	setDelimiter(java.lang.String d) Sets the delimiter of the flexfield.
protected void	setDescription(java.lang.String description) Sets the description of the flexifled.
protected void	setDiscriminatorSegmentValues(ContextValueDef[] values) Sets the discriminator segment values.
protected void	setDynamicCombinationCreationAllowed(boolean b) Sets whether dynamic combination creation is allowed.
protected void	setEntityUsage(java.lang.String entityDefFullName, FlexfieldEntityUsage feu) Sets a flexfield entity usage.
protected void	setLabel(java.lang.String label) Sets the label for the flexfield.
protected void	setMonomorphic(boolean b) Sets whether this flexfield is monomorphic.
protected void	setParameter(java.lang.String code, java.lang.Class javaType) Sets a parameter.
protected void	setStructureInstanceToDefCodeMap(java.util.Map<java.lang.String,java.lang.String> m) Sets the map from structure instance codes to structure codes.
void	setTableName(java.lang.String tableName) Sets the database object name.
protected void	setTitle(java.lang.String title) Sets the title of the flexfield.
protected void	setUsageName(java.lang.String usageName) Sets the usage name.
protected void	setUsageType(java.lang.String type) Sets the type of the usage.

Methods inherited from class java.lang.Object

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

Field Detail

_IS_CC_ID_SEGMENT

protected static final java.lang.String _IS_CC_ID_SEGMENT

The name of the property indicating that a segment represents a CCID column. The value of this property should be Boolean.TRUE, Boolean.FALSE or null.

See Also:

Constant Field Values

_IS_SIN_SEGMENT

protected static final java.lang.String _IS_SIN_SEGMENT

The name of the property indicating that a segment represents a structure instance number column. The value of this property should be Boolean.TRUE, Boolean.FALSE or null.

See Also:

Constant Field Values

_IS_STRUCTURE_CODE_SEGMENT

protected static final java.lang.String _IS_STRUCTURE_CODE_SEGMENT

The name of the property indicating that a segment represents a structure code column. The value of this property should be Boolean.TRUE, Boolean.FALSE or null.

See Also:

Constant Field Values

_IS_DATA_SET_NUMBER_SEGMENT

protected static final java.lang.String _IS_DATA_SET_NUMBER_SEGMENT

The name of the property indicating that a segment represents a data set number column. The value of this property should be Boolean.TRUE, Boolean.FALSe or null.

See Also:

Constant Field Values

Constructor Detail

KeyFlexfieldDefImpl

protected KeyFlexfieldDefImpl(java.lang.Long appID,
                              java.lang.String appShortName,
                              java.lang.String code)

Constructs a key flexfield definition implementation.

Parameters:

appID - the application ID

appShortName - the application short name

code - the key flexfield code

Method Detail

getType

public java.lang.String getType()

Gets the type of this flexfield.

Specified by:

getType in interface FlexfieldDef

Returns:

the type of this flexfield

isDynamicCombinationCreationAllowed

public boolean isDynamicCombinationCreationAllowed()

Returns true if dynamic combination creation is allowed.

Returns:

true if dynamic combination creation is allowed

setDynamicCombinationCreationAllowed

protected void setDynamicCombinationCreationAllowed(boolean b)

Sets whether dynamic combination creation is allowed.

Parameters:

b - true if dynamic combination creation is allowed

getStructureInstanceToDefCodeMap

public java.util.Map<java.lang.String,java.lang.String> getStructureInstanceToDefCodeMap()

Gets the map from structure instance codes to structure codes. Only the structure instances used in this flexfield will be in this map.

Returns:

the map from structure instance codes to structure codes; null if this information is not available

setStructureInstanceToDefCodeMap

protected void setStructureInstanceToDefCodeMap(java.util.Map<java.lang.String,java.lang.String> m)

Sets the map from structure instance codes to structure codes.

Parameters:

m - the map from structure instance codes to structure codes

isCCIDSegment

public static boolean isCCIDSegment(SegmentDef segment)

Returns true if the given segment is a CCID segment.

Parameters:

segment - the segment to be checked

Returns:

true if the given segment is a CCID segment

isStructureInstanceNumberSegment

public static boolean isStructureInstanceNumberSegment(SegmentDef segment)

Returns true if the given segment is a structure instance number segment.

Parameters:

segment - the segment to be checked

Returns:

true if the given segment is a structure instance number segment

isStructureCodeSegment

public static boolean isStructureCodeSegment(SegmentDef segment)

Returns true if the given segment is a structure code segment

Parameters:

segment - the segment to be checked

Returns:

true if the given segment is a structure code segment

isDataSetNumberSegment

public static boolean isDataSetNumberSegment(SegmentDef segment)

Returns true if the given segment is a data set number segment.

Parameters:

segment - the segment to be checked

Returns:

true if the given segment is a data set number segment

markAsCCIDSegment

protected static void markAsCCIDSegment(SegmentDefImpl segment)

Marks the given segment as a CCID segment.

Parameters:

segment - the segment to be marked

See Also:

isCCIDSegment(oracle.apps.fnd.applcp.migrate.modeler.common.SegmentDef)

markAsStructureInstanceNumberSegment

protected static void markAsStructureInstanceNumberSegment(SegmentDefImpl segment)

Marks the given segment as a structure instance number segment.

Parameters:

segment - the segment to be marked

markAsStructureCodeSegment

protected static void markAsStructureCodeSegment(SegmentDefImpl segment)

Marks the given segment as a structure code segment.

Parameters:

segment - the segment to be marked

See Also:

isStructureCodeSegment(oracle.apps.fnd.applcp.migrate.modeler.common.SegmentDef)

markAsDataSetNumberSegment

protected static void markAsDataSetNumberSegment(SegmentDefImpl segment)

Marks the given segment as a data set number segment.

Parameters:

segment - the segment to be marked

getApplicationShortName

public java.lang.String getApplicationShortName()

Gets the short name of the application where this flexfield is defined.

Specified by:

getApplicationShortName in interface FlexfieldDef

Returns:

the application short name

setApplicationID

protected void setApplicationID(java.lang.Long id)

Sets the application ID that corresponds to the application short name.

Parameters:

id - the application ID

getApplicationID

public java.lang.Long getApplicationID()

Gets the application ID with which this flexfield is associated.

Specified by:

getApplicationID in interface FlexfieldDef

Returns:

the application ID; null if the application ID has not resolved from the application short name

getName

public java.lang.String getName()

Gets the name of this flexfield.

Specified by:

getName in interface FlexfieldDef

Returns:

the name of this flexfield

getUIHints

public UIHints getUIHints()

Returns this object.

Specified by:

getUIHints in interface FlexfieldDef

Returns:

this object

setApplicationModuleName

protected void setApplicationModuleName(java.lang.String name)

Sets the name of the application module associated with this flexfield.

Parameters:

name - the name of the application module

getApplicationModuleName

public java.lang.String getApplicationModuleName()

Gets the name of the application module associated with this flexfield.

Specified by:

getApplicationModuleName in interface FlexfieldDef

Returns:

the name of the application module associated with this flexfield; null if no application module is assocaited

getApplicationName

public java.lang.String getApplicationName()

Gets the full name of the application where this flexfield is defined.

Specified by:

getApplicationName in interface FlexfieldDef

Returns:

the full name of the application

getDisplayWidth

public int getDisplayWidth()

This method always returns -1.

Specified by:

getDisplayWidth in interface UIHints

Returns:

-1

setApplicationName

protected void setApplicationName(java.lang.String name)

Sets the application name.

Parameters:

name - the applicatio name

getUsageName

public java.lang.String getUsageName()

Gets the name of the flexfield usage.

Specified by:

getUsageName in interface FlexfieldDef

Returns:

the name of the flexfield usage

setUsageName

protected void setUsageName(java.lang.String usageName)

Sets the usage name.

Parameters:

usageName - the usage name

getUsageType

public java.lang.String getUsageType()

Gets the type of the usage.

Specified by:

getUsageType in interface FlexfieldDef

Returns:

the type of the usage

setUsageType

protected void setUsageType(java.lang.String type)

Sets the type of the usage.

Parameters:

type - the usage type

getTableName

public java.lang.String getTableName()

Gets the name of the database object where the flexfield is used.

Specified by:

getTableName in interface FlexfieldDef

Returns:

the name of the database object

setTableName

public void setTableName(java.lang.String tableName)

Sets the database object name.

Parameters:

tableName - the database object name

getDiscriminatorSegmentValues

public ContextValueDef[] getDiscriminatorSegmentValues()

Gets the list of values of a discriminator segment. If this method returns null, no values have been defined for the discriminator segment.

Specified by:

getDiscriminatorSegmentValues in interface FlexfieldDef

Returns:

the list of values of a discriminator segment

setDiscriminatorSegmentValues

protected void setDiscriminatorSegmentValues(ContextValueDef[] values)

Sets the discriminator segment values.

Parameters:

values - the discriminator segment values

getSegmentDefs

public SegmentDefList getSegmentDefs(java.lang.String discrValue)

Gets the list of segments for a discriminator value. If the discriminator value is null, the global segments are returned. Please note that this method returns the complete list of segments including the global segments. To check if a segment is global or discriminator-value specific, check the segment.

Specified by:

getSegmentDefs in interface FlexfieldDef

Parameters:

discrValue - the discriminator value; null to get global segments

Returns:

the list of segments for the given discriminator value; null if a segment list has not been defined for the given discriminator value

addSegmentDefList

protected void addSegmentDefList(java.lang.String discrValue,
                                 SegmentDefList list)

Adds the segment definition list for a discriminator value.

Parameters:

discrValue - the discriminator value

list - the segment definition list

removeSegmentDefList

protected void removeSegmentDefList(java.lang.String discrValue)

Removes the segment definition list associated with a discriminator value.

Parameters:

discrValue - the discriminator value

getTitle

public java.lang.String getTitle()

Gets the title.

Specified by:

getTitle in interface UIHints

Returns:

the title

setTitle

protected void setTitle(java.lang.String title)

Sets the title of the flexfield.

Parameters:

title - the title of the flexfield

getDescription

public java.lang.String getDescription()

Gets the description.

Specified by:

getDescription in interface UIHints

Returns:

the description

setDescription

protected void setDescription(java.lang.String description)

Sets the description of the flexifled.

Parameters:

description - the description of the flexfield

getLabel

public java.lang.String getLabel()

Gets the Label.

Specified by:

getLabel in interface UIHints

Returns:

the Label

setLabel

protected void setLabel(java.lang.String label)

Sets the label for the flexfield.

Parameters:

label - the label for the flexfield

getDelimiter

public java.lang.String getDelimiter()

Gets the default delimiter.

Specified by:

getDelimiter in interface FlexfieldDef

Returns:

the default delimiter

setDelimiter

protected void setDelimiter(java.lang.String d)

Sets the delimiter of the flexfield.

Parameters:

d - the delimiter

getControlType

public java.lang.String getControlType()

This method always returns null.

Specified by:

getControlType in interface UIHints

Returns:

null

isHidden

public boolean isHidden()

This method always returns false.

Specified by:

isHidden in interface UIHints

Returns:

false

isReferenced

public boolean isReferenced()

This method always returns false.

Specified by:

isReferenced in interface UIHints

Returns:

false

isReadOnly

public boolean isReadOnly()

This method always returns false.

Specified by:

isReadOnly in interface UIHints

Returns:

false

getEntityUsage

public FlexfieldEntityUsage getEntityUsage(java.lang.String entityDefFullName)

Gets a flexfield entity usage.

Specified by:

getEntityUsage in interface FlexfieldDef

Parameters:

entityDefFullName - the key to the model

Returns:

the full name of the entity

setEntityUsage

protected void setEntityUsage(java.lang.String entityDefFullName,
                              FlexfieldEntityUsage feu)

Sets a flexfield entity usage.

Parameters:

entityDefFullName - the full name of the entity

feu - the entity usage

setMonomorphic

protected void setMonomorphic(boolean b)

Sets whether this flexfield is monomorphic. A monomorphic flexfield does not have a discriminator.

Parameters:

b - true if this flexfield is monomorphic

isMonomorphic

public boolean isMonomorphic()

Returns true if this flexfield does not have a discriminator. getDiscriminatorSegmentValues() should return null or an empty list in this case. To retrieve the segments, getSegmentDefs(null) can be called.

Specified by:

isMonomorphic in interface FlexfieldDef

Returns:

true if this flexfield does not have a discriminator

setParameter

protected void setParameter(java.lang.String code,
                            java.lang.Class javaType)

Sets a parameter.

Parameters:

code - the parameter code

javaType - the Java type

getParameterMap

public java.util.Map<java.lang.String,FlexfieldDef.Parameter> getParameterMap()

Gets a map of the flexfield parameters. The keys of the map are the parameter codes.

Specified by:

getParameterMap in interface FlexfieldDef

Returns:

the map of flexfield parameters; an empty map if this flexfield has no parameters

getSegmentValueAttributes

public java.util.List<SegmentDef.ValueAttribute> getSegmentValueAttributes(java.lang.String labelCode)

Gets a list of segment value attributes for a label.

Specified by:

getSegmentValueAttributes in interface FlexfieldDef

Parameters:

labelCode - the label code

Returns:

the list of value attributes for the label; an empty list if this label is not defined or not used, or if no value attributes are associated with the label.

putSegmentValueAttributeList

protected void putSegmentValueAttributeList(java.lang.String labelCode,
                                            java.util.List<SegmentDef.ValueAttribute> list)

Puts the value attribute list for a label.

Parameters:

labelCode - the label code

list - the list of value attributes; null if the label has no value attributes

Throws:

java.lang.IllegalArgumentException - if the given label code is null