oracle.adf.model.generic
Class StructureDefImpl

java.lang.Object
  oracle.jbo.common.NamedObjectImpl
      oracle.jbo.mom.DefinitionObject
          oracle.jbo.mom.PersistableDefObject
              oracle.jbo.server.MetaObject
                  oracle.adf.model.generic.StructureDefImpl

All Implemented Interfaces:

ResourceBundleOwner, DefPersistable, PersistentDefinition, ValidationManager, StructureDef, VariableManagerOwner, VariableManagerOwnerBase

Direct Known Subclasses:

AccessorDefImpl, MethodAccessorDefImpl, MethodAccessorDefImpl.ParameterInfoImpl

public class StructureDefImpl
extends MetaObject
implements StructureDef, ValidationManager

Imlemented by classes that access a View Object's or Entity Object's metadata.

Since:

JDeveloper 3.0

See Also:

ApplicationModule, RowSet

Field Summary

protected boolean	loaded
protected StructureDefImpl[]	mAccessors
protected AttributeDefImpl[]	mAttrs
protected java.lang.Class	mBeanClass
protected java.lang.String	mBeanClassName
protected boolean	mElementsScalar
protected StructureDefImpl[]	mMethodAccessors
protected java.lang.String	mMsgClassName
protected java.lang.String	mName
protected StructureDefImpl[]	mScalarAccessors
static java.lang.String	PName_AccessorAttribute
static java.lang.String	PName_ArrayElementType
static java.lang.String	PName_Attribute
static java.lang.String	PName_BeanClass
static java.lang.String	PName_CollectionBeanClass
static java.lang.String	PName_Event
static java.lang.String	PName_Events
static java.lang.String	PName_FieldName
static java.lang.String	PName_FieldType
static java.lang.String	PName_IsCollection
static java.lang.String	PName_IsStructured
static java.lang.String	PName_MsgBundleClass
static java.lang.String	PName_Name
static java.lang.String	PName_ReadOnly
static java.lang.String	SCALAR_ELEMENT_NAME

Fields inherited from class oracle.jbo.server.MetaObject

mComponentClass

Fields inherited from class oracle.jbo.mom.DefinitionObject

DEF_MDS_CLIENT_KEY, DEF_SCOPE_PERS, DEF_SCOPE_SESSION, DEF_SCOPE_SHARED, mBaseDefObject, mExtendedDefObjects, mObjectResolved, PERSDEF_MDS_CLIENT_KEY

Fields inherited from class oracle.jbo.common.NamedObjectImpl

mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX

Fields inherited from interface oracle.jbo.mom.xml.DefPersistable

XML_STATEMENT

Constructor Summary

StructureDefImpl()
For internal use

StructureDefImpl(DCDataControl app, java.lang.String sDefName, java.lang.String sName)

Method Summary

void	addValidator(JboValidatorInterface intf)
void	clearDefinition()
AttributeDef	createAccessorAttributeDef(java.lang.String accName, StructureDefImpl accDef, boolean add) For internal framework use only
static StructureDefImpl	createAndLoadFromXML(DefElement elem)
protected AccessorDefImpl	createNewAccessor(java.lang.String sDefName, AccessorDefinition accDef227, DCDataControl app)
protected AccessorDefImpl	createNewAccessor(java.lang.String sDefName, java.lang.String sName, DCDataControl app)
ViewCriteria	createViewCriteria()
VariableValueManager	ensureVariableManager() Returns this object's Variable Value Manager.
AttributeDef	findAttributeDef(java.lang.String name) Gets an attribute definition, given its name.
protected void	finishedLoading()
StructureDefImpl	getAccessorDef(java.lang.String name)
StructureDefImpl[]	getAccessors()
java.util.ArrayList	getAllEventdefinitions(java.lang.String methodAccName, java.lang.String[] argTypes) Gets EventDefintions Array List , it includes event defs associated with all the child StructureDef's of this Structure Def
java.util.HashMap	getAllProperties(java.util.HashMap map, LocaleContext locale)
java.util.Map	getAllViewCriteriasMapInternal()
java.lang.String	getArrayElementType()
int	getAttributeCount() Returns the number of defined attributes.
AttributeDef	getAttributeDef(int index) Gets an attribute definition, given its index.
AttributeDef[]	getAttributeDefs() Gets the defined attributes.
int	getAttributeIndexOf(java.lang.String name) Finds the index (0-based) of the named attribute.
DefinitionObject	getBaseDefObject()
java.lang.Class	getBeanClass()
java.lang.String	getBeanClassName()
java.lang.String	getColumnNameForQuery(int index)
java.lang.String	getDefFullName() Returns the fully qualified name of the structure's base definition.
java.lang.String	getDefName() Returns the structure's base definition name (short form).
int	getDefTypeId()
java.lang.String	getDefXMLNameSpace()
java.lang.String	getFieldType()
java.lang.String	getFullName() Gets this object's fully-qualified name.
java.lang.String	getMessageBundleClassName()
StructureDefImpl[]	getMethodAccessors() Advanced only for testing purposes.
java.lang.String	getName() Get the name of this object.
protected StructureDefImpl[]	getScalarAccessorsList()
java.util.ArrayList	getValidators()
VariableValueManager	getVariableManager() Returns this object's current Variable Value Manager.
protected VariableValueManager[]	getVarMgrParents()
boolean	hasVariables() Returns a flag indicating whether this object has Variables or not.
void	init(java.util.HashMap map) Advanced only for testing purposes.
boolean	isCollection()
boolean	isElementsScalar() Advanced only for testing purposes.
boolean	isStructured()
protected void	loadFromXML(java.lang.String beanClass)
protected void	loadListBindings(DefElement xmlElement)
protected void	loadProperties(DefElement xmlElement)
protected void	loadVariables(DefElement xmlElement)
AttributeDef	lookupAttributeDef(java.lang.String name) Gets an attribute definition, given its name.
void	putViewCriteria(java.lang.String name, ViewCriteria criteria)
protected void	readChildren(DefElement elem)
void	readContents(DefElement elem)
protected void	referToMOMStructureDef(java.lang.String beanClass)
void	resolveDefObject()
protected java.lang.Object	resolvePropertyRaw(java.lang.String property, LocaleContext locale)
protected void	resolveReferences()
void	setAccessors(StructureDefImpl[] ad) Advanced only for testing purposes.
void	setArrayElementType(java.lang.String sType)
void	setAttributes(AttributeDefImpl[] ad) Advanced only for testing purposes.
void	setBaseDefObject(DefinitionObject baseDefObject)
void	setBaseDefObject(DefinitionObject baseDefObject, boolean addToBaseDef)
void	setBeanClassName(java.lang.String sName)
protected void	setDefForComponent(ComponentObjectImpl comp)
void	setFieldType(java.lang.String sType)
void	setIsCollection(boolean bSet)
void	setIsStructured(boolean bSet)
void	setMethodAccessors(StructureDefImpl[] ad) Advanced only for testing purposes.
void	setName(java.lang.String str) Name this object.
protected void	setParent(NamedObjectImpl parent) Sets this object's parent.
protected boolean	throwOnListBindingMismatch()
protected void	unsetDefForComponent(ComponentObjectImpl comp)

Methods inherited from class oracle.jbo.server.MetaObject

deregisterSessionObject, getMessageBundleClass, getMsgBundleDef, getPackageDef, getPackageName, getPersDef, getResourceBundleDef, getResourcePrefix, isDynamic, loadResourceBundle, registerDefObject, registerSessionDefObject, setMessageBundleClass, setResourceBundleDef, writeChildren, writeContents

Methods inherited from class oracle.jbo.mom.PersistableDefObject

addDefImport, allocatePropertyMap, checkEditable, close, createFromXML, findDefImport, getBaseDir, getBasePackage, getDefImports, getDefManager, getDefWriter, getDefXMLElementTag, getEditObject, getFileName, getFullDirName, getFullFileName, getOrigObject, getPropertyMap, getSubstitutedNames, getXMLElementTag, guaranteePath, isDirty, isEditable, isNew, loadDefImports, loadXMLContents, objectRemoved, registerClass, remove, removeAndDelete, removeDefImport, removeProperty, saveXMLContents, setDefaultBaseDir, setDefMgr, setDirty, setEditable, setNew, setOrigObject, setProperty, setPropertyMap, updateChildrenList, verifyVersion, writeObject, writeVersion, writeXMLContents

Methods inherited from class oracle.jbo.mom.DefinitionObject

addExtendedDefObject, addPropertySetName, getContainerDef, getContainerName, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, hasExtendedDefObjects, isBaseDefFor, isDynamicDefinitionObject, isObjectResolved, loadCustomProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, removeExtendedDefObject, setDefScope, setMdsKey, setMdsReference, setObjectResolved, setPropertySetName

Methods inherited from class oracle.jbo.common.NamedObjectImpl

getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getResourcesFromBundle, refreshProperty, removeProperty, requiresNamePrefixedResId, setFullName, setPropertiesMap, setPropertiesMap2, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.jbo.rules.ValidationManager

getResourceBundleDef

Field Detail

mAttrs

protected AttributeDefImpl[] mAttrs

mAccessors

protected StructureDefImpl[] mAccessors

mScalarAccessors

protected StructureDefImpl[] mScalarAccessors

mMethodAccessors

protected StructureDefImpl[] mMethodAccessors

mName

protected java.lang.String mName

mMsgClassName

protected java.lang.String mMsgClassName

mBeanClassName

protected java.lang.String mBeanClassName

mBeanClass

protected java.lang.Class mBeanClass

mElementsScalar

protected boolean mElementsScalar

loaded

protected boolean loaded

PName_Attribute

public static final java.lang.String PName_Attribute

See Also:

Constant Field Values

PName_AccessorAttribute

public static final java.lang.String PName_AccessorAttribute

See Also:

Constant Field Values

PName_FieldName

public static final java.lang.String PName_FieldName

See Also:

Constant Field Values

PName_FieldType

public static final java.lang.String PName_FieldType

See Also:

Constant Field Values

PName_BeanClass

public static final java.lang.String PName_BeanClass

See Also:

Constant Field Values

PName_MsgBundleClass

public static final java.lang.String PName_MsgBundleClass

See Also:

Constant Field Values

PName_IsCollection

public static final java.lang.String PName_IsCollection

See Also:

Constant Field Values

PName_IsStructured

public static final java.lang.String PName_IsStructured

See Also:

Constant Field Values

PName_ArrayElementType

public static final java.lang.String PName_ArrayElementType

See Also:

Constant Field Values

PName_Name

public static final java.lang.String PName_Name

See Also:

Constant Field Values

PName_ReadOnly

public static final java.lang.String PName_ReadOnly

See Also:

Constant Field Values

PName_Events

public static final java.lang.String PName_Events

See Also:

Constant Field Values

PName_Event

public static final java.lang.String PName_Event

See Also:

Constant Field Values

SCALAR_ELEMENT_NAME

public static final java.lang.String SCALAR_ELEMENT_NAME

See Also:

Constant Field Values

PName_CollectionBeanClass

public static final java.lang.String PName_CollectionBeanClass

See Also:

Constant Field Values

Constructor Detail

StructureDefImpl

public StructureDefImpl()

For internal use

StructureDefImpl

public StructureDefImpl(DCDataControl app,
                        java.lang.String sDefName,
                        java.lang.String sName)

Method Detail

getName

public java.lang.String getName()

Description copied from class: NamedObjectImpl

Get the name of this object.

Specified by:

getName in interface ValidationManager

Specified by:

getName in interface StructureDef

Specified by:

getName in interface VariableManagerOwner

Overrides:

getName in class NamedObjectImpl

Returns:

the name given to this object.

getFullName

public java.lang.String getFullName()

Description copied from class: NamedObjectImpl

Gets this object's fully-qualified name.

Specified by:

getFullName in interface DefPersistable

Specified by:

getFullName in interface ValidationManager

Specified by:

getFullName in interface StructureDef

Overrides:

getFullName in class NamedObjectImpl

Returns:

this object's fully-qualified name; the package name concatenated with the class name.

getDefName

public java.lang.String getDefName()

Description copied from interface: StructureDef

Returns the structure's base definition name (short form). Note that, in some cases, a StructureDef may have an instance name and definition name. For example, for a View Object, getName() returns the VO's instance name and getDefName() returns the View definition's name.

Specified by:

getDefName in interface StructureDef

Returns:

name of the structure's base definition.

getDefFullName

public java.lang.String getDefFullName()

Description copied from interface: StructureDef

Returns the fully qualified name of the structure's base definition. Note that, in some cases, a StructureDef may have an instance name and definition name. For example, for a View Object, getFullName() returns the VO's full instance name and getDefFullName() returns the View definition's full name.

Specified by:

getDefFullName in interface StructureDef

Returns:

fully qualified name of the structure's base definition.

getArrayElementType

public java.lang.String getArrayElementType()

setArrayElementType

public void setArrayElementType(java.lang.String sType)

isStructured

public boolean isStructured()

setIsStructured

public void setIsStructured(boolean bSet)

isCollection

public boolean isCollection()

setIsCollection

public void setIsCollection(boolean bSet)

getAttributeDefs

public AttributeDef[] getAttributeDefs()

Gets the defined attributes.

Specified by:

getAttributeDefs in interface StructureDef

Returns:

an array of attribute definitions.

getAttributeCount

public int getAttributeCount()

Returns the number of defined attributes.

Specified by:

getAttributeCount in interface StructureDef

Returns:

the number of attributes.

findAttributeDef

public AttributeDef findAttributeDef(java.lang.String name)

Gets an attribute definition, given its name.

Specified by:

findAttributeDef in interface StructureDef

Parameters:

name - the name of an AttributeDef.

Returns:

an attribute definition

Throws:

NoDefException - - if the attribute is not found.

lookupAttributeDef

public AttributeDef lookupAttributeDef(java.lang.String name)

Gets an attribute definition, given its name.

Specified by:

lookupAttributeDef in interface StructureDef

Parameters:

name - the name of an AttributeDef.

Returns:

an attribute definition if found, null otherwise

getAttributeDef

public AttributeDef getAttributeDef(int index)

Gets an attribute definition, given its index.

Specified by:

getAttributeDef in interface StructureDef

Parameters:

index - the index of an AttributeDef, where the leftmost attribute has index zero.

Returns:

an attribute definition.

getAttributeIndexOf

public int getAttributeIndexOf(java.lang.String name)

Description copied from interface: StructureDef

Finds the index (0-based) of the named attribute.

Specified by:

getAttributeIndexOf in interface StructureDef

Parameters:

name - the attribute's name.

Returns:

an integer in the range 0 to getAttributeCount() - 1. If the named attribute is not found, it returns -1.

getColumnNameForQuery

public java.lang.String getColumnNameForQuery(int index)

Specified by:

getColumnNameForQuery in interface StructureDef

getAccessorDef

public StructureDefImpl getAccessorDef(java.lang.String name)

createAccessorAttributeDef

public AttributeDef createAccessorAttributeDef(java.lang.String accName,
                                               StructureDefImpl accDef,
                                               boolean add)

For internal framework use only

getAccessors

public StructureDefImpl[] getAccessors()

createAndLoadFromXML

public static StructureDefImpl createAndLoadFromXML(DefElement elem)

loadFromXML

protected void loadFromXML(java.lang.String beanClass)

init

public void init(java.util.HashMap map)

Advanced only for testing purposes.

readContents

public void readContents(DefElement elem)

readChildren

protected void readChildren(DefElement elem)

loadListBindings

protected void loadListBindings(DefElement xmlElement)

throwOnListBindingMismatch

protected boolean throwOnListBindingMismatch()

referToMOMStructureDef

protected void referToMOMStructureDef(java.lang.String beanClass)

isElementsScalar

public final boolean isElementsScalar()

Advanced only for testing purposes.

getScalarAccessorsList

protected StructureDefImpl[] getScalarAccessorsList()

createNewAccessor

protected AccessorDefImpl createNewAccessor(java.lang.String sDefName,
                                            java.lang.String sName,
                                            DCDataControl app)

createNewAccessor

protected AccessorDefImpl createNewAccessor(java.lang.String sDefName,
                                            AccessorDefinition accDef227,
                                            DCDataControl app)

setAttributes

public void setAttributes(AttributeDefImpl[] ad)

Advanced only for testing purposes.

setAccessors

public void setAccessors(StructureDefImpl[] ad)

Advanced only for testing purposes.

setName

public void setName(java.lang.String str)

Name this object.

Parameters:

str -

For internal use only. Application developers should not use this

getFieldType

public java.lang.String getFieldType()

setFieldType

public void setFieldType(java.lang.String sType)

getMessageBundleClassName

public java.lang.String getMessageBundleClassName()

getBeanClassName

public java.lang.String getBeanClassName()

setBeanClassName

public void setBeanClassName(java.lang.String sName)

getBeanClass

public java.lang.Class getBeanClass()

addValidator

public void addValidator(JboValidatorInterface intf)

Specified by:

addValidator in interface ValidationManager

getValidators

public java.util.ArrayList getValidators()

Specified by:

getValidators in interface ValidationManager

setMethodAccessors

public void setMethodAccessors(StructureDefImpl[] ad)

Advanced only for testing purposes.

getMethodAccessors

public StructureDefImpl[] getMethodAccessors()

Advanced only for testing purposes.

getAllEventdefinitions

public java.util.ArrayList getAllEventdefinitions(java.lang.String methodAccName,
                                                  java.lang.String[] argTypes)

Gets EventDefintions Array List , it includes event defs associated with all the child StructureDef's of this Structure Def

clearDefinition

public void clearDefinition()

getAllViewCriteriasMapInternal

public java.util.Map getAllViewCriteriasMapInternal()

For internal use only. Application developers should not use this

putViewCriteria

public void putViewCriteria(java.lang.String name,
                            ViewCriteria criteria)

createViewCriteria

public ViewCriteria createViewCriteria()

loadVariables

protected void loadVariables(DefElement xmlElement)

resolveDefObject

public void resolveDefObject()

Specified by:

resolveDefObject in class MetaObject

getDefTypeId

public int getDefTypeId()

setDefForComponent

protected void setDefForComponent(ComponentObjectImpl comp)

unsetDefForComponent

protected void unsetDefForComponent(ComponentObjectImpl comp)

getBaseDefObject

public DefinitionObject getBaseDefObject()

Overrides:

getBaseDefObject in class DefinitionObject

setBaseDefObject

public void setBaseDefObject(DefinitionObject baseDefObject)

Overrides:

setBaseDefObject in class DefinitionObject

setBaseDefObject

public void setBaseDefObject(DefinitionObject baseDefObject,
                             boolean addToBaseDef)

Overrides:

setBaseDefObject in class DefinitionObject

resolveReferences

protected void resolveReferences()

Overrides:

resolveReferences in class DefinitionObject

finishedLoading

protected void finishedLoading()

Overrides:

finishedLoading in class PersistableDefObject

setParent

protected void setParent(NamedObjectImpl parent)

Sets this object's parent.

Overrides:

setParent in class DefinitionObject

Parameters:

parent - the named object that is to be the parent of this object.

loadProperties

protected void loadProperties(DefElement xmlElement)

Overrides:

loadProperties in class DefinitionObject

Parameters:

xmlElement - The XML element to load from.

getVariableManager

public VariableValueManager getVariableManager()

Description copied from interface: VariableManagerOwnerBase

Returns this object's current Variable Value Manager. It will return null if Variable Value Manager has been initialized.

When a framework object is first created, its Variable Value Manager may be null. This method does not initialize (create) the Variable Value Manager.

VariableManagerOwnerBase.ensureVariableManager() in contrast, ensures that the Variable Value Manager is initialized (created).

Specified by:

getVariableManager in interface VariableManagerOwnerBase

Returns:

this object's current Variable Value Manager. May return null if one was not yet initialized.

getVarMgrParents

protected VariableValueManager[] getVarMgrParents()

hasVariables

public boolean hasVariables()

Description copied from interface: VariableManagerOwnerBase

Returns a flag indicating whether this object has Variables or not.

Specified by:

hasVariables in interface VariableManagerOwnerBase

Returns:

the flag indicating whether this object has Variables.

ensureVariableManager

public VariableValueManager ensureVariableManager()

Description copied from interface: VariableManagerOwnerBase

Returns this object's Variable Value Manager. If this object current has no Variable Value Manager, it will initialize (create) one.

Specified by:

ensureVariableManager in interface VariableManagerOwnerBase

Returns:

this object's Variable Value Manager. Will create a Variable Value Manager if this object had no Variable Value Manager.

getDefXMLNameSpace

public java.lang.String getDefXMLNameSpace()

Specified by:

getDefXMLNameSpace in interface PersistentDefinition

Overrides:

getDefXMLNameSpace in class PersistableDefObject

resolvePropertyRaw

protected java.lang.Object resolvePropertyRaw(java.lang.String property,
                                              LocaleContext locale)

Overrides:

resolvePropertyRaw in class NamedObjectImpl

getAllProperties

public java.util.HashMap getAllProperties(java.util.HashMap map,
                                          LocaleContext locale)

Overrides:

getAllProperties in class NamedObjectImpl