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

E17483-01

oracle.jbo.common
Class StructureDefHelper

java.lang.Object
  extended by oracle.jbo.common.StructureDefHelper
All Implemented Interfaces:
StructureDef
Direct Known Subclasses:
StructureDefImpl

public class StructureDefHelper
extends java.lang.Object
implements StructureDef

Internal: Applications should not use this class.


Field Summary
protected  AttributeDef[] attributeList
           
protected  java.util.Hashtable attributes
           
protected  java.lang.String mDefFullName
           
protected  java.lang.String mDefName
           
protected  java.lang.String mFullName
           
protected  java.lang.String mName
           
 
Constructor Summary
StructureDefHelper()
           
 
Method Summary
 AttributeDef addDynamicAttribute(java.lang.String name, int index)
           
 AttributeDef addViewLinkAccessor(java.lang.String name, int index)
           
 AttributeDef findAttributeDef(java.lang.String attrName)
          Gets an attribute definition, given its name.
 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.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).
 java.lang.String getFullName()
          Returns the structure's fully qualified name.
 java.lang.String getName()
          Returns the structure's name (short form).
protected  AttributeDefHelper getNewAttributeDefHelper()
           
 AttributeDef lookupAttributeDef(java.lang.String name)
          Gets an attribute definition, given its name.
 void removeViewLinkAccessor(AttributeDef accr)
           
 void setName(java.lang.String name)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mName

protected java.lang.String mName

mFullName

protected java.lang.String mFullName

mDefName

protected java.lang.String mDefName

mDefFullName

protected java.lang.String mDefFullName

attributes

protected java.util.Hashtable attributes

attributeList

protected AttributeDef[] attributeList
Constructor Detail

StructureDefHelper

public StructureDefHelper()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: StructureDef
Returns the structure's name (short form).

Specified by:
getName in interface StructureDef
Returns:
name of the structure.

getFullName

public java.lang.String getFullName()
Description copied from interface: StructureDef
Returns the structure's fully qualified name.

Specified by:
getFullName in interface StructureDef
Returns:
fully qualified name of the structure.

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.

setName

public void setName(java.lang.String name)

getAttributeDefs

public AttributeDef[] getAttributeDefs()
Description copied from interface: StructureDef
Gets the defined attributes.

Specified by:
getAttributeDefs in interface StructureDef
Returns:
an array of attribute definitions.

getAttributeCount

public int getAttributeCount()
Description copied from interface: StructureDef
Returns the number of defined attributes.

Specified by:
getAttributeCount in interface StructureDef
Returns:
the number of attributes.

findAttributeDef

public AttributeDef findAttributeDef(java.lang.String attrName)
Description copied from interface: StructureDef
Gets an attribute definition, given its name.

Specified by:
findAttributeDef in interface StructureDef
Parameters:
attrName - the name of an AttributeDef.
Returns:
an attribute definition

lookupAttributeDef

public AttributeDef lookupAttributeDef(java.lang.String name)
Description copied from interface: StructureDef
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)
Description copied from interface: StructureDef
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

getNewAttributeDefHelper

protected AttributeDefHelper getNewAttributeDefHelper()

addDynamicAttribute

public AttributeDef addDynamicAttribute(java.lang.String name,
                                        int index)

addViewLinkAccessor

public AttributeDef addViewLinkAccessor(java.lang.String name,
                                        int index)

removeViewLinkAccessor

public void removeViewLinkAccessor(AttributeDef accr)

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

E17483-01

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