|
Business Components | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.jbo.common.BaseObject | +--oracle.jbo.server.NamedObjectImpl | +--oracle.jbo.server.DefObject | +--oracle.jbo.server.RowDef | +--oracle.jbo.server.EntityDefImpl
Defines metadata for Entity Object classes.
Field Summary | |
static java.lang.String |
DBOBJ_TYPE_OBJTAB
|
static java.lang.String |
DBOBJ_TYPE_OBJTYP
|
static java.lang.String |
DBOBJ_TYPE_TABLE
|
static java.lang.String |
DBOBJ_TYPE_VIEW
|
protected java.util.Vector |
mAssocAccessors
The Association accessors for the Entity Object. |
protected java.util.Vector |
mAssocs
Association objects for this Entity Object. |
protected java.util.Vector |
mAttrAccessors
The Attribute accessors for the Entity Object. |
protected AttributeDefImpl[] |
mFKeys
List of attributes that comprise the foreign key. |
protected boolean |
mIsObjectTable
Determines if the current table is an Object Table. |
protected AttributeDefImpl |
mOIDAttribute
If entity is a OIDObject |
protected AttributeDefImpl[] |
mPrimaryKeys
List of attributes that comprise the primary key. |
protected java.lang.String |
mSource
Stores the name of the database source: the database entity for the Entity Object. |
protected java.lang.String |
mSourceType
Stores the database source type. |
Fields inherited from class oracle.jbo.server.DefObject |
mCompUsageList,
mCompUsages |
Fields inherited from class oracle.jbo.server.NamedObjectImpl |
mFullName,
mName,
mParent,
mProperties |
Fields inherited from class oracle.jbo.common.BaseObject |
TRACE_EVERY_ALLOC,
TRACE_NONE,
TRACE_OCCASIONAL,
TRACE_UNINITIALIZED |
Constructor Summary | |
protected |
EntityDefImpl()
Default Constructor, sets the row class. |
Method Summary | |
protected void |
addEntityAssociation(EntityAssociation assoc)
Internal: Applications should not use this method. |
protected void |
addPropertyChangeListener(int index,
PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list
for an attribute at the given index. |
protected void |
addPropertyChangeListener(java.lang.String attributeName,
PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list
for an attribute of the given Name. |
protected void |
addUniquePKValidation()
Adds validators to each primary key attribute of this Entity to ensure that the primary key for an Entity is always unique. |
protected void |
addVetoableChangeListener(int index,
VetoableChangeListener listener)
Adds a VetoableChangeListener to the listener list
for an attribute at the given index. |
protected void |
addVetoableChangeListener(java.lang.String attributeName,
VetoableChangeListener listener)
Adds a VetoableChangeListener to the listener list
for an attribute of the given name. |
protected void |
addVetoableChangeListener(VetoableChangeListener listener)
Adds a VetoableChangeListener to the listener list. |
protected EntityImpl |
createBlankInstance(DBTransaction txn)
Internal: Applications should not use this method. |
protected void |
createDef()
This method should be used to perform custom-metadata initialization in a subclass of EntityDefImpl. |
protected EntityImpl |
createInstance(DBTransaction txn,
AttributeList al)
Instantiate an instance of the Entity . |
Key |
createKey(AttributeList al)
Given a set of attribute values (name-value pairs), creates a Primary key object for this Entity. |
EntityImpl |
findByPrimaryKey(DBTransaction txn,
Key key)
Finds an Entity Object given a Primary Key. |
static EntityDefImpl |
findDefObject(java.lang.String defFullName)
Finds the named Entity Object definition. |
java.lang.String |
getAliasName()
Returns the alias that was declared for the Entity Object at Design-Time. |
oracle.jbo.server.java.util.Iterator |
getAllEntityInstances(DBTransaction tr)
Creates an iterator for stepping through instances of Entities of this definition object type. |
protected oracle.jbo.server.AssociationDefImpl |
getAssociationDefImpl(int index)
Returns the AssociationDefImpl (association accessors) given an index. |
protected oracle.jbo.server.AssociationDefImpl |
getAssociationDefImpl(java.lang.String name)
Returns the AssociationDefImpl (association accessors) given the association name. |
protected oracle.jbo.server.AssociationDefImpl[] |
getAssociationDefImpls()
Returns the AssociationDefImpls. |
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 |
getAttributeDefImplByColumnName(java.lang.String colName)
Given an attribute's column name, returns the attribute definition object. |
protected AttributeDefImpl[] |
getAttributeDefImpls()
Returns the AttributeDefImpls objects for this Entity Object. |
int |
getBindingStyle()
Returns the Oracle or JDBC binding style defined for this Entity definition. |
protected AttributeDefImpl |
getChangeIndicatorColumn()
Returns the AttributeDef for the Change Indicator column for the datasource. |
protected java.lang.Class |
getComponentClass()
Internal: Applications should not use this method. |
protected EntityAssociation[] |
getEntityAssociations()
Internal: Applications should not use this method. |
protected AttributeDefImpl[] |
getForeignKeyAttrs()
Returns the list of AttributeDefs that make the foreign key for the composition cases. |
static int |
getMaxAttrConst(java.lang.String entityName)
Returns the index of the last attribute for this entity at runtime. |
protected AttributeDefImpl |
getOIDAttribute()
Internal: Applications should not use this method. |
protected AttributeDefImpl[] |
getPrimaryKeys()
Returns the AttributeDef that defines the primary key attributes. |
java.lang.String |
getQuery()
Returns the query that will return all columns for this Entity. |
int |
getRefAttrIndex()
|
protected AttributeDefImpl[] |
getRetrievedOnInsertAttributes()
Returns the list of attributes for which the Refresh on Insert flag is enabled at Design Time. |
protected AttributeDefImpl[] |
getRetrievedOnInsertPrimaryKeys()
Returns the list of primary keys for which the Refresh on Insert flag is enabled at Design Time. |
protected AttributeDefImpl[] |
getRetrievedOnUpdateAttributes()
Returns the list of attributes for which the Refresh on Update flag is enabled at Design Time. |
protected AttributeDefImpl[] |
getRetrievedOnUpdatePrimaryKeys()
Returns the list of primary key attributes for which the Refresh on Update flag is enabled at Design Time. |
java.lang.Class |
getRowClass()
Gets the implementation class of instances of this Entity type. |
protected java.lang.String |
getSource()
Returns the name of the Database source table. |
protected java.lang.String |
getSourceType()
Internal: Applications should not use this method. |
protected boolean |
hasLOBAttrs()
Determines whether the EntityDef contains attributes that are LOBs. |
protected boolean |
isObjectTable()
Determines whether this is an Object table. |
protected boolean |
isOIDInPrimaryKey()
Determines whether the OID (object identifier) attribute is a primary key. |
boolean |
isRefPKBased()
|
protected boolean |
isRowIDPrimaryKey()
Determines whether this Entity Object has a ROWID attribute that is used as a primary key. |
protected boolean |
isUpdateChangedColumns()
Determines whether the SQL generation of UPDATE statements should include all of the columns or just the changed columns. |
protected void |
loadCustomDef(oracle.jbo.server.xml.JboElementImpl xmlElement)
Internal: Applications should not use this method. |
protected void |
removePropertyChangeListener(int index,
PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list
of the given attribute (by index). |
protected void |
removePropertyChangeListener(java.lang.String attributeName,
PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list
of the given attribute (by index). |
protected void |
removeVetoableChangeListener(int index,
VetoableChangeListener listener)
Removes a VetoableChangeListener from the listener list
of the given attribute (by index). |
protected void |
removeVetoableChangeListener(java.lang.String attributeName,
VetoableChangeListener listener)
Removes a VetoableChangeListener from the listener list
of the given attribute (by index). |
protected void |
removeVetoableChangeListener(VetoableChangeListener listener)
Removes a VetoableChangeListener from the listener list. |
void |
setBindingStyle(int bindingStyle)
Sets the Oracle or JDBC binding style defined for this Entity definition. |
void |
setRefPKBased(boolean val)
|
protected void |
setRowClass(java.lang.Class rowClass)
Internal: Applications should not use this method. |
protected void |
setSource(java.lang.String source)
Internal: Applications should not use this method. |
protected void |
setSourceType(java.lang.String sourceType)
Internal: Applications should not use this method. |
Methods inherited from class oracle.jbo.server.DefObject |
getPackageDef,
getPackageName,
isObjectResolved |
Methods inherited from class oracle.jbo.server.NamedObjectImpl |
getFullName,
getName,
getParent,
getProperties,
getPropertiesAsStrings,
getProperty,
refreshProperty,
setFullName,
setProperty |
Methods inherited from class oracle.jbo.common.BaseObject |
dumpState,
setTraceLevel,
setTraceWriter |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final java.lang.String DBOBJ_TYPE_TABLE
public static final java.lang.String DBOBJ_TYPE_VIEW
public static final java.lang.String DBOBJ_TYPE_OBJTYP
public static final java.lang.String DBOBJ_TYPE_OBJTAB
protected java.util.Vector mAttrAccessors
protected java.util.Vector mAssocAccessors
protected java.util.Vector mAssocs
protected AttributeDefImpl[] mFKeys
protected AttributeDefImpl[] mPrimaryKeys
protected AttributeDefImpl mOIDAttribute
protected java.lang.String mSource
protected java.lang.String mSourceType
protected boolean mIsObjectTable
Constructor Detail |
protected EntityDefImpl()
Method Detail |
public static EntityDefImpl findDefObject(java.lang.String defFullName)
This method takes the fully qualified name (package_name.Entity_name)
of an Entity definition
and returns the corresponding Entity definition object. This method can
be used to return only the Entity Object defintion object, instead of
the more
global methods in the MetaObjectManager
class.
The following example returns the EntityDef object associated with the Categories Entity in package1.
mDefinitionObject = (EntityDefImpl)EntityDefImpl.findDefObject("package1.Categories");
defFullName
- the fully qualified name of the definition.MetaObjectManager
protected void createDef()
Override this method to satisfy your application's specific custom properties for the Entity definition. For example, you would override this method if your application builds custom properties programatically based on user preferences.
Subclasses of EntityDefImpl should invoke
addUniquePKValidation()
in
this method to
add primary key validators. For example:
protected void createDef() { addUniquePKValidation(); }By default, the framework does not invoke the unique key check.
addUniquePKValidation()
protected EntityAssociation[] getEntityAssociations()
Returns an array of Entity Association objects for this Entity.
protected void addEntityAssociation(EntityAssociation assoc)
Adds an Entity Association to this Entity.
assoc
- the entity assocition to be added.public AttributeDefImpl getAttributeDefImpl(java.lang.String attrName)
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.
attrName
- the specified Entity attribute.public AttributeDefImpl getAttributeDefImpl(int index)
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.
index
- the attribute's database column position, where the
leftmost column has index 0.protected AttributeDefImpl getAttributeDefImplByColumnName(java.lang.String colName)
This method takes the Entity attribute's database colunm name and returns the corresponding attribute definition object. For example, use this method to get the attribute definition object to store custom properties.
colName
- the name of the attribute's column in the database.protected AttributeDefImpl[] getAttributeDefImpls()
protected oracle.jbo.server.AssociationDefImpl getAssociationDefImpl(java.lang.String name)
name
- the name of the association.protected oracle.jbo.server.AssociationDefImpl getAssociationDefImpl(int index)
index
- of the association attribute.protected oracle.jbo.server.AssociationDefImpl[] getAssociationDefImpls()
protected java.lang.String getSource()
This method could be overridden if, for example, your application implements table generator code at runtime.
protected void setSource(java.lang.String source)
Sets the name of the Database source table.
source
- the name of database table corresponding to this business
object.protected boolean isObjectTable()
This method returns true if this table is:
protected java.lang.String getSourceType()
Returns the name of the database source type.
protected void setSourceType(java.lang.String sourceType)
Sets the name of the Database source type.
name
- the type of database source.public oracle.jbo.server.java.util.Iterator getAllEntityInstances(DBTransaction tr)
tr
- the transaction containing the Entity Objects.public java.lang.Class getRowClass()
public EntityImpl findByPrimaryKey(DBTransaction txn, Key key)
Given the name of the databse transaction and the table's primary key, this method returns the associated Entity Object. If the Entity has not already been brought into the cache by any of the View Objects, this method will cause the Entity to be fetched from the database.
This method returns null if the Entity Object is not found.
txn
- the transaction containing the Entity Object.key
- the Primary Key.public Key createKey(AttributeList al)
protected EntityImpl createInstance(DBTransaction txn, AttributeList al)
Entity
.
The default values of the entity attributes are filled in in this method.
Override this method to create instances of composite Entities.
txn
- the DBTransaction instance for the Entity.al
- List of attribute name/value pairs to be passed to
Entity.create()EntityImpl.create(AttributeList)
protected EntityImpl createBlankInstance(DBTransaction txn)
Internal method invoked whenever an Entity of this type is created within the framework.
txn
- the Database Transaction Object.protected void setRowClass(java.lang.Class rowClass)
Set the class to represent instances of this Entity.
rowClass
- the row data class.protected java.lang.Class getComponentClass()
Returns the class of the reference object.
protected AttributeDefImpl[] getForeignKeyAttrs()
protected AttributeDefImpl[] getPrimaryKeys()
protected AttributeDefImpl getOIDAttribute()
Returns the object identifier attribute (OID). This method is used to return attributes that are Oracle Objects.
protected AttributeDefImpl[] getRetrievedOnInsertAttributes()
protected AttributeDefImpl[] getRetrievedOnUpdateAttributes()
protected AttributeDefImpl[] getRetrievedOnInsertPrimaryKeys()
protected AttributeDefImpl[] getRetrievedOnUpdatePrimaryKeys()
protected AttributeDefImpl getChangeIndicatorColumn()
The Change Indicator column is used, in some applications, to indicate changes in the underlying row in the datastore. It usually takes the form of a Timestamp or a Counter and, is compared at change time, against the value in the cache, to check for consistency.
protected boolean isUpdateChangedColumns()
The return value of this flag indicates whether the SQL Generation of UPDATE statements should include all of the columns or just the changed columns. If this method returns true then only the updated columns will be included, otherwise the method will include all of the columns that are present.
public java.lang.String getQuery()
protected void addPropertyChangeListener(int index, PropertyChangeListener listener)
PropertyChangeListener
to the listener list
for an attribute at the given index.
This method modifies the static/singleton metadata.
index
- the index of the attribute to which the listener is to be added.listener
- the PropertyChangeListener
to be added.PropertyChangeListener
protected void addPropertyChangeListener(java.lang.String attributeName, PropertyChangeListener listener)
PropertyChangeListener
to the listener list
for an attribute of the given Name.
This method modifies the static/singleton metadata.
attributeName
- the name of the attribute to which the listener
is to be added.listener
- the PropertyChangeListener
to be added.PropertyChangeListener
protected void removePropertyChangeListener(int index, PropertyChangeListener listener)
PropertyChangeListener
from the listener list
of the given attribute (by index).
This method modifies the static/singleton metadata.
listener
- the PropertyChangeListener to be removed.PropertyChangeListener
protected final void removePropertyChangeListener(java.lang.String attributeName, PropertyChangeListener listener)
PropertyChangeListener
from the listener list
of the given attribute (by index).
This method modifies the static/singleton metadata.
attributeName
- the attribute to which the listener is to be added.listener
- the PropertyChangeListener
to be removed.PropertyChangeListener
protected void addVetoableChangeListener(VetoableChangeListener listener)
VetoableChangeListener
to the listener list.
This method modifies the static/singleton metadata.
listener
- the VetoableChangeListener
to be added.VetoableChangeListener
protected void addVetoableChangeListener(int index, VetoableChangeListener listener)
VetoableChangeListener
to the listener list
for an attribute at the given index. Use this method to add a validator
to an attribute.
This method modifies the static/singleton metadata.
index
- the index of the attribute to which the listener is to be added.listener
- the VetoableChangeListener
to be added.VetoableChangeListener
protected void addVetoableChangeListener(java.lang.String attributeName, VetoableChangeListener listener)
VetoableChangeListener
to the listener list
for an attribute of the given name.
This method modifies the static/singleton metadata.
attributeName
- the attribute to which the listener is to be added.listener
- the VetoableChangeListener
to be added.VetoableChangeListener
protected void removeVetoableChangeListener(VetoableChangeListener listener)
VetoableChangeListener
from the listener list.
This method modifies the static/singleton metadata.
listener
- the VetoableChangeListener
to be removed.VetoableChangeListener
protected void removeVetoableChangeListener(int index, VetoableChangeListener listener)
VetoableChangeListener
from the listener list
of the given attribute (by index).
This method modifies the static/singleton metadata.
index
- the index of the attribute from which the listener is to be removed.listener
- the VetoableChangeListener
to be removed.VetoableChangeListener
protected final void removeVetoableChangeListener(java.lang.String attributeName, VetoableChangeListener listener)
VetoableChangeListener
from the listener list
of the given attribute (by index).
This method modifies the static/singleton metadata.
attributeName
- the attribute to which the listener is to be added.listener
- the VetoableChangeListener
to be removed.VetoableChangeListener
public java.lang.String getAliasName()
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 boolean isRefPKBased()
public void setRefPKBased(boolean val)
public int getRefAttrIndex()
protected boolean isRowIDPrimaryKey()
protected boolean isOIDInPrimaryKey()
protected void addUniquePKValidation()
Whenever any of the primary key attribute values change, this validation
rule is invoked to validate, both in the cache and the database, that the
new key does not belong to any other
Entity of this type. If the key is
found in one of the Entities,
a TooManyObjectsException
is
thrown.
Subclasses should invoke this method in their createDef() method to add these validators. By default, the framework does not invoke the unique key check. For example, you can add a validator to look for duplicate keys. To do this, follow these instructions:
protected void createDef() { addUniquePKValidation(); }This enables validation to check if the modified primary key value exists in either the database or the cache.
Note that there is no Design-Time equivalent for this method.
createDef()
,
TooManyObjectsException
protected void loadCustomDef(oracle.jbo.server.xml.JboElementImpl xmlElement) throws PersistenceException
Loads a custom Entity definition from the associated XML file. For example, add custom attributes or additional metadata to an Entity's XML file. Then use this method to load the new definition of the Entity definition.
Typically, a call to createDef() follows this method.
xmlElement
- the root XML node for the Entity.createDef()
protected boolean hasLOBAttrs()
This method is used by
doDML
to determine if the EntityDef contains LOB attributes. If it does,
doDML calls
doDMLWithLOBs
to process the DML request. For example:
protected void doDML(int operation, TransactionEvent e) { if (!getEntityDef().hasLOBAttrs()) { getSQLBuilder().doEntityDML(this,operation,e); } else { doDMLWithLOBs(operation, e); } }Developers who implement doDML() to handle the two-phase insert and update process, should override hasLOBAttrs() in the EntityDefImpl subclass and return false. This will cause doDML() to work properly with the current release.
doDML
,
doDMLWithLOBs
public static int getMaxAttrConst(java.lang.String entityName)
The framework's Extends feature lets developers add information, such as additional attributes and validation, to an existing Entity. The additional attributes are "appended" to the original Entity's list of attributes. The framework adds this method to the generated extended Entity's *Impl file and uses it at runtime to determine the index of the last attribute belonging to the original Entity. All of the attributes with index greater than this number belong to the extended Entity.
The following code snippet represents part of the class definition of the *Impl file generated by the framework for the extended Entity Object newEmp:
public class newEmpImpl extends package27.EmpImpl { protected static final int MAXATTRCONST = EntityDefImpl.getMaxAttrConst("package27.Emp"); ...The getMaxAttrConst method returns the index of the last attribute from the EntityDefImpl belonging to the original Entity Emp in package27. The result is stored in the constant MAXATTRCONST. This constant is used in calculations later in the file.
entityName
- the name of the Entity for which the index of the
last attribute is retrieved.
|
Business Components | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |