oracle.apps.fnd.applcore.flex.runtime.util.common
Class KeyFlexfieldDefImpl

java.lang.Object
  oracle.apps.fnd.applcore.flex.runtime.util.common.KeyFlexfieldDefImpl

All Implemented Interfaces:

FlexfieldDef

public class KeyFlexfieldDefImpl
extends java.lang.Object

Definition of a key flexfield.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.fnd.applcore.flex.runtime.util.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.Object 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	getBaseLanguage() Gets the base language.
java.lang.String	getBITreeDataViewDefName() Gets the full name of the BI tree data view definition.
java.lang.String	getDelimiter() Gets the default delimiter.
ContextValueDef[]	getDiscriminatorSegmentValues() Gets the list of values of a discriminator segment.
java.lang.String	getDisplayName() Gets the display name of the flexfield.
Translatable	getDisplayNameTranslatable() Gets the translation information for display name.
FlexfieldEntityUsage	getEntityUsage(java.lang.String entityDefFullName) Gets a flexfield entity usage.
java.util.List<java.lang.String>	getInstalledLanguages() Gets the list of installed languages.
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.Object discrValue) Gets the list of segments for a discriminator value.
SegmentLabel	getSegmentLabel(java.lang.String labelCode) Gets a segment label associated with this flexfield.
java.util.Map<java.lang.String,SegmentLabel>	getSegmentLabelMap() Gets a map that contains all labels defined for this flexfield.
java.util.Map<java.lang.String,java.lang.String>	getStructureInstanceCodeToDefCodeMap() Gets the map from structure instance codes to structure codes.
java.util.Map<java.lang.Long,java.lang.String>	getStructureInstanceNumberToCodeMap() Gets the map from structure instance numbers to structure instance codes.
java.lang.String	getTableName() Gets the name of the database object where the flexfield is used.
java.util.Map<java.lang.String,java.lang.String>	getTranslatedDisplayNames() Gets the translations of the display names.
java.lang.String	getTreeStructureCode() Gets the code of the tree structure associated with this flexfield.
java.lang.String	getType() Gets the type of this flexfield.
java.lang.String	getUsageName() Gets the name of the flexfield usage.
java.lang.String	getUsageType() Gets the type of the usage.
java.util.List<InterSegmentValidator>	getValidators(java.lang.Object discrValue) Gets the list of validators associated with each subtype.
boolean	isBIEnabled() Returns true if this flexfield is BI-enabled.
static boolean	isCCIDSegment(SegmentDef segment) Returns true if the given segment is a CCID segment.
boolean	isCrossValidationRequired() Returns true if cross validation is required.
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	isMonomorphic() Returns true if this flexfield does not have a discriminator.
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	removeSegmentDefList(java.lang.Object 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	setBaseLanguage(java.lang.String lang) Sets the base language for this flexfield.
protected void	setBIEnabled(boolean b) Sets whether this flexfield is BI-enabled.
protected void	setBITreeDataViewDefName(java.lang.String name) Sets the full name of the BI tree data view definition.
protected void	setCrossValidationRequired(boolean b) Sets whether cross validation is required.
protected void	setDelimiter(java.lang.String d) Sets the delimiter of the flexfield.
protected void	setDiscriminatorSegmentValues(ContextValueDef[] values) Sets the discriminator segment values.
protected void	setDisplayName(java.lang.String s) Sets the display name.
protected void	setDisplayNameTranslatable(Translatable t) Sets the translation information for display name.
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	setInstalledLanguages(java.util.List<java.lang.String> langs) Sets the list of installed languages.
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	setSegmentLabelMap(java.util.Map<java.lang.String,SegmentLabel> map) Sets the label map.
protected void	setStructureInstanceCodeToDefCodeMap(java.util.Map<java.lang.String,java.lang.String> m) Sets the map from structure instance codes to structure codes.
protected void	setStructureInstanceNumberToCodeMap(java.util.Map<java.lang.Long,java.lang.String> m) Sets the map from structure instance numbers to structure instance codes.
void	setTableName(java.lang.String tableName) Sets the database object name.
protected void	setTreeStructureCode(java.lang.String code) Sets the tree structure code.
protected void	setUsageName(java.lang.String usageName) Sets the usage name.
protected void	setUsageType(java.lang.String type) Sets the type of the usage.
protected void	setValidators(java.lang.Object discrValue, java.util.List<InterSegmentValidator> list) Sets the list of validators for a given subtype.

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

isCrossValidationRequired

public boolean isCrossValidationRequired()

Returns true if cross validation is required.

Returns:

true if cross validation is required

setCrossValidationRequired

protected void setCrossValidationRequired(boolean b)

Sets whether cross validation is required.

Parameters:

b - true if cross validation is required

getStructureInstanceCodeToDefCodeMap

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

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

setStructureInstanceCodeToDefCodeMap

protected void setStructureInstanceCodeToDefCodeMap(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

getStructureInstanceNumberToCodeMap

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

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

Returns:

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

setStructureInstanceNumberToCodeMap

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

Sets the map from structure instance numbers to structure instance codes.

Parameters:

m - the map from structure instance numbers to structure instance 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.applcore.flex.runtime.util.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.applcore.flex.runtime.util.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. This is the "flexfield code" as defined in the metadata.

Specified by:

getName in interface FlexfieldDef

Returns:

the name of this flexfield

getDisplayName

public java.lang.String getDisplayName()

Gets the display name of the flexfield. This is the "flexfield name" as defined in the metadata.

Specified by:

getDisplayName in interface FlexfieldDef

Returns:

the display name of this flexfield

setDisplayName

protected void setDisplayName(java.lang.String s)

Sets the display name.

Parameters:

s - the display name

getTranslatedDisplayNames

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

Description copied from interface: FlexfieldDef

Gets the translations of the display names.

Specified by:

getTranslatedDisplayNames in interface FlexfieldDef

Returns:

the translations. The keys of the map are the language codes.

See Also:

FlexfieldDef.getDisplayName()

getDisplayNameTranslatable

public Translatable getDisplayNameTranslatable()

Description copied from interface: FlexfieldDef

Gets the translation information for display name.

Specified by:

getDisplayNameTranslatable in interface FlexfieldDef

Returns:

the translation information for display name; null if not available.

setDisplayNameTranslatable

protected void setDisplayNameTranslatable(Translatable t)

Sets the translation information for display name.

Parameters:

t - the translation information for display name

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

setApplicationName

protected void setApplicationName(java.lang.String name)

Sets the application name.

Parameters:

name - the applicatio name

getBaseLanguage

public java.lang.String getBaseLanguage()

Description copied from interface: FlexfieldDef

Gets the base language.

Specified by:

getBaseLanguage in interface FlexfieldDef

Returns:

the base language code; null if not defined

setBaseLanguage

protected void setBaseLanguage(java.lang.String lang)

Sets the base language for this flexfield.

Parameters:

lang - the base language

getInstalledLanguages

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

Description copied from interface: FlexfieldDef

Gets the list of installed languages.

Specified by:

getInstalledLanguages in interface FlexfieldDef

Returns:

the list of installed languages

setInstalledLanguages

protected void setInstalledLanguages(java.util.List<java.lang.String> langs)

Sets the list of installed languages.

Parameters:

langs - the list of installed languages

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.Object 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.Object 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.Object discrValue)

Removes the segment definition list associated with a discriminator value.

Parameters:

discrValue - the discriminator value

getValidators

public java.util.List<InterSegmentValidator> getValidators(java.lang.Object discrValue)

Description copied from interface: FlexfieldDef

Gets the list of validators associated with each subtype. If the given discriminator value is null, the validators that involve only the global segments are returned; otherwise all validators are returned. When all validators for a given discriminator are returned, the validator itself can indicate whether it involves only global segments, or it inolves at least one subtype-specific segment.

Specified by:

getValidators in interface FlexfieldDef

Parameters:

discrValue - the discriminator value; null to get validators that involve only global segments

Returns:

the list of validators associated with the subtype indicated by the given discriminator value, including all validators that involve only global segments

setValidators

protected void setValidators(java.lang.Object discrValue,
                             java.util.List<InterSegmentValidator> list)

Sets the list of validators for a given subtype.

Parameters:

discrValue - the discriminator value that indicates the subtype

list - the list of validators

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

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

getSegmentLabel

public SegmentLabel getSegmentLabel(java.lang.String labelCode)

Gets a segment label associated with this flexfield.

Specified by:

getSegmentLabel in interface FlexfieldDef

Parameters:

labelCode - the label code

Returns:

the segment label associated with this flexfield; null if the given label code is not defined

getSegmentLabelMap

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

Gets a map that contains all labels defined for this flexfield. The map key is the label code.

Specified by:

getSegmentLabelMap in interface FlexfieldDef

Returns:

a map that contains all labels defined for this flexfield; an empty map if no labels are defined

setSegmentLabelMap

protected void setSegmentLabelMap(java.util.Map<java.lang.String,SegmentLabel> map)

Sets the label map.

Parameters:

map - the label map

setBIEnabled

protected void setBIEnabled(boolean b)

Sets whether this flexfield is BI-enabled.

Parameters:

b - true if this flexfield is BI-enabled

isBIEnabled

public boolean isBIEnabled()

Returns true if this flexfield is BI-enabled.

Specified by:

isBIEnabled in interface FlexfieldDef

Returns:

true if this flexfield is BI-enabled

setTreeStructureCode

protected void setTreeStructureCode(java.lang.String code)

Sets the tree structure code.

Parameters:

code - the tree structure code

getTreeStructureCode

public java.lang.String getTreeStructureCode()

Gets the code of the tree structure associated with this flexfield.

Specified by:

getTreeStructureCode in interface FlexfieldDef

Returns:

the code of the tree structure associated with this flexfield

setBITreeDataViewDefName

protected void setBITreeDataViewDefName(java.lang.String name)

Sets the full name of the BI tree data view definition.

Parameters:

name - the name

getBITreeDataViewDefName

public java.lang.String getBITreeDataViewDefName()

Description copied from interface: FlexfieldDef

Gets the full name of the BI tree data view definition.

Specified by:

getBITreeDataViewDefName in interface FlexfieldDef

Returns:

the full name of the BItree data view definition