|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.1.0) E10653-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.jbo.common.NamedObjectImpl oracle.jbo.mom.DefinitionObject oracle.jbo.mom.PersistableDefObject oracle.jbo.server.MetaObject oracle.jbo.server.RowDef
public abstract class RowDef
Default implementation of DefInterface implemented by all of JBO Definition classes.
Field Summary | |
---|---|
protected java.lang.String |
mAliasName
Database alias name for this definition object. |
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 |
Method Summary | |
---|---|
void |
addAltKey(int indx,
java.lang.String name,
java.lang.String[] components)
|
protected void |
addExtendedDefObject(DefinitionObject extendedDefObject)
|
void |
addListBindingDef(ListBindingDef lbDef)
|
void |
addViewAccessorDef(ViewAccessorDef va)
|
protected java.lang.StringBuffer |
appendBindingNameForAttr(java.lang.StringBuffer strBuf,
AttributeDef attrDef)
|
protected int |
appendBindingSpec(java.lang.StringBuffer strBuf,
int bindingStyle,
int bindIndex,
AttributeDef attrDef,
AttributeDef theOtherAttrDef)
|
protected int |
appendBindingSpec(java.lang.StringBuffer strBuf,
int bindingStyle,
int bindIndex,
AttributeDef attrDef,
AttributeDef theOtherAttrDef,
AssociationEnd assocEnd)
|
protected void |
createDef()
This method should be used to perform custom-metadata initialization in a subclass of RowDef. |
protected boolean |
discrValuesQualify(java.lang.Object[] values)
|
VariableValueManager |
ensureVariableManager()
Returns this object's Variable Value Manager. |
oracle.jbo.server.KeyDef |
findAltKeyDef(java.lang.String name)
|
abstract AttributeDef |
findAttributeDef(java.lang.String name)
Gets an attribute definition, given its name. |
protected RowDef |
findDefForDiscrValues(java.lang.Object[] values,
boolean recurse)
|
ListBindingDef |
findListBindingDef(java.lang.String name)
|
ViewAccessorDef |
findViewAccessorDef(java.lang.String name)
|
protected void |
finishedLoading()
|
java.lang.String |
getAliasName()
Returns the database alias that was declared for this definition object at Design-Time. |
java.util.HashMap |
getAllProperties(java.util.HashMap map,
LocaleContext locale)
|
AttributeDefImpl[] |
getAltKeyAttrDefs(int keyIndex)
|
AttributeDefImpl[] |
getAltKeyAttrDefs(java.lang.String keyName)
|
int |
getAltKeyCount()
|
oracle.jbo.server.KeyDef |
getAltKeyDef(int keyIndex)
|
int |
getAltKeyIndex(java.lang.String name)
|
java.lang.String[] |
getAltKeyNames()
|
abstract int |
getAttributeCount()
Returns the number of defined attributes. |
abstract AttributeDef |
getAttributeDef(int index)
Gets an attribute definition, given its index. |
protected abstract AttributeDefImpl[] |
getAttributeDefImpls()
|
abstract AttributeDef[] |
getAttributeDefs()
Gets the defined attributes. |
int |
getAttributeIndexOf(java.lang.String name)
Finds the index (0-based) of the named attribute. |
java.util.HashSet<java.lang.String> |
getBackwardDependencies(java.lang.String attrName)
|
abstract java.lang.Class |
getBaseComponentClass()
|
DefinitionObject |
getBaseDefObject()
|
int |
getBindingStyle()
Returns the Oracle or JDBC binding style defined for this Entity definition. |
java.lang.String |
getClientProxyClassName()
|
java.lang.Class |
getComponentClass()
|
java.lang.String |
getComponentInterfaceName()
|
DataSourceDef |
getDataSourceDef()
|
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). |
abstract int |
getDefTypeId()
|
java.lang.String |
getDefXMLNameSpace()
|
protected AttributeDefImpl[] |
getDiscrColumns()
Returns the AttributeDef's of the discriminator columns. |
protected java.lang.String |
getEffectiveClientProxyClassName()
|
protected java.lang.String |
getEffectiveComponentInterfaceName()
|
AttributeDefImpl |
getEffectiveDateTransientAttr()
Retuns the Attribute definition that stores the Effective Date value in a row. |
java.lang.Object |
getExprVarVal(java.lang.String varName)
|
java.util.HashSet<java.lang.String> |
getForwardDependencies(java.lang.String attrName)
|
java.util.ArrayList |
getListBindingDefs()
|
OperationDefinitions |
getOperationDefinitions()
|
protected abstract AttributeDefImpl[] |
getPrimaryKeys()
|
abstract AttributeDef[] |
getRawAttributeDefs(boolean procAccessors)
|
abstract java.lang.Class |
getRowClass()
|
VariableValueManager |
getVariableManager()
Returns this object's current Variable Value Manager. |
protected VariableValueManager[] |
getVarMgrParents()
|
java.util.ArrayList |
getViewAccessorDefs()
|
abstract boolean |
hasDataSecurity()
|
boolean |
hasVariables()
Returns a flag indicating whether this object has Variables or not. |
boolean |
isEffectiveDated()
Tests if the row definition corresponds to an Effective Dated object. |
protected static void |
loadFromXML(DefElement xmlElement,
oracle.jbo.server.RemotableCompDef defObj)
|
protected void |
loadListBindings(DefElement xmlElement)
|
protected void |
loadOperationDefinitions(DefElement xmlElement)
|
protected void |
loadOperationDefinitions(DefElement xmlElement,
java.lang.String tag)
|
protected void |
loadProperties(DefElement xmlElement)
|
protected void |
loadVariables(DefElement xmlElement)
|
protected void |
loadViewAccessors(DefElement xmlElement)
|
void |
loadXMLContents(DefElement xmlElement,
java.lang.String fullName)
|
oracle.jbo.server.KeyDef |
lookupAltKeyDef(java.lang.String name)
|
abstract AttributeDef |
lookupAttributeDef(java.lang.String name)
Gets an attribute definition, given its name. |
ListBindingDef |
lookupListBindingDef(java.lang.String name)
|
ViewAccessorDef |
lookupViewAccessorDef(java.lang.String name)
|
void |
registerDefObject()
Registers this def object with MetaObjectManager. |
void |
removeAltKey(java.lang.String name)
|
protected java.lang.Object |
resolvePropertyRaw(java.lang.String property,
LocaleContext locale)
|
protected void |
resolveReferences()
|
void |
setAliasName(java.lang.String s)
|
void |
setBaseDefObject(DefinitionObject baseDefObject)
|
void |
setBaseDefObject(DefinitionObject baseDefObject,
boolean addToBaseDef)
|
void |
setBindingStyle(int bindingStyle)
Sets the Oracle or JDBC binding style defined for this Entity definition. |
void |
setClientProxyClassName(java.lang.String name)
|
void |
setComponentClass(java.lang.Class refClass)
|
void |
setComponentInterfaceName(java.lang.String interfaceName)
|
protected abstract void |
setDefForComponent(ComponentObjectImpl comp)
|
protected void |
setDiscrColumns(AttributeDefImpl[] discrCols)
Sets the AttributeDef's of the discriminator columns. |
void |
setExprVarVal(java.lang.String varName,
java.lang.Object val)
|
void |
setName(java.lang.String name)
Name this object. |
protected void |
setParent(NamedObjectImpl parent)
Sets this object's parent. |
void |
setThrowOnListBindingMismatch(boolean b)
|
boolean |
throwOnListBindingMismatch()
|
protected abstract void |
unsetDefForComponent(ComponentObjectImpl comp)
|
protected void |
verifyExtendedDefObjects()
|
void |
writeChildren(DefWriter jos)
Writes the Object's children to the Persistent storage |
void |
writeContents(DefWriter jos)
Objects should write their persistence output in this method |
void |
writeXMLContents()
|
Methods inherited from class oracle.jbo.server.MetaObject |
---|
deregisterSessionObject, getMessageBundleClass, getMsgBundleDef, getPackageDef, getPackageName, getPersDef, getResourceBundleDef, getResourcePrefix, isDynamic, loadResourceBundle, registerSessionDefObject, resolveDefObject, setMessageBundleClass, setResourceBundleDef |
Methods inherited from class oracle.jbo.common.NamedObjectImpl |
---|
getFullName, getName, 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.StructureDef |
---|
getColumnNameForQuery, getFullName, getName |
Methods inherited from interface oracle.jbo.VariableManagerOwner |
---|
getName |
Methods inherited from interface oracle.jbo.mom.xml.DefPersistable |
---|
getFullName |
Field Detail |
---|
protected java.lang.String mAliasName
Method Detail |
---|
public abstract java.lang.Class getRowClass()
protected abstract AttributeDefImpl[] getAttributeDefImpls()
public java.lang.String getDefName()
StructureDef
getName()
returns the VO's
instance name and getDefName()
returns the
View definition's name.
getDefName
in interface StructureDef
public java.lang.String getDefFullName()
StructureDef
getFullName()
returns the VO's
full instance name and getDefFullName()
returns the
View definition's full name.
getDefFullName
in interface StructureDef
protected AttributeDefImpl[] getDiscrColumns()
protected void setDiscrColumns(AttributeDefImpl[] discrCols)
discrCols
- an array attribute definitions of the discriminator columns.protected boolean discrValuesQualify(java.lang.Object[] values)
protected void verifyExtendedDefObjects()
protected void addExtendedDefObject(DefinitionObject extendedDefObject)
addExtendedDefObject
in class DefinitionObject
protected RowDef findDefForDiscrValues(java.lang.Object[] values, boolean recurse)
public int getBindingStyle()
SQLBuilder
interface.
SQLBuilder
public void setBindingStyle(int bindingStyle)
SQLBuilder
interface.
bindingStyle
- an integer representing the Oracle or JDBC binding
style for this Entity definition.
The possible values can be:
SQLBuilder
public java.lang.String getAliasName()
public void setAliasName(java.lang.String s)
public abstract AttributeDef[] getAttributeDefs()
getAttributeDefs
in interface StructureDef
public abstract AttributeDef[] getRawAttributeDefs(boolean procAccessors)
public abstract int getAttributeCount()
getAttributeCount
in interface StructureDef
public abstract AttributeDef findAttributeDef(java.lang.String name)
findAttributeDef
in interface StructureDef
name
- the name of an AttributeDef
.
NoDefException
- - if the attribute is not found.public abstract AttributeDef lookupAttributeDef(java.lang.String name)
lookupAttributeDef
in interface StructureDef
name
- the name of an AttributeDef
.
public abstract AttributeDef getAttributeDef(int index)
getAttributeDef
in interface StructureDef
index
- the index of an AttributeDef
, where the leftmost
attribute has index zero.
public abstract boolean hasDataSecurity()
public int getAttributeIndexOf(java.lang.String name)
StructureDef
getAttributeIndexOf
in interface StructureDef
name
- the attribute's name.
0
to getAttributeCount() - 1
.
If the named attribute is not found, it returns -1.public final java.util.HashSet<java.lang.String> getBackwardDependencies(java.lang.String attrName)
public final java.util.HashSet<java.lang.String> getForwardDependencies(java.lang.String attrName)
protected void createDef()
Override this method to satisfy your application's specific custom properties for the row definition (entity or view). For example, you would override this method if your application builds custom properties programatically based on user preferences.
protected java.lang.StringBuffer appendBindingNameForAttr(java.lang.StringBuffer strBuf, AttributeDef attrDef)
protected int appendBindingSpec(java.lang.StringBuffer strBuf, int bindingStyle, int bindIndex, AttributeDef attrDef, AttributeDef theOtherAttrDef)
protected int appendBindingSpec(java.lang.StringBuffer strBuf, int bindingStyle, int bindIndex, AttributeDef attrDef, AttributeDef theOtherAttrDef, AssociationEnd assocEnd)
public java.util.ArrayList getListBindingDefs()
public ListBindingDef lookupListBindingDef(java.lang.String name)
public ListBindingDef findListBindingDef(java.lang.String name)
public void addListBindingDef(ListBindingDef lbDef)
public void setThrowOnListBindingMismatch(boolean b)
public boolean throwOnListBindingMismatch()
protected void loadListBindings(DefElement xmlElement)
public java.util.ArrayList getViewAccessorDefs()
public ViewAccessorDef lookupViewAccessorDef(java.lang.String name)
public ViewAccessorDef findViewAccessorDef(java.lang.String name)
public void addViewAccessorDef(ViewAccessorDef va)
protected void loadViewAccessors(DefElement xmlElement)
public void writeChildren(DefWriter jos)
PersistentDefinition
writeChildren
in interface PersistentDefinition
writeChildren
in class MetaObject
jos
- the Output storage for persistencepublic DataSourceDef getDataSourceDef()
protected java.lang.Object resolvePropertyRaw(java.lang.String property, LocaleContext locale)
public java.util.HashMap getAllProperties(java.util.HashMap map, LocaleContext locale)
public void addAltKey(int indx, java.lang.String name, java.lang.String[] components)
public void removeAltKey(java.lang.String name)
public java.lang.String[] getAltKeyNames()
public oracle.jbo.server.KeyDef lookupAltKeyDef(java.lang.String name)
public oracle.jbo.server.KeyDef findAltKeyDef(java.lang.String name)
public oracle.jbo.server.KeyDef getAltKeyDef(int keyIndex)
public int getAltKeyIndex(java.lang.String name)
public int getAltKeyCount()
public AttributeDefImpl[] getAltKeyAttrDefs(java.lang.String keyName)
public AttributeDefImpl[] getAltKeyAttrDefs(int keyIndex)
protected abstract AttributeDefImpl[] getPrimaryKeys()
public java.lang.Object getExprVarVal(java.lang.String varName)
getExprVarVal
in interface ExprValueSupplier
public void setExprVarVal(java.lang.String varName, java.lang.Object val)
setExprVarVal
in interface ExprValueSupplier
public boolean isEffectiveDated()
public AttributeDefImpl getEffectiveDateTransientAttr()
public void registerDefObject()
MetaObject
This method should be called after the def object is
all set up and after resolveDefObject()
is called.
registerDefObject
in class MetaObject
public void writeXMLContents()
writeXMLContents
in class PersistableDefObject
public abstract java.lang.Class getBaseComponentClass()
public java.lang.Class getComponentClass()
public void setComponentClass(java.lang.Class refClass)
public void setComponentInterfaceName(java.lang.String interfaceName)
public java.lang.String getComponentInterfaceName()
public java.lang.String getClientProxyClassName()
public void setClientProxyClassName(java.lang.String name)
protected java.lang.String getEffectiveClientProxyClassName()
protected java.lang.String getEffectiveComponentInterfaceName()
protected static void loadFromXML(DefElement xmlElement, oracle.jbo.server.RemotableCompDef defObj)
public OperationDefinitions getOperationDefinitions()
getOperationDefinitions
in interface OperationDefinitionContainer
protected void loadOperationDefinitions(DefElement xmlElement)
protected final void loadOperationDefinitions(DefElement xmlElement, java.lang.String tag)
public void loadXMLContents(DefElement xmlElement, java.lang.String fullName)
loadXMLContents
in class PersistableDefObject
public void writeContents(DefWriter jos)
PersistentDefinition
writeContents
in interface PersistentDefinition
writeContents
in class MetaObject
jos
- the Output storage for persistencepublic void setName(java.lang.String name)
setName
in class DefinitionObject
name
- the name to be given to this object.public DefinitionObject getBaseDefObject()
getBaseDefObject
in class DefinitionObject
public void setBaseDefObject(DefinitionObject baseDefObject)
setBaseDefObject
in class DefinitionObject
public void setBaseDefObject(DefinitionObject baseDefObject, boolean addToBaseDef)
setBaseDefObject
in class DefinitionObject
protected void resolveReferences()
resolveReferences
in class DefinitionObject
protected void finishedLoading()
finishedLoading
in class DefinitionObject
protected void setParent(NamedObjectImpl parent)
setParent
in class DefinitionObject
parent
- the named object that is to be the parent of this object.protected void loadProperties(DefElement xmlElement)
loadProperties
in class DefinitionObject
xmlElement
- The XML element to load from.protected void loadVariables(DefElement xmlElement)
public abstract int getDefTypeId()
protected abstract void setDefForComponent(ComponentObjectImpl comp)
protected abstract void unsetDefForComponent(ComponentObjectImpl comp)
public VariableValueManager getVariableManager()
VariableManagerOwnerBase
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.
in contrast, ensures
that the Variable Value Manager is initialized (created).
VariableManagerOwnerBase.ensureVariableManager()
getVariableManager
in interface VariableManagerOwnerBase
null
if one was not yet initialized.protected VariableValueManager[] getVarMgrParents()
public boolean hasVariables()
VariableManagerOwnerBase
hasVariables
in interface VariableManagerOwnerBase
public VariableValueManager ensureVariableManager()
VariableManagerOwnerBase
ensureVariableManager
in interface VariableManagerOwnerBase
public java.lang.String getDefXMLNameSpace()
getDefXMLNameSpace
in interface PersistentDefinition
getDefXMLNameSpace
in class PersistableDefObject
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Model 11g Release 1 (11.1.1.1.0) E10653-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |