Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.3.0)

E17483-04


oracle.adf.model.generic
Class StructureDefImpl

java.lang.Object
  extended by oracle.jbo.common.NamedObjectImpl
      extended by oracle.jbo.mom.DefinitionObject
          extended by oracle.jbo.mom.PersistableDefObject
              extended by oracle.jbo.server.DefObject
                  extended by oracle.jbo.server.MetaObject
                      extended by 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

Nested Class Summary

 

Nested classes/interfaces inherited from class oracle.jbo.mom.PersistableDefObject
PersistableDefObject.CustomizationType, PersistableDefObject.PersonalizationType

 

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, PROPERTY_EXPRMAP

 

Fields inherited from class oracle.jbo.common.NamedObjectImpl
mFullName, mObjName, mParent, mProperties, RES_ID_SUFFIX, RESID_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()
           
 AttributeDef findAttributeDef(java.lang.String name)
          Gets an attribute definition, given its name.
 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.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.
 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 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()
           
 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 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()
           
 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 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  boolean throwOnListBindingMismatch()
           
protected  void unsetDefForComponent(ComponentObjectImpl comp)
           

 

Methods inherited from class oracle.jbo.server.MetaObject
deregisterSessionObject, getMessageBundleClass, getMsgBundleDef, getPackageDef, getPackageName, getPersDef, getPersDefNoUpdateCheck, getResourceBundleDef, getResourcePrefix, isDynamic, loadResourceBundle, registerDefObject, registerSessionDefObject, setMessageBundleClass, setResourceBundleDef, writeChildren, writeContents

 

Methods inherited from class oracle.jbo.server.DefObject
ensureVariableManager, finishedLoading, getAllProperties, getBaseDefObject, getDefXMLNameSpace, getVariableManager, getVarMgrParents, hasVariables, loadProperties, resolvePropertyRaw, resolveReferences, setBaseDefObject, setBaseDefObject, setParent

 

Methods inherited from class oracle.jbo.mom.PersistableDefObject
addDefImport, addExtendedDefObject, allocatePropertyMap, checkEditable, close, createFromXML, findDefImport, getBaseDir, getBasePackage, getDefImports, getDefManager, getDefWriter, getDefXMLElementTag, getEditObject, getExtendedDefObjectsInternal, getFileName, getFullDirName, getFullFileName, getOrigObject, getPropertyMap, getSubstitutedNames, getSyncLock, getXMLElementTag, guaranteePath, hasExtendedDefObjects, isCustomizationEnabled, isCustomizationEnabled, isDirty, isEditable, isNew, isPersonalizationEnabled, isPersonalizationEnabled, loadDefImports, loadXMLContents, mergePropertyMap, objectRemoved, reapplyChanges, reapplyChangesToChildren, reapplyChangesToContents, registerClass, remove, removeAndDelete, removeDefImport, removeExtendedDefObject, removeProperty, saveXMLContents, setCustomizationEnabled, setCustomizationEnabled, setDefaultBaseDir, setDefMgr, setDirty, setEditable, setFullName, setNew, setOrigObject, setPersonalizationEnabled, setPersonalizationEnabled, setProperty, setPropertyExpression, setPropertyMap, updateChildrenList, verifyVersion, writeObject, writeVersion, writeXMLContents

 

Methods inherited from class oracle.jbo.mom.DefinitionObject
addPropertySetName, enableUpdateCheck, getContainerDef, getContainerName, getDefScope, getExtendedDefObjects, getMdsKey, getMdsReference, getPropertySetName, getPropertySetNames, isBaseDefFor, isDynamicDefinitionObject, isObjectResolved, isSuppressUpdateCheck, loadCustomProperties, loadPropertiesInMap, loadPropertySetNames, loadSchemaProperties, setDefScope, setMdsKey, setMdsReference, setObjectResolved, setPropertySetName, suppressUpdateCheck

 

Methods inherited from class oracle.jbo.common.NamedObjectImpl
getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getPropertyExpressionsMap, getResourcesFromBundle, getStringFromMessageBundle, isPropertyExpression, refreshProperty, removeProperty, requiresNamePrefixedResId, resolveObjectProperty, 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)
Description copied from class: DefObject
Name this object.
Overrides:
setName in class DefObject
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)
Overrides:
loadVariables in class DefObject

resolveDefObject

public void resolveDefObject()
Specified by:
resolveDefObject in class MetaObject

getDefTypeId

public int getDefTypeId()
Specified by:
getDefTypeId in class DefObject

setDefForComponent

protected void setDefForComponent(ComponentObjectImpl comp)
Specified by:
setDefForComponent in class DefObject

unsetDefForComponent

protected void unsetDefForComponent(ComponentObjectImpl comp)
Specified by:
unsetDefForComponent in class DefObject

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Model
11g Release 2 (11.1.2.3.0)

E17483-04


Copyright © 1997, 2012, Oracle. All rights reserved.