Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client
11g Release 1 (11.1.1)

E17503-02

oracle.jbo.server
Class RowDef

java.lang.Object
  extended by oracle.jbo.server.NamedObjectImpl
      extended by oracle.jbo.mom.PersistableDefObject
          extended by oracle.jbo.server.DefObject
              extended by oracle.jbo.server.MetaObject
                  extended by oracle.jbo.server.RowDef
All Implemented Interfaces:
Formattable, ResourceBundleOwner, StructureDef, VariableManagerOwner, VariableManagerOwnerBase
Direct Known Subclasses:
EntityDefImpl, ViewDefImpl

public abstract class RowDef
extends MetaObject
implements StructureDef

Abstract class which represents the definition of a tabular row


Field Summary
static java.lang.Class CLASS_INSTANCE
           
protected  OrderedDictionary mAttrAccessors
           
 
Fields inherited from class oracle.jbo.server.MetaObject
mComponentClass
 
Fields inherited from class oracle.jbo.server.DefObject
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.server.NamedObjectImpl
mObjName, mParent, mProperties, mUserData, RES_ID_SUFFIX
 
Constructor Summary
RowDef()
           
 
Method Summary
 void addAltKey(int indx, java.lang.String name, java.lang.String[] components)
           
 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, AssociationEnd assocEnd)
           
protected  void bindListBindings()
           
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)
           
 KeyDef findAltKeyDef(java.lang.String name)
           
 AttributeDef findAttributeDef(java.lang.String name)
          Retrieve a column definition by column name
protected  RowDef findDefForDiscrValues(java.lang.Object[] values, boolean recurse)
           
 ListBindingDef findListBindingDef(java.lang.String name)
           
 ViewAccessorDef findViewAccessorDef(java.lang.String name)
           
 java.lang.String formatForOutput(OutputFormatter formatter)
           
 java.lang.String getAliasName()
           
 AttributeDefImpl[] getAltKeyAttrDefs(int keyIndex)
           
 AttributeDefImpl[] getAltKeyAttrDefs(java.lang.String keyName)
           
 int getAltKeyCount()
           
 KeyDef getAltKeyDef(int keyIndex)
           
 java.lang.String[] getAltKeyNames()
           
 int getAttributeCount()
          How many attributes comprise this row?
 AttributeDef getAttributeDef(int index)
          Retrive a column definition by column index
 AttributeDefImpl getAttributeDefImpl(int index)
          Given the attribute's column position (index) in the database, returns the attribute definition object.
 AttributeDefImpl getAttributeDefImpl(java.lang.String attrName)
          Given an attribute name, returns the attribute definition object.
protected  AttributeDefImpl[] getAttributeDefImpls()
          Returns the AttributeDefImpls objects for this Entity Object.
 AttributeDef[] getAttributeDefs()
          Get all column definitions which comprise this row.
 int getAttributeIndexOf(java.lang.String name)
          Which index corresponds to the column with the specified name?
 java.lang.Class getBaseComponentClass()
           
 int getBindingStyle()
           
 java.lang.String getClientProxyClassName()
           
 java.lang.String getColumnNameForQuery(int index)
           
 java.lang.Class getComponentClass()
           
 java.lang.String getComponentInterfaceName()
           
 java.lang.String getDefFullName()
          Get the full name of this row definition object
 java.lang.String getDefName()
          Get the short name of this row definition object
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.
 ArrayList getListBindingDefs()
           
protected abstract  AttributeDefImpl[] getPrimaryKeys()
           
abstract  java.lang.Class getRowClass()
           
 ArrayList getViewAccessorDefs()
           
 boolean isEffectiveDated()
          Tests if the row definition corresponds to an Effective Dated object.
protected static void loadFromXML(org.kxml2.io.KXmlParser parser, oracle.jbo.server.RemotableCompDef defObj)
           
protected  void loadListBindings(org.kxml2.io.KXmlParser parser)
           
protected  ViewAccessorDef loadViewAccessor(org.kxml2.io.KXmlParser parser)
           
 void loadXMLContents(org.kxml2.io.KXmlParser parser, java.lang.String fullName)
           
 KeyDef lookupAltKeyDef(java.lang.String name)
           
 AttributeDef lookupAttributeDef(java.lang.String name)
          Retrieve a column definition by column name
 ListBindingDef lookupListBindingDef(java.lang.String name)
           
 ViewAccessorDef lookupViewAccessorDef(java.lang.String name)
           
 void setAliasName(java.lang.String name)
           
protected  void setBindingStyle(int style)
           
 void setClientProxyClassName(java.lang.String name)
           
 void setComponentClass(java.lang.Class refClass)
           
 void setComponentInterfaceName(java.lang.String interfaceName)
           
protected  void setDiscrColumns(AttributeDefImpl[] discrCols)
          Sets the AttributeDef's of the discriminator columns.
 void setThrowOnListBindingMismatch(boolean b)
           
 boolean throwOnListBindingMismatch()
           
 
Methods inherited from class oracle.jbo.server.MetaObject
getMessageBundleClass, getMsgBundleDef, setMessageBundleClass
 
Methods inherited from class oracle.jbo.server.DefObject
addExtendedDefObject, ensureVariableManager, getBaseDefObject, getDefScope, getExtendedDefObjects, getResourceBundleDef, getResourcePrefix, getVariableManager, getVarMgrParents, hasExtendedDefObjects, hasVariables, isBaseDefFor, isObjectResolved, loadProperties, loadProperties, loadResourceBundleDef, loadUserData, resolvePropertyRaw, setBaseDefObject, setBaseDefObject, setDefForComponent, setDefScope, setObjectResolved, setResourceBundleDef, unsetDefForComponent
 
Methods inherited from class oracle.jbo.mom.PersistableDefObject
getDefManager
 
Methods inherited from class oracle.jbo.server.NamedObjectImpl
formatChildCollectionForOutput, formatChildCollectionForOutput, formatChildCollectionForOutput, formatForOutput, getAllProperties, getFullName, getName, getParent, getProperties, getPropertiesAsStrings, getPropertiesMap, getProperty, getProperty, getResourcesFromBundle, getUserData, parseAttrArrayElements, refreshProperty, requiresNamePrefixedResId, setFullName, setName, setParent, setPropertiesMap, setProperty
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.jbo.StructureDef
getFullName, getName
 
Methods inherited from interface oracle.jbo.common.ResourceBundleOwner
getResourceBundleDef, getResourcePrefix
 
Methods inherited from interface oracle.jbo.VariableManagerOwner
getName
 

Field Detail

CLASS_INSTANCE

public static final java.lang.Class CLASS_INSTANCE

mAttrAccessors

protected OrderedDictionary mAttrAccessors
Constructor Detail

RowDef

public RowDef()
Method Detail

findAttributeDef

public AttributeDef findAttributeDef(java.lang.String name)
Retrieve a column definition by column name

Specified by:
findAttributeDef in interface StructureDef
Parameters:
name - the name of an AttributeDef.
Returns:
An AttributeDef object for the named column, or null if a column with that name does not exist.

getAttributeCount

public int getAttributeCount()
How many attributes comprise this row?

Specified by:
getAttributeCount in interface StructureDef
Returns:
# of attributes

getAttributeDef

public AttributeDef getAttributeDef(int index)
Retrive a column definition by column index

Specified by:
getAttributeDef in interface StructureDef
Parameters:
index - 0...n
Returns:
An AttributeDef object for the column number, or null if the column index is out of range.

getAttributeDefImpl

public AttributeDefImpl getAttributeDefImpl(int index)
Given the attribute's column position (index) in the database, returns the attribute definition object.

This method takes the Entity attribute's database column position (index) and returns the corresponding attribute definition object. For example, use this method to get the attribute definition object to store custom properties.

Parameters:
index - the attribute's database column position, where the leftmost column has index 0.
Returns:
an Entity attribute definition object; null if the given index is invalid.

getAttributeDefImpl

public AttributeDefImpl getAttributeDefImpl(java.lang.String attrName)
Given an attribute name, returns the attribute definition object.

This method takes the string name of an Entity Object attribute and returns the corresponding attribute definition object. For example, use this method to get the attribute definition object to store custom properties.

Parameters:
attrName - the specified Entity attribute.
Returns:
an Entity attribute definition object.

getAttributeDefImpls

protected AttributeDefImpl[] getAttributeDefImpls()
Returns the AttributeDefImpls objects for this Entity Object. This method is typically used when customizing properties.

Returns:
an array of the attribute descriptors.

getAttributeDefs

public AttributeDef[] getAttributeDefs()
Get all column definitions which comprise this row.

Specified by:
getAttributeDefs in interface StructureDef
Returns:
An array of AttributeDef objects

getAttributeIndexOf

public int getAttributeIndexOf(java.lang.String name)
Which index corresponds to the column with the specified name?

Specified by:
getAttributeIndexOf in interface StructureDef
Parameters:
name - the attribute's name.
Returns:
A 0-based column index if named column exists; else -1

getDefFullName

public java.lang.String getDefFullName()
Get the full name of this row definition object

Specified by:
getDefFullName in interface StructureDef
Returns:
fully qualified name of the structure's base definition.

getDefName

public java.lang.String getDefName()
Get the short name of this row definition object

Specified by:
getDefName in interface StructureDef
Returns:
name of the structure's base definition.

lookupAttributeDef

public AttributeDef lookupAttributeDef(java.lang.String name)
Retrieve a column definition by column name

Specified by:
lookupAttributeDef in interface StructureDef
Parameters:
name - the name of an AttributeDef.
Returns:
An AttributeDef object for the named column, or null if a column with that name does not exist.

getAliasName

public java.lang.String getAliasName()

setAliasName

public void setAliasName(java.lang.String name)

setBindingStyle

protected void setBindingStyle(int style)

getBindingStyle

public int getBindingStyle()

getDiscrColumns

protected AttributeDefImpl[] getDiscrColumns()
Returns the AttributeDef's of the discriminator columns.

Returns:
an array attribute definitions of the discriminator columns.

setDiscrColumns

protected void setDiscrColumns(AttributeDefImpl[] discrCols)
Sets the AttributeDef's of the discriminator columns.

Parameters:
discrCols - an array attribute definitions of the discriminator columns.

getPrimaryKeys

protected abstract AttributeDefImpl[] getPrimaryKeys()

appendBindingSpec

protected int appendBindingSpec(java.lang.StringBuffer strBuf,
                                int bindingStyle,
                                int bindIndex,
                                AttributeDef attrDef,
                                AttributeDef theOtherAttrDef,
                                AssociationEnd assocEnd)

appendBindingNameForAttr

protected java.lang.StringBuffer appendBindingNameForAttr(java.lang.StringBuffer strBuf,
                                                          AttributeDef attrDef)

addAltKey

public void addAltKey(int indx,
                      java.lang.String name,
                      java.lang.String[] components)

lookupAltKeyDef

public KeyDef lookupAltKeyDef(java.lang.String name)

findAltKeyDef

public KeyDef findAltKeyDef(java.lang.String name)

getViewAccessorDefs

public ArrayList getViewAccessorDefs()

isEffectiveDated

public boolean isEffectiveDated()
Tests if the row definition corresponds to an Effective Dated object.


getEffectiveDateTransientAttr

public AttributeDefImpl getEffectiveDateTransientAttr()
Retuns the Attribute definition that stores the Effective Date value in a row. This method is overridden in ViewDefImpl and EntityDefImpl.


getRowClass

public abstract java.lang.Class getRowClass()

createDef

protected void createDef()
This method should be used to perform custom-metadata initialization in a subclass of RowDef. The method is called as a notification that this definition object's metadata is loaded.

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.


getBaseComponentClass

public java.lang.Class getBaseComponentClass()

getColumnNameForQuery

public java.lang.String getColumnNameForQuery(int index)
Specified by:
getColumnNameForQuery in interface StructureDef

formatForOutput

public java.lang.String formatForOutput(OutputFormatter formatter)
Specified by:
formatForOutput in interface Formattable
Overrides:
formatForOutput in class NamedObjectImpl

getAltKeyAttrDefs

public AttributeDefImpl[] getAltKeyAttrDefs(java.lang.String keyName)

getAltKeyAttrDefs

public AttributeDefImpl[] getAltKeyAttrDefs(int keyIndex)

getAltKeyDef

public KeyDef getAltKeyDef(int keyIndex)

getAltKeyNames

public java.lang.String[] getAltKeyNames()

getAltKeyCount

public int getAltKeyCount()

findDefForDiscrValues

protected RowDef findDefForDiscrValues(java.lang.Object[] values,
                                       boolean recurse)

discrValuesQualify

protected boolean discrValuesQualify(java.lang.Object[] values)

lookupViewAccessorDef

public ViewAccessorDef lookupViewAccessorDef(java.lang.String name)

findViewAccessorDef

public ViewAccessorDef findViewAccessorDef(java.lang.String name)

addViewAccessorDef

public void addViewAccessorDef(ViewAccessorDef va)

getListBindingDefs

public ArrayList getListBindingDefs()

lookupListBindingDef

public ListBindingDef lookupListBindingDef(java.lang.String name)

findListBindingDef

public ListBindingDef findListBindingDef(java.lang.String name)

addListBindingDef

public void addListBindingDef(ListBindingDef lbDef)

setThrowOnListBindingMismatch

public void setThrowOnListBindingMismatch(boolean b)

throwOnListBindingMismatch

public boolean throwOnListBindingMismatch()

loadListBindings

protected void loadListBindings(org.kxml2.io.KXmlParser parser)

bindListBindings

protected void bindListBindings()

loadViewAccessor

protected ViewAccessorDef loadViewAccessor(org.kxml2.io.KXmlParser parser)

getComponentClass

public java.lang.Class getComponentClass()

setComponentClass

public void setComponentClass(java.lang.Class refClass)
Overrides:
setComponentClass in class MetaObject

setComponentInterfaceName

public void setComponentInterfaceName(java.lang.String interfaceName)

getComponentInterfaceName

public java.lang.String getComponentInterfaceName()

getClientProxyClassName

public java.lang.String getClientProxyClassName()

setClientProxyClassName

public void setClientProxyClassName(java.lang.String name)

getEffectiveClientProxyClassName

protected java.lang.String getEffectiveClientProxyClassName()

getEffectiveComponentInterfaceName

protected java.lang.String getEffectiveComponentInterfaceName()

loadFromXML

protected static void loadFromXML(org.kxml2.io.KXmlParser parser,
                                  oracle.jbo.server.RemotableCompDef defObj)

loadXMLContents

public void loadXMLContents(org.kxml2.io.KXmlParser parser,
                            java.lang.String fullName)
Overrides:
loadXMLContents in class PersistableDefObject

Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client
11g Release 1 (11.1.1)

E17503-02

Copyright © 2011, Oracle and/or its affiliates. All rights reserved.