EntityImpl (Oracle Fusion Middleware Java API Reference for Oracle ADF Mobile Client)

Overview

Package

Class

Tree

Deprecated

Index

Help

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

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.jbo.server
Class EntityImpl

java.lang.Object
  oracle.jbo.server.RowImpl
      oracle.jbo.server.EntityImpl

All Implemented Interfaces:: AttributeList, DomainOwnerInterface, JIReservedVarNames, ExprValueSupplier, JboReservedVarNames, Row, Entity, TransactionListener, TransactionPostListener, ValidationListener, ValidationManager

public class EntityImpl
extends RowImpl
implements Entity, DomainOwnerInterface
extends RowImpl
implements Entity, DomainOwnerInterface

Entity represents data from the datastore and the methods required to sync this data with the datastore.

Field Summary
`static java.lang.Class`	`CLASS_INSTANCE`
`static int`	`DML_DELETE` Identifies that a Delete operation is to be performed in the `doDML()` method.
`static int`	`DML_INSERT` Identifies that an Insert operation is to be performed in the `doDML()` method.
`static int`	`DML_UPDATE` Identifies that an Update operation is to be performed in the `doDML()` method.
`protected static java.lang.String`	`ORACLE_ROWID_COLUMN` Identifies the column name for ROWID columns in a table.

Fields inherited from interface oracle.jbo.server.Entity
`STATUS_DEAD, STATUS_DELETED, STATUS_MODIFIED, STATUS_UNMODIFIED`

Fields inherited from interface oracle.jbo.Row
`EFFDT_DELETE_FUTURE_CHANGE_MODE, EFFDT_DELETE_MODE, EFFDT_DELETE_NEXT_CHANGE_MODE, EFFDT_DELETE_ZAP_MODE, EFFDT_EXPERT_MODE, EFFDT_NONE_MODE, EFFDT_UPDATE_CHANGE_INSERT_MODE, EFFDT_UPDATE_CORRECTION, EFFDT_UPDATE_MODE, EFFDT_UPDATE_OVERRIDE_MODE, REFRESH_CONTAINEES, REFRESH_FORGET_NEW_ROWS, REFRESH_REMOVE_NEW_ROWS, REFRESH_UNDO_CHANGES, REFRESH_WITH_DB_FORGET_CHANGES, REFRESH_WITH_DB_ONLY_IF_UNCHANGED, STATUS_INITIALIZED, STATUS_NEW`

Fields inherited from interface oracle.jbo.Row

EFFDT_DELETE_FUTURE_CHANGE_MODE, EFFDT_DELETE_MODE, EFFDT_DELETE_NEXT_CHANGE_MODE, EFFDT_DELETE_ZAP_MODE, EFFDT_EXPERT_MODE, EFFDT_NONE_MODE, EFFDT_UPDATE_CHANGE_INSERT_MODE, EFFDT_UPDATE_CORRECTION, EFFDT_UPDATE_MODE, EFFDT_UPDATE_OVERRIDE_MODE, REFRESH_CONTAINEES, REFRESH_FORGET_NEW_ROWS, REFRESH_REMOVE_NEW_ROWS, REFRESH_UNDO_CHANGES, REFRESH_WITH_DB_FORGET_CHANGES, REFRESH_WITH_DB_ONLY_IF_UNCHANGED, STATUS_INITIALIZED, STATUS_NEW

Fields inherited from interface oracle.jbo.JboReservedVarNames
`RESERVED_VAR_AGG_AVG, RESERVED_VAR_AGG_COUNT, RESERVED_VAR_AGG_MAX, RESERVED_VAR_AGG_MIN, RESERVED_VAR_AGG_SUM, RESERVED_VAR_AGGVAL_PREFIX, RESERVED_VAR_STRUCTURE_DEF`

Fields inherited from interface oracle.jbo.expr.JIReservedVarNames
`RESERVED_VAR_VALUE`

Constructor Summary
`EntityImpl()` Internal: Applications should not use this constructor.

Method Summary
`protected void`	`addToTransactionManager()` Adds this Entity object to its transaction manager (either another Entity object based on the containership model, or the transaction object for this session).
`void`	`addToValidationListeners(ValidationListener w)` Adds a validation listener.
`void`	`addTransactionPostListener(TransactionPostListener listener)`
`void`	`addTransactionPostListenerNoCheck(TransactionPostListener listener)`
`void`	`afterCommit(TransactionEvent e)` Called to report that a Commit operation has occurred.
`void`	`afterRemove(TransactionEvent e)` A cleanup routine to be invoked by transaction manager when this transaction listener is removed from the manager's list.
`void`	`afterRollback(TransactionEvent e)` Internal: Applications should not call this method.
`void`	`beforeCommit(TransactionEvent e)` Polls transaction listeners before a commit operation.
`void`	`beforeRollback(TransactionEvent e)` Polls transaction listeners before a rollback operation.
`protected int`	`bindDMLStatement(int operation, PreparedStatement stmt, AttributeDefImpl[] allAttrs, AttributeDefImpl[] retCols, AttributeDefImpl[] retKeys, Map retrList, boolean batchMode)` Advanced: Most applications should not use this method. This method binds current attribute values to the given jdbc PreparedStatement.
`protected int`	`bindWhereClause(PreparedStatement stmt, AttributeDefImpl[] keyCols, java.lang.Object rowid, int bindIndex)` Bind the Primary key values for the designated Statement.
`protected java.lang.StringBuffer`	`buildDMLStatement(int operation, AttributeDefImpl[] allAttrs, AttributeDefImpl[] retCols, AttributeDefImpl[] retKeys, boolean batchMode)` Advanced: Most applications should not use this method. This method constructs the DML statement and returns it as a StringBuffer.
`protected AttributeDefImpl[]`	`buildRefreshSQL(java.lang.StringBuffer sqlBuffer, int operation, AttributeDefImpl[] columns, AttributeDefImpl[] retKeycols, boolean withInto)` Builds the sql SELECT statement to fetch refresh-on-insert or update attributes and uses getRefreshSQLKeyAttrs() to create WHERE clause for this SELECT statement.
`protected void`	`buildWhereClause(java.lang.StringBuffer buffer, AttributeDefImpl[] keyCols, java.lang.Object rowid)` Construct a SQL WHERE clause for the Entity into the designated Buffer.
`protected boolean`	`checkConsistency(SparseArray target, boolean lock)` Override this method to speed up comparing the attribute values of fetched entity data with this entity's data.
`protected void`	`clearAllExceptions()`
`protected void`	`clearAttributeException(int index)` Cleans any exception of an attribute of the given name was set earlier and threw an exception which was cached as the transaction is in deferred mode.
`protected boolean`	`compare(SparseArray target)` Compares the data in this row with that of another.
`protected void`	`create(AttributeList nameValuePair)` This method should be subclassed to supply programmatic default values to various attributes of a new Entity Object.
`protected EntityRowSetImpl`	`createAssociationAccessorRS(AssociationDefImpl assocDef, ViewObjectImpl accessorVO, Row masterRow, java.lang.Object[] values)`
`protected ViewObjectImpl`	`createAssociationAccessorVO(AssociationDefImpl assocDef, java.lang.String voName, EntityAssociation eoAssoc)`
`protected ViewRowSetImpl`	`createEntityViewLinkAccessorRS(AssociationDefImpl assocDef, ViewObjectImpl accessorVO, Row masterRow, java.lang.Object[] values)`
`protected ViewObjectImpl`	`createEntityViewLinkAccessorVO(AssociationDefImpl assocDef, java.lang.String voName, ViewDefImpl vDef, ViewLinkDefImpl vlDef)`
`protected RowSet`	`createViewAccessorRS(java.lang.String vaName)` Internal: Applications should not use this method.
`protected RowSet`	`createViewAccessorRS(ViewAccessorDef va)` Internal: Applications should not use this method.
`protected void`	`doDML(int operation, TransactionEvent e)` Performs INSERT/UPDATE/DELETE processing for the row.
`protected void`	`doDMLForCascadeUpdate(TransactionEvent e, List tpl, List ecList, boolean startingEntity)` Advanced method: Applications should typically not use this method.
`protected void`	`doDMLWithLOBs(int operation, TransactionEvent e)` Performs INSERT/UPDATE/DELETE processing for Entity Objects that contain LOBs.
`void`	`domainToBeModified(DomainInterface d)` Notification method that this domain calls whenever any of its attribute values are about to be modified.
`protected void`	`donePostingAll(TransactionEvent e)`
`protected void`	`doRefreshSQL(int operation, List refreshAttrs)` This method is called after the entity is posted to the database to refresh the required attributes.
`protected void`	`doSelect(boolean lock)` Advanced: Most applications should not use this method.
`protected void`	`doSelectForAltKey(int keyIndex)`
`boolean`	`eventsDebugOnly()` Indicates whether events are being tested.
`protected ViewObjectImpl`	`findAssociationAccessorVO(AssociationDefImpl assocDef, java.lang.String voName, EntityAssociation eoAssoc)`
`protected ViewObjectImpl`	`findEntityViewLinkAccessorVO(AssociationDefImpl assocDef, java.lang.String voName, ViewDefImpl vDef, ViewLinkDefImpl vlDef)`
`RowSet`	`findOrCreateViewAccessorRS(java.lang.String vaName)` Internal: Applications should not use this method.
`RowSet`	`findOrCreateViewAccessorRS(ViewAccessorDef va)` Internal: Applications should not use this method.
`ViewAccessorDef`	`findViewAccessorDef(java.lang.String name)` This method returns `ViewAccessorDef` with the specified name.
`protected ViewObject`	`findViewAccessorVO(ViewAccessorDef va)` Internal: Applications should not use this method.
`protected ArrayList`	`getAllExceptions()`
`Key`	`getAltKey(int keyIndex)`
`java.lang.Object`	`getAttribute(int index)` Get an attribute value by index
`java.lang.Object`	`getAttribute(java.lang.String name)` Returns the value of the named attribute, given a string value.
`int`	`getAttributeCount()` Counts the number of attributes in this Entity Object.
`int`	`getAttributeIndexOf(java.lang.String name)` Finds the index of the named attribute.
`protected java.lang.Object`	`getAttributeInternal(int index)` Gets the attribute value by index.
`java.lang.String[]`	`getAttributeNames()` Gets a list of the names of all attributes
`protected java.lang.Object`	`getAttributeValue(AttributeDefImpl attr)` Internal: Applications should not use this method.
`java.lang.Object[]`	`getAttributeValues()` Gets a list of the values of all attributes
`protected java.lang.Object`	`getAttrInvokeAccessor(int index, AttributeDefImpl attrDef)`
`int`	`getBaseAttributeCount()`
`protected EntityImpl`	`getContainerEntity()` Returns this entity's container in a composition association if any.
`DBTransaction`	`getDBTransaction()` Retrieves this Entity Object's database transaction.
`protected int`	`getDynamicAttributeCount()`
`protected java.lang.Object`	`getDynamicAttributeValue(int dynAttrIndex)`
`EntityCache`	`getEntityCache()` A Convenience for writing a lot of code.
`protected EntityDefImpl`	`getEntityDef()` Gets the Entity Definition Object which governs the structure of this Entity Object.
`byte`	`getEntityState()` Gets this Entity Object's current Entity-state in the transaction.
`protected java.lang.Object`	`getHistoryContextForAttribute(AttributeDefImpl attr)`
`Key`	`getKey()` Returns the row's key.
`protected RowSetIterator`	`getListBindingRSI(ListBindingDef def)`
`protected List`	`getListBindings()`
`protected java.lang.Object`	`getOrigData(int index)`
`protected java.lang.Object`	`getPKBasedRef(AttributeDefImpl attr)`
`protected java.lang.Object`	`getPostedAttribute(int index)` Gets the value originally read for this attribute from the database.
`byte`	`getPostState()` Returns this Entity Object's current post-state in the transaction.
`Key`	`getPrimaryKey()` Returns the primay key for this Entity Object's row.
`protected AttributeDefImpl[]`	`getRefreshSQLKeyAttrs(int operation)` Returns an array of AttributeDefImpl containing attributes that should be used in the where-clause (as key columns) when a select statement is executed to fetch refresh-on attributes.
`protected SQLBuilder`	`getSQLBuilder()` Get the SQLBuilderImpl which performs all SQL operations required by this Entity Object.
`StructureDef`	`getStructureDef()` Get the underlying EntityDef that defines the structure of this row
`protected List`	`getTransactionListenersList()` Returns a copy of the list of "detail" Entities associated to this Entity Object by a composition association, participating in a transaction post and commit operations.
`int`	`getTransPostHandle()` Advanced: Most applications should not use this method.
`protected void`	`handleEffectiveDateOperations()` Before posting the row to the database this method is invoked for effective date book-keeping.
`protected void`	`handleListBindingMismatch(ListBinding lb, Map valuesMap, RowIterator listRSI)`
`protected void`	`handlePostChangesError()` Called when a problem occurs while posting changes and restores an `EntityImpl`'s state.
`protected boolean`	`hasAttributeException(int index)` Returns true if an attribute at the given index was set earlier and threw an exception which was cached as the transaction is in deferred mode.
`protected boolean`	`hasListBindings()`
`protected boolean`	`hasUpdatePrivilege(int index)`
`protected void`	`initBusLogicGroupDefaults()`
`protected void`	`initBusLogicGroupDfltExprAttrs(AttributeList nameValuePair)`
`protected SparseArrayInterface`	`initData(int attrsCount)`
`protected void`	`initDefaultExpressionAttributes(AttributeList nameValuePair)` Used to initialize this entity with values from evaluated expressions on the attributedefs.
`protected void`	`initDefaults()` Initialize Entity row's default values.
`protected void`	`initialize()`
`protected boolean`	`isAttributeChanged(int index)` Determines whether the attribute at the index been been changed.
`protected boolean`	`isAttributeChangedInTransaction(int index)` Advanced method: Applications should typically not use this method.
`protected boolean`	`isAttributePopulated(int index)` Determines whether the attribute at the specified index position is populated.
`boolean`	`isAttributeUpdateable(int index)` Checks if the attribute is updateable.
`boolean`	`isDead()` Tests this row to determine if it is dead
`boolean`	`isDirty(int i)`
`boolean`	`isInCache()`
`boolean`	`isInvalid()` Returns whether this Entity Object is invalid.
`boolean`	`isLocked()` Determines whether this Entity Object is locked.
`protected boolean`	`isOrigDataPopulated(int index)`
`boolean`	`isPostedToDB()` Advanced: Most applications should not use this method. For non-oracle databases, indicates if this entity is posted.
`boolean`	`isTransientTransactionListener()` Tests whether this Entity Object's transaction listener is transient or permanent.
`boolean`	`isTransientTransactionPostListener()` Tests whether this Entity Object's `TransactionPostListener` is transient or permanent.
`boolean`	`isValid()` Returns whether this Entity Object is valid.
`void`	`lock()` Locks the row.
`protected void`	`lockTopLevelEntity()` Locks the top-most Entity Object by getting the master Entity Object defined by composition associations, and walking-up the chain of containership.
`protected void`	`notifyAttributesAndBlgChanged(int[] attrIndices, java.lang.Object[] values, boolean blg)`
`protected void`	`notifyAttributesChanged(int[] attrIndices, java.lang.Object[] values)`
`protected void`	`notifyAttributesChanged(int[] attrIndices, java.lang.Object[] values, boolean markQCDirty)`
`void`	`outputEventString(EventInvocation event)`
`protected void`	`populateAttribute(int index, java.lang.Object value)` Advanced method: Applications should not use this method.
`void`	`populateAttribute(int index, java.lang.Object value, boolean sendNotification, boolean markAsChanged, boolean saveOriginal)` Advanced method: Applications should typically not use this method.
`protected void`	`populateAttributeAsChanged(int index, java.lang.Object value)` Advanced method: Applications should typically not call this method from their subclasses other then when performing programmatic attribute defaulting with proper attribute values.
`void`	`postChanges(TransactionEvent e)` Initiates a post operation for this Entity Object.
`protected void`	`prepareForBatchDML(int operation, TransactionEvent te)` Advanced: Most applications should not use this method. A pre-doDML() step which calls prepareForDML() with the appropriate operation so that applications can perform attribute updates like history column etc.
`protected void`	`prepareForDML(int operation, TransactionEvent e)` A pre-doDML() notification that allows subclasses to modify any attributes on this entity that should be updated in the database.
`void`	`refresh(int refreshMode)` Refreshes the row's attributes with values from database.
`protected void`	`refreshFKInNewContainees()` This method is invoked by SQLBuilder when one or more of the PrimaryKey attributes are marked refresh-on-insert and DML for this entity has been executed.
`protected void`	`registerAttributeException(AttributeDef attrDef, java.lang.Object val, JboException ex)`
`void`	`remove()` Removes the row from the database table.
`void`	`removeAndRetain()` An Entity row does not support `removeAndRetain().`
`void`	`removeFromCollection()` Removes the row from the collection.
`void`	`removeTransactionPostListener(TransactionPostListener listener)` Internal: Applications should not use this method.
`protected void`	`resetPKBasedRef()`
`void`	`revert()` Reverts this Entity Object's row to the database's values.
`void`	`setAttribute(int index, java.lang.Object val)` Sets the value of an attribute, given its index position.
`void`	`setAttribute(java.lang.String name, java.lang.Object val)` Sets the value of the named attribute, given its name.
`protected void`	`setAttributeChanged(int index, boolean flag)`
`protected void`	`setAttributeInternal(int index, java.lang.Object val)` Validates and sets the value of an attribute by index.
`void`	`setAttributeValues(List names, List values)` Set attribute values for the given list of attributes names.
`protected void`	`setAttrInvokeAccessor(int index, java.lang.Object val, AttributeDefImpl attrDef)`
`protected void`	`setDynamicAttributeValue(int dynAttrIndex, java.lang.Object value)`
`protected void`	`setEntityDef(EntityDefImpl entityDef)`
`protected void`	`setInvalid()` A helper method that marks this Entity Object invalid and adds it to the ValidationListeners list of the validation manager to which this Entity Object belongs.
`protected void`	`setLocked(boolean lockedState)` Sets the locked state.
`void`	`setNewRowState(byte state)` Advanced method: Applications should not use this method. Internal method used by ViewRowImpl.setNewRowState() to make all entities that belong to that new row as new or initialized.
`void`	`setPostedToDB(boolean b)` Advanced: Most applications should not use this method. For non-oracle databases that do not support savepoint, this method should be called from the custom sql builder to mark the entity as posted so that it's not posted again during a subsequent post cycle (if this entity was already posted but other entity/entities led to an exception in the current post cycle.
`void`	`setTransPostHandle(int hdl)` Advanced: Most applications should not use this method.
`void`	`validate()` Validate this Entity Object.
`void`	`validateDateEffectivity()` Validates the Effective Date aspects of an Entity to ensure that gaps or overlaps are not introduced.
`protected void`	`validateEntity()` Validates the Entities and other listeners that are members of ValidationListeners list.
`protected void`	`vetoRemoveWithDetails(AttributeDef associationDef)` If this Entity Object is a master in a composition association, this method checks that all details have already been removed from the given association attribute.

Methods inherited from class oracle.jbo.server.RowImpl
`addListBindingsForAttribute, clearAttributeException, doSetAttribute, doSetAttribute, findAttrAndGetIndex, getAttributeNameOf, getChangedAttributeDefImpls, getCombinedAttrNames, getEffectiveDate, getEffectiveDateMode, getExprVarVal, getInsertAttributeDefImpls, getStateAsString, init, isRefreshRequired, isRefreshRequired, isRefreshRequired, markViewAccessorsDirty, refreshViewAccessor, refreshViewAccessor, refreshViewAccessor, reserve, setEffectiveDateMode, setExprVarVal, setInMultiSetter`

Methods inherited from class oracle.jbo.server.RowImpl

addListBindingsForAttribute, clearAttributeException, doSetAttribute, doSetAttribute, findAttrAndGetIndex, getAttributeNameOf, getChangedAttributeDefImpls, getCombinedAttrNames, getEffectiveDate, getEffectiveDateMode, getExprVarVal, getInsertAttributeDefImpls, getStateAsString, init, isRefreshRequired, isRefreshRequired, isRefreshRequired, markViewAccessorsDirty, refreshViewAccessor, refreshViewAccessor, refreshViewAccessor, reserve, setEffectiveDateMode, setExprVarVal, setInMultiSetter

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface oracle.jbo.Row
`getEffectiveDateMode, setEffectiveDateMode`

Field Detail

DML_INSERT

public static final int DML_INSERT

Identifies that an Insert operation is to be performed in the doDML() method.

See Also:: Constant Field Values

DML_UPDATE

public static final int DML_UPDATE

Identifies that an Update operation is to be performed in the doDML() method.

See Also:: Constant Field Values

DML_DELETE

public static final int DML_DELETE

Identifies that a Delete operation is to be performed in the doDML() method.

See Also:: Constant Field Values

ORACLE_ROWID_COLUMN

protected static final java.lang.String ORACLE_ROWID_COLUMN

Identifies the column name for ROWID columns in a table.

CLASS_INSTANCE

public static final java.lang.Class CLASS_INSTANCE

Constructor Detail

EntityImpl

public EntityImpl()

Internal: Applications should not use this constructor.

Creates an Entity Object instance. Note that initialization of most of the internal state attributes are performed in the init method invoked by the framework after an instance of this class is created. Most applications need not invoke this constructor directly.

Method Detail

initialize

protected void initialize()

setEntityDef

protected void setEntityDef(EntityDefImpl entityDef)

getAttributeIndexOf

public int getAttributeIndexOf(java.lang.String name)

Finds the index of the named attribute.

Specified by:: getAttributeIndexOf in interface AttributeList
Overrides:: getAttributeIndexOf in class RowImpl

Parameters:: name - an attribute name.
Returns:: the index associated with name.
Throws:: NoDefException - if this Entity Object does not have an attribute of the given name.

getKey

public Key getKey()

Description copied from class: RowImpl

Returns the row's key.

Specified by:: getKey in interface Row
Specified by:: getKey in class RowImpl

Returns:: the row's Key.

getStructureDef

public StructureDef getStructureDef()

Get the underlying EntityDef that defines the structure of this row

Specified by:: getStructureDef in interface Row
Specified by:: getStructureDef in class RowImpl

Returns:: A StructureDef

getEntityDef

protected EntityDefImpl getEntityDef()

Gets the Entity Definition Object which governs the structure of this Entity Object. This method should not be overridden.

Returns:: the EntityDefImpl.

hasUpdatePrivilege

protected boolean hasUpdatePrivilege(int index)

isAttributeUpdateable

public boolean isAttributeUpdateable(int index)

Checks if the attribute is updateable. This method finds the attribute, given its index, then examines its updateable status which can be READ_ONLY, UPDATEABLE_WHILE_NEW, or UPDATEABLE.

This method can be overridden. For example, override this method if you want to check the updateable status and you have dependencies between two or more attributes.

Specified by:: isAttributeUpdateable in interface Row
Specified by:: isAttributeUpdateable in class RowImpl

Parameters:: index - the attribute's index (0-based).
Returns:: false if the attribute is READ_ONLY; true if attribute is UPDATEABLE or if the attribute is UPDATEABLE_WHILE_NEW and the current row is new.

isDead

public boolean isDead()

Description copied from class: RowImpl

Tests this row to determine if it is dead

Specified by:: isDead in interface Row
Specified by:: isDead in class RowImpl

Returns:: true if row is dead, false otherwise.

getAllExceptions

protected ArrayList getAllExceptions()

Overrides:: getAllExceptions in class RowImpl

clearAllExceptions

protected void clearAllExceptions()

refresh

public void refresh(int refreshMode)

Description copied from class: RowImpl

Refreshes the row's attributes with values from database. refreshMode should be a combination of REFRESH_.... See REFRESH_... constants for further information.

Specified by:: refresh in interface Row
Specified by:: refresh in class RowImpl

Parameters:: refreshMode - the refresh mode.

remove

public void remove()

Removes the row from the database table.

In the case of a composition where this Entity is a master, this method calls vetoRemoveWithDetails with an Association attribute that defines the composition, to perform a check for existence of detail Rows.

Override this method to add your own business logic for the remove operation. For example, you can implement business logic that throws an exception that report why an Entity Object cannot be removed.

Specified by:: remove in interface Row
Specified by:: remove in class RowImpl

Throws:: RemoveWithDetailsException - if an attempt is made to is made to remove the master Entity Object before removing its children.

removeFromCollection

public void removeFromCollection()

Description copied from class: RowImpl

Removes the row from the collection.

This method differs from RowImpl.remove() in that it just removes the row from the collection. It does not remove the underlying Entity row(s) or database row(s). However, once the row is removed, it cannot be used any more. If you want to remove the row from the collection and insert it elsewhere, call RowImpl.removeAndRetain().

Specified by:: removeFromCollection in interface Row
Specified by:: removeFromCollection in class RowImpl

getPostState

public byte getPostState()

Returns this Entity Object's current post-state in the transaction. The possible post-states that can be returned are:

STATUS_UNMODIFIED - if this Entity Object has been queried from the database and is unchanged, or if it has been posted to the database.
STATUS_MODIFIED - if this Entity Object has been queried from the database and has changed.
STATUS_NEW - if this Entity Object is new and not yet posted to the database.
STATUS_INITIALIZED - if this Entity Object is new and the client code marks it to be temporary by calling Row.setNewRowState method.
STATUS_DELETED - if this Entity Object has been marked for deletion.
STATUS_DEAD - if this Entity Object is new, but has been deleted.

Specified by:: getPostState in interface Entity

Returns:: this Entity Object's current post-state.

getPrimaryKey

public Key getPrimaryKey()

Returns the primay key for this Entity Object's row. For example, if you are comparing two Entity Objects, you can compare the keys instead of comparing the Entities.

Typically, this method should not be overridden.

Specified by:: getPrimaryKey in interface Entity

Returns:: the primary key.

isValid

public boolean isValid()

Returns whether this Entity Object is valid.

An Entity Object is marked valid if it has been validated and not subsequently modified or set invalid.

Specified by:: isValid in interface Entity
Specified by:: isValid in interface ValidationListener

Returns:: true if this Entity Object is valid; false otherwise.

isInvalid

public boolean isInvalid()

Returns whether this Entity Object is invalid.

An Entity Object is marked invalid if it has not been validated or if it has been validated then subsequently modified or set invalid.

Returns:: true if this Entity Object is invalid; false otherwise.

revert

public void revert()

Description copied from interface: Entity

Reverts this Entity Object's row to the database's values.

Calling this method will either reset the attribute values to their database values or revert them to their default values. If the Entity Object is posted, all the attributes revert to the to unread state, so that a subsequent getAttribute(int index) call will refresh all attributes from the database.

Specified by:: revert in interface Entity

See Also:: getAttribute(int index)

afterCommit

public void afterCommit(TransactionEvent e)

Description copied from interface: TransactionListener

Called to report that a Commit operation has occurred.

Specified by:: afterCommit in interface TransactionListener

Parameters:: e - a transaction event.

afterRollback

public void afterRollback(TransactionEvent e)

Internal: Applications should not call this method.

Initiates a state change and polls listeners following a rollback operation.

Resets the EntityState to STATUS_DEAD or STATUS_UNMODIFIED for new or updated/removed rows respectively. Sets other status flags for this Entity Object so that it behaves just like it was fetched for the first time from the database.

This method should not be overridden.

Specified by:: afterRollback in interface TransactionListener

Parameters:: e - this Entity Object's transaction event.
See Also:: TransactionListener

beforeCommit

public void beforeCommit(TransactionEvent e)

Polls transaction listeners before a commit operation.

Specified by:: beforeCommit in interface TransactionListener

Parameters:: e - this Entity Object's transaction event.
See Also:: TransactionListener

beforeRollback

public void beforeRollback(TransactionEvent e)

Polls transaction listeners before a rollback operation.

Specified by:: beforeRollback in interface TransactionListener

Parameters:: e - this Entity Object's transaction event.
See Also:: TransactionListener

addToValidationListeners

public void addToValidationListeners(ValidationListener w)

Description copied from interface: ValidationManager

Adds a validation listener.

The listener will be notified to perform its own validation when this validation manager is validated.

Specified by:: addToValidationListeners in interface ValidationManager

Parameters:: w - a validation listener.

setNewRowState

public void setNewRowState(byte state)

Advanced method: Applications should not use this method. Internal method used by ViewRowImpl.setNewRowState() to make all entities that belong to that new row as new or initialized. Initialized rows are tracked at ViewObject's collection and entities should not be marked as initialized from a context other than the containing ViewRowImpl.

Specified by:: setNewRowState in interface Row

Parameters:: state - This could be STATUS_NEW or STATUS_INITIALIZED.

setAttribute

public void setAttribute(int index,
                         java.lang.Object val)

Sets the value of an attribute, given its index position.

If there is a set method for this attribute in a subclass of this Entity Object, that method is invoked. The set method name is derived from the attribute name: for example, the method getDeptNo() pertains to an attribute named "Deptno".

This method should not be overridden; override setAttributeInternal instead.

Specified by:: setAttribute in interface AttributeList
Overrides:: setAttribute in class RowImpl

Parameters:: index - the index of the attribute.; val - the value to be assigned to the attribute. The class of the returned value a Java type determined by this Entity Object's definition object.

populateAttribute

protected void populateAttribute(int index,
                                 java.lang.Object value)

Advanced method: Applications should not use this method.

Sets an attribute's value but does not mark it as updated. This method is called by query collection when populating a row with data. This is a framework-internal function and must not be called directly in client code except in the case of a composite Entity.

In a composite Entity, one Entity is comprised of two or more other Entities. An example of a composite Entity would be an Employee Entity which is comprised of a Person Entity and an Assignment Entity. The populateAttribute method could be used to populate Person and Assignment attributes when the Employee attributes are read-in.

Specified by:: populateAttribute in class RowImpl

Parameters:: index - the index of the attribute to populate.; value - the value to place in the attribute.

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object val)

Sets the value of the named attribute, given its name.

This method should not be overridden; override setAttributeInternal instead.

Specified by:: setAttribute in interface AttributeList
Overrides:: setAttribute in class RowImpl

Parameters:: name - the name of the attribute.; val - the value to be assigned to the attribute. The class of the returned value a Java type determined by this Entity Object's definition object.

getEntityState

public byte getEntityState()

Gets this Entity Object's current Entity-state in the transaction. The possible Entity-states that can be returned are:

STATUS_UNMODIFIED - if this Entity Object originated in the database and is unmodified, or if modifications have been committed to the database.
STATUS_MODIFIED - if this Entity Object originated in the database, and has been modified in the current transaction.
STATUS_NEW - if this Entity Object is new in the current transaction.
STATUS_DELETED - if this Entity Object has been deleted in the current transaction.
STATUS_DEAD - if this Entity Object is new in the current transaction and has been deleted.

Specified by:: getEntityState in interface Entity

Returns:: this Entity Object's current Entity-state.

createEntityViewLinkAccessorVO

protected ViewObjectImpl createEntityViewLinkAccessorVO(AssociationDefImpl assocDef,
                                                        java.lang.String voName,
                                                        ViewDefImpl vDef,
                                                        ViewLinkDefImpl vlDef)

getDBTransaction

public final DBTransaction getDBTransaction()

Retrieves this Entity Object's database transaction.

This method should not be overridden.

Returns:: the database transaction.

createAssociationAccessorVO

protected ViewObjectImpl createAssociationAccessorVO(AssociationDefImpl assocDef,
                                                     java.lang.String voName,
                                                     EntityAssociation eoAssoc)

findEntityViewLinkAccessorVO

protected ViewObjectImpl findEntityViewLinkAccessorVO(AssociationDefImpl assocDef,
                                                      java.lang.String voName,
                                                      ViewDefImpl vDef,
                                                      ViewLinkDefImpl vlDef)

findAssociationAccessorVO

protected ViewObjectImpl findAssociationAccessorVO(AssociationDefImpl assocDef,
                                                   java.lang.String voName,
                                                   EntityAssociation eoAssoc)

getBaseAttributeCount

public final int getBaseAttributeCount()

getEntityCache

public EntityCache getEntityCache()

A Convenience for writing a lot of code.

getDynamicAttributeCount

protected int getDynamicAttributeCount()

getDynamicAttributeValue

protected java.lang.Object getDynamicAttributeValue(int dynAttrIndex)

setDynamicAttributeValue

protected void setDynamicAttributeValue(int dynAttrIndex,
                                        java.lang.Object value)

createAssociationAccessorRS

protected EntityRowSetImpl createAssociationAccessorRS(AssociationDefImpl assocDef,
                                                       ViewObjectImpl accessorVO,
                                                       Row masterRow,
                                                       java.lang.Object[] values)

createEntityViewLinkAccessorRS

protected ViewRowSetImpl createEntityViewLinkAccessorRS(AssociationDefImpl assocDef,
                                                        ViewObjectImpl accessorVO,
                                                        Row masterRow,
                                                        java.lang.Object[] values)

getAttribute

public java.lang.Object getAttribute(int index)

Description copied from class: RowImpl

Get an attribute value by index

Specified by:: getAttribute in interface AttributeList
Overrides:: getAttribute in class RowImpl

Parameters:: index - an integer in the range 0 to getAttributeCount() - 1.
Returns:: Attribute value, if index is valid, or null if it is not

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Returns the value of the named attribute, given a string value.

If there is a get method for this attribute in a subclass of this Entity Object, that method is invoked. The get method name is derived from the attribute name: for example, the method getDeptNo() pertains to an attribute named "Deptno".

This method should not be overridden. Instead, override getAttribute(int index).

Specified by:: getAttribute in interface AttributeList
Overrides:: getAttribute in class RowImpl

Parameters:: name - the name of the attribute.
Returns:: the value of the attribute. The class of the returned value a Java type determined by this Entity Object's definition object.
See Also:: getAttribute(int index)

getAttributeInternal

protected java.lang.Object getAttributeInternal(int index)

Gets the attribute value by index. If the attribute is not already queried by using some View Object, fault-in all the attributes for this Entity Object and then return this attribute-value. For attributes that are association accessors, execute a Query if not already executed to return the associated Entities.

This method is not typically overridden. However, it could be overridden, for example, to return numeric values stored as integers, in a two-decimal format.

Specified by:: getAttributeInternal in class RowImpl

Parameters:: index - the index of the attribute.
Returns:: attribute value at given index.

getAttrInvokeAccessor

protected java.lang.Object getAttrInvokeAccessor(int index,
                                                 AttributeDefImpl attrDef)
                                          throws java.lang.Exception

Throws:: java.lang.Exception

getPostedAttribute

protected java.lang.Object getPostedAttribute(int index)

Gets the value originally read for this attribute from the database.

If the attribute value at the specified index has been changed (whether to the same value or a new value), return the original value as read from the database on first query. The method invokes getAttributeInternal to return the original value.

This method should not be overridden.

Parameters:: index - index of the attribute.
Returns:: attribute value as currently posted in the database.

isAttributeChanged

protected boolean isAttributeChanged(int index)

Determines whether the attribute at the index been been changed.

Returns true if the the attribute has been changed since it was obtained from the Database. Note that if a Posting operation is performed, and the attribute value is sync'd with the database, that subsequent requests will return false, until the next time the attribute is changed.

Note that this method will return true if the value has been set to the same as the database value since it doesn't perform a value comparison.

After a Commit operation, the flag is also reset to false.

Parameters:: index - index of the attribute.
Returns:: true if the value of the attribute at the given index is changed from it's originally queried value.

isOrigDataPopulated

protected boolean isOrigDataPopulated(int index)

getOrigData

protected java.lang.Object getOrigData(int index)

populateAttributeAsChanged

protected void populateAttributeAsChanged(int index,
                                          java.lang.Object value)

Advanced method: Applications should typically not call this method from their subclasses other then when performing programmatic attribute defaulting with proper attribute values.

Sets an attribute's value and also marks the attribute as changed in this row. Primary key attributes should not be set using populateAttribute apis.

This method is called by query collection when populating a row with data. This is a framework-internal function and must not be called directly in client code except in the case of a composite Entity or defaulting. This method avoids all programmatic and declarative validations on an attribute and still sets the data value for the attribute and marks the attribute as changed so that the value is posted during entity DML.

In a composite Entity, one enitity is comprised of two or more other Entities. An example of a composite Entity would be an Employee Entity which is comprised of a Person Entity and an Assignment Entity. The populateAttribute method could be used to populate Person and Assignment attributes when the Employee attributes are read-in.

This method does not change Entity Validation, Post or Transaction States. If this entity is not already marked invalid or not in the transaction's lists, this method will not mark the entity invalid or add it into transaction's lists.

Parameters:: index - the index of the attribute to populate.; value - the value to place in the attribute.
See Also:: populateAttribute(int index, Object value)

setAttributeChanged

protected void setAttributeChanged(int index,
                                   boolean flag)

addToTransactionManager

protected void addToTransactionManager()

Adds this Entity object to its transaction manager (either another Entity object based on the containership model, or the transaction object for this session). This object maintains flags to indicate the status of the object's presence in the transaction manager's post-listener and transaction-listener lists, so as to avoid being in the list(s) more than once.

Subclasses that manage their own transaction ordering should invoke this method to add this Entity instance to its transaction manager instead of calling the manager's add methods.

getContainerEntity

protected EntityImpl getContainerEntity()

Returns this entity's container in a composition association if any.

doSelectForAltKey

protected void doSelectForAltKey(int keyIndex)

doSelect

protected void doSelect(boolean lock)

Advanced: Most applications should not use this method.

Performs SELECT/SELECT FOR UPDATE processing for the row. This method faults-in all column-values from the database object for this Entity Object.

This method can be overridden, for example, if you want to fill in the Entity Object values yourself.

Parameters:: lock - true generates a "SELECT for UPDATE"

getSQLBuilder

protected SQLBuilder getSQLBuilder()

Get the SQLBuilderImpl which performs all SQL operations required by this Entity Object.

Returns:: the SQLBuilderImpl

buildWhereClause

protected void buildWhereClause(java.lang.StringBuffer buffer,
                                AttributeDefImpl[] keyCols,
                                java.lang.Object rowid)

Construct a SQL WHERE clause for the Entity into the designated Buffer. This routine constructs a SQL WHERE clause in the StringBuffer passed. It does this by appending the various components of the WHERE Clause (based upon Primary Key columns) into the buffer area.

This method is called from SQLBuilder for:

doEntitySelect

buildUpdateStatement

buildDeleteStatement

The presence or absence of the ROWID value determines whether the ROWID will be used for Row access.

Parameters:: buffer - the area into which the WHERE Clause will be placed.; keyCols - the Primary key columns.; rowid - the ROWID for the ROW if known.

isTransientTransactionListener

public boolean isTransientTransactionListener()

Tests whether this Entity Object's transaction listener is transient or permanent.

Transient listeners are automatically removed at the end of the transaction cycle; permanent listeners remain.

Specified by:: isTransientTransactionListener in interface TransactionListener

Returns:: true if the listener is transient.

setTransPostHandle

public void setTransPostHandle(int hdl)

Advanced: Most applications should not use this method.

Implements the setTransPostHandle method for the transaction post listener (TransactionPostListener) interface.

Transaction post handle is a handle identifying a row object in the transaction post listener list.

Specified by:: setTransPostHandle in interface TransactionPostListener

Parameters:: hdl - the transaction post handle.
See Also:: TransactionPostListener

setPostedToDB

public void setPostedToDB(boolean b)

Advanced: Most applications should not use this method. For non-oracle databases that do not support savepoint, this method should be called from the custom sql builder to mark the entity as posted so that it's not posted again during a subsequent post cycle (if this entity was already posted but other entity/entities led to an exception in the current post cycle.

Specified by:: setPostedToDB in interface TransactionPostListener

getTransPostHandle

public int getTransPostHandle()

Advanced: Most applications should not use this method.

Implements the getTransPostHandle method for the transaction post listener (TransactionPostListener) interface.

Transaction post handle is a handle identifying a row object in the transaction post listener list. If the object does not have a transaction post handle, this method returns -1.

Specified by:: getTransPostHandle in interface TransactionPostListener

Returns:: the transaction post listener handle or -1, which means no transaction post handle.
See Also:: TransactionPostListener

isPostedToDB

public boolean isPostedToDB()

Advanced: Most applications should not use this method. For non-oracle databases, indicates if this entity is posted. For use in custom SQLBuilder to check if this entity was posted in a previous post cycle.

Specified by:: isPostedToDB in interface TransactionPostListener

isTransientTransactionPostListener

public boolean isTransientTransactionPostListener()

Tests whether this Entity Object's TransactionPostListener is transient or permanent.

Transient listeners are automatically removed at the end of the transaction cycle; permanent listeners remain.

Specified by:: isTransientTransactionPostListener in interface TransactionPostListener

Returns:: true if the listener is transient.
See Also:: TransactionPostListener

doDMLForCascadeUpdate

protected void doDMLForCascadeUpdate(TransactionEvent e,
                                     List tpl,
                                     List ecList,
                                     boolean startingEntity)

Advanced method: Applications should typically not use this method.

Special case DML for the case where PK attribute(s) are being updated for an entity which is also a master in an association which has cascade update turned on. In this case, the master needs to first clone it's row in the DB with the new Pk, move all the details to this new row with the new PK and then remove the existing mater row from the DB.

Note that this method should handle DML for this entity's composition children, if any. This list is passed in in 'tpl'.

Parameters:: e - TransactionEvent for this DML; tpl - An array of Transaction Listeners that conatins cascade updated details.; ecList - List of entities with batch mode turned on. This list is prepared by the framework and should not be 'modified'.; startingEntity - true if postChanges() was directly called on this entity.

postChanges

public void postChanges(TransactionEvent e)

Initiates a post operation for this Entity Object.

Depending on the post-state of this Entity Object, this method calls doDML with the DML_DELETE, DML_UPDATE, or DML_INSERT flags.

In case this Entity Object is part of a composition association, this method calls postChanges on all Entities that are part of the TransactionPostListener list. Note that for delete, postChanges() on the child Entities are called before doDML() is called on this Entity Object. For updates and inserts, child Entities are posted after this Entity Object's doDML() is called.

The postChanges method calls doDML and manages the post state. To implement different behavior, it is recommended that developers override doDML or one of it's called methods (see javadoc for doDML), instead of postChanges. For example, the following code sample overrides doDML and uses postChanges to get the detail Entities and post them to the database.

 public void doDML(int operation, TransactionEvent e)
 {
   RowIterator details = getDetails();
   while (details.hasNext())
   {
     ((EntityImpl) details.next()).postChanges(e);
   }
   super.doDML(operation, e);
 }

If the requirement is to only set attributes during the DML phase like say history attribute, then it should be done in prepareForDML() method so that it works consistently when this entity is posted in batch-mode or not. prepareForDML() method is invoked by the framework before doDML() and in case of post cycle from the transaction, the transaction calls prepareForDML() on all entities in the transaction list followed by doDML() on all those entities.

Specified by:: postChanges in interface TransactionPostListener

Parameters:: e - this Entity Object's transaction event.
See Also:: doDML(int, TransactionEvent), TransactionPostListener.postChanges(TransactionEvent e), TransactionPostListener

initDefaults

protected void initDefaults()

Initialize Entity row's default values. It walks through all entity definitions and initializes the attribute with the default value (from the definition).

getHistoryContextForAttribute

protected java.lang.Object getHistoryContextForAttribute(AttributeDefImpl attr)

isAttributePopulated

protected boolean isAttributePopulated(int index)

Determines whether the attribute at the specified index position is populated.

Parameters:: index - the attribute index.
Returns:: true if the value of the attribute at the given index is currently populated.

getAltKey

public Key getAltKey(int keyIndex)

isInCache

public boolean isInCache()

setInvalid

protected void setInvalid()

A helper method that marks this Entity Object invalid and adds it to the ValidationListeners list of the validation manager to which this Entity Object belongs. For example, call this method when there is a possiblity that a value in the Entity Object has changed. The framework calls this method to set the Entity Object's validation state to invalid.

populateAttribute

public void populateAttribute(int index,
                              java.lang.Object value,
                              boolean sendNotification,
                              boolean markAsChanged,
                              boolean saveOriginal)

Advanced method: Applications should typically not use this method.

Sets an attribute's value and optionally mark it as updated and optionally send events to listeners about the change. Note that this method avoids all validations written in the attribute-setter or rules installed for this attribute.

Invoke this method from a sub-class if the sub-class is implementing it's own data-source. This method may also be used by a sub-class to implement refresh-on-update/refresh-on-insert features if the sub-class is implementing it's own data-sink.

Parameters:: index - a 1-based index into the columns.; value - the value for the column.; sendNotification - notify the dependent ViewObjects that this attribute has changed; markAsChanged - mark this attribute as changed so that it's picked up by doDML() for actual database updates.; saveOriginal - indicates if this method should cache the original value of this attribute (as fetched) in the entity for refresh, lock and other usages. By default most callers should pass this flag as true when modifying an entity attribute value for updates (without affecting the entity states).

notifyAttributesChanged

protected void notifyAttributesChanged(int[] attrIndices,
                                       java.lang.Object[] values)

notifyAttributesChanged

protected void notifyAttributesChanged(int[] attrIndices,
                                       java.lang.Object[] values,
                                       boolean markQCDirty)

registerAttributeException

protected void registerAttributeException(AttributeDef attrDef,
                                          java.lang.Object val,
                                          JboException ex)

clearAttributeException

protected void clearAttributeException(int index)

Cleans any exception of an attribute of the given name was set earlier and threw an exception which was cached as the transaction is in deferred mode.

Overrides:: clearAttributeException in class RowImpl

hasAttributeException

protected boolean hasAttributeException(int index)

Returns true if an attribute at the given index was set earlier and threw an exception which was cached as the transaction is in deferred mode.

validateEntity

protected void validateEntity()

Validates the Entities and other listeners that are members of ValidationListeners list. Once all listeners are validated and removed from the list, invoke declarative validators (if attached to this Entity Object's defintion) to validate this Entity Object instance. For example, JboMandatoryAttributesValidator (if applicable) will be invoked here to perform null-value checks on mandatory attributes.

Applications should subclass this method to perform custom Entity-level validation and call super.validateEntity() to enable the framework to coordinate validation of detail Entities and validation via the declarative validators (that is, Entity validators declared at design-time).

In the case of composition, child Entities are validated from this method.

In the following example, code is added to validateEntity() to throw an exception if the value of the Emp.Ename attribute is "Jerome".

     public void validateEntity() {
       if (getEname().equals("Jerome"))
         throw new JboException("Name cannot be Jerome");
       super.validateEntity();
      }

Throws:: JboException - in case validation fails.

validate

public final void validate()
                    throws JboException

Validate this Entity Object.

This method is invoked by the framework during any currency change and during the commit process.

If this Entity Object is marked invalid, validation is performed as follows:

All validation listeners are first validated. Typically, invalid children or detail Entity Object's related to this Entity Object through composition associations will be members of the validation listeners list.
Attached declarative validators are notified to validate this Entity Object.

Once all listeners are validated, this Entity Object is then marked valid.

This method should not be overridden. Custom validation logic should be implemented by overriding the validateEntity method, which can be invoked before or after calling super.validateEntity().

Specified by:: validate in interface Row
Specified by:: validate in interface ValidationListener
Specified by:: validate in interface ValidationManager
Specified by:: validate in class RowImpl

Throws:: oracle.jbo.JboException - if this Entity Object is found to be invalid.; JboException - if validation fails.
See Also:: validate(), ViewRowImpl.validate()

create

protected void create(AttributeList nameValuePair)

This method should be subclassed to supply programmatic default values to various attributes of a new Entity Object. For example, to create a sequence.

Instances of subclasses should call super.create() before performing any operations.

By default, if this Entity Object is part of a composition, and is a detail, this method checks for a valid foreign-key value in the given nameValuePair and sets the foreign-key value into its attributes appropriately. This logic validates that a detail Entity Object has a master Entity Object if the two are related by composition association.

If this method is overridden, the developer must ensure that in the case of composition, the nameValuePair belongs to the master Entity or that the nameValuePair contains all of the foreign keys required to create the Entity.

Parameters:: nameValuePair - a list of attribute values (name-value pairs) to be used in initializing the row. If the jbo.903.compatible property is specified, nameValuePair will never be null when this method is called by the view row's create. If jbo.903.compatible is not specified, the user must check for the possibility of nameValuePair being null, which means no attribute value is being passed in.
Throws:: oracle.jbo.InvalidOwnerException - if an attempt is made to create a detail row without a master, when the association between the master and detail is marked as composition.

initDefaultExpressionAttributes

protected void initDefaultExpressionAttributes(AttributeList nameValuePair)

Used to initialize this entity with values from evaluated expressions on the attributedefs. No events are generated and evaluated values replace any existing values in the relevant attributes unless it was overridden via nameValuePair

initBusLogicGroupDefaults

protected void initBusLogicGroupDefaults()

initBusLogicGroupDfltExprAttrs

protected void initBusLogicGroupDfltExprAttrs(AttributeList nameValuePair)

addTransactionPostListener

public void addTransactionPostListener(TransactionPostListener listener)

addTransactionPostListenerNoCheck

public void addTransactionPostListenerNoCheck(TransactionPostListener listener)

removeTransactionPostListener

public void removeTransactionPostListener(TransactionPostListener listener)

Internal: Applications should not use this method.

Removes a listener from the list of post operation listeners.

Parameters:: listener - the listener to be removed.
See Also:: DBTransaction, ValidationManager

lockTopLevelEntity

protected void lockTopLevelEntity()

Locks the top-most Entity Object by getting the master Entity Object defined by composition associations, and walking-up the chain of containership. Since 9.0.3, the logic to walk up the hierarchy will stop either at the top or when a composition association is found that has the lockTopContainer flag turned off (to indicate a weak aggregation).

getAttributeValue

protected final java.lang.Object getAttributeValue(AttributeDefImpl attr)

Internal: Applications should not use this method.

Given an attribute definition object, this method gets the value for the attribute. This method should not be overridden; override getAttributeInternal instead.

Parameters:: attr - name of the attribute definition.
Returns:: value of the attribute.
See Also:: getAttributeInternal(int index)

isLocked

public boolean isLocked()

Determines whether this Entity Object is locked.

An Entity Object is locked if its corresponding database row is locked. This method should not be overridden.

Returns:: true if the row is locked; false otherwise.

resetPKBasedRef

protected void resetPKBasedRef()

compare

protected boolean compare(SparseArray target)

Compares the data in this row with that of another.

This method returns true if the values are "the same" and false if they are not.

This method uses the ChangeIndicator attribute, if it is present, for the comparison. If ChangeIndicator is not present, then this method compares the data for overlapping columns between the entity and the given array.

Applications should override this method to implement custom comparision of specific attributes and avoid deep comparision of every entity attribute (in case changeIndicator attribute is not defined in this entity). If ChangeIndicator attribute is present only that attribute is compared to check if the target data matches this Entity. Also, if the application has mutli-part ChangeIndicator, this method should be used to implement comparision of multi-part ChangeIndicator attributes to speedup comparision.

Returns:: true if the data is the same; false otherwise.

setAttributeValues

public void setAttributeValues(List names,
                               List values)

Set attribute values for the given list of attributes names. This implementation may invoke setAttribute(name, value) for each name, value pair. List size for names and values list should match up. If there are more names than values, then the names with no corresponding value entry in the values list will be ignored.

Specified by:: setAttributeValues in interface Row

setAttributeInternal

protected void setAttributeInternal(int index,
                                    java.lang.Object val)

Validates and sets the value of an attribute by index. Used by generated code from JDeveloper wizards to set an attribute value after validating the value against declarative-validators set for that attribute.

Parameters:: index - the index of the attribute.; val - the value of the attribute.

handleListBindingMismatch

protected void handleListBindingMismatch(ListBinding lb,
                                         Map valuesMap,
                                         RowIterator listRSI)

Specified by:: handleListBindingMismatch in class RowImpl

hasListBindings

protected final boolean hasListBindings()

Specified by:: hasListBindings in class RowImpl

doDML

protected void doDML(int operation,
                     TransactionEvent e)

Performs INSERT/UPDATE/DELETE processing for the row. Override this method to provide custom logic for processing inserts, updates, and deletes. Note, do not set any of this Entity's attributes in this method if this entity needs to work alike in both batch and non-batchmode cases. Perform all setAttributes that needs to done in postChanges() phase in prepareForDML().

This method calls buildDMLStatement() to build the DML string based on the DML operation to be performed. For insert and update, the DML statement will only set the values that have been modified/changed. Other attributes do not participate in the DML.

Next, bindDMLStatement() is called to bind the DML statement with values to be updated and any other where-clause and returning parameters. After this, it executes the jdbc-statement or adds the current DML as a batch operation into a batched jdbc-statement, to be executed in Transaction.postChanges().

Here is sample code for overriding the doDML() method of any Entity Object's EntityImpl class to invoke a stored procedure, and pass arguments. For example, given a PL/SQL stored procedure like:

 PROCEDURE updateDepartment( p_Deptno NUMBER,
                             p_Dname  VARCHAR2,
                             p_Loc    VARCHAR2 )

The code to call it when an Entity is updated would look like this: Note: The following code assumes only updates are possible, disallowing inserts and deletes by ignoring them in the doDML() method.

    public void doDML(int operation, TransactionEvent e) {
       // Don't call the superclass. This procedure handles only updates
       //super.doDML(operation, e);
       CallableStatement stmt = null;
       // ONLY Perform updates, this Entity won't allow inserts/deletes.
       if (operation == DML_UPDATE)
       {
         // Prepare JDBC CallableStatement with the Stored Procedure Call
         String updateStr = "{call updateDepartment(?,?,?)}";
         stmt = getDBTransaction().createCallableStatement(updateStr, 1);
         try
         {
            // Bind the Statement Parameters and Execute this Statement
            stmt.setString(1, getDeptno().toString());
            stmt.setString(2, getDname().toString());
            stmt.setString(3, getLoc().toString());
            stmt.execute();
          }
          catch (Exception ex)
          {
            throw new oracle.jbo.JboException(ex);
          }
          finally
          {
             try
             {
                stmt.close();
             }
             catch (Exception nex)
             {
          }
        }
      }
    }

Parameters:: operation - the integer representation of DML_INSERT, DML_UPDATE, or DML_DELETE.; e - this Entity Object's transaction event.

doDMLWithLOBs

protected void doDMLWithLOBs(int operation,
                             TransactionEvent e)

Performs INSERT/UPDATE/DELETE processing for Entity Objects that contain LOBs. This method is called by doDML when the Entity Object is found to contain LOBs.

The method uses a two stage process to first get the LOB locator, then post the LOB values individually. Typically, you would override this method when you want to take control over how to post the LOB.

Parameters:: operation - DML_INSERT, DML_UPDATE or DML_DELETE; e - this Entity Object's transaction event.
See Also:: doDML(int operation, TransactionEvent e)

buildDMLStatement

protected java.lang.StringBuffer buildDMLStatement(int operation,
                                                   AttributeDefImpl[] allAttrs,
                                                   AttributeDefImpl[] retCols,
                                                   AttributeDefImpl[] retKeys,
                                                   boolean batchMode)

Advanced: Most applications should not use this method. This method constructs the DML statement and returns it as a StringBuffer.

Parameters:: operation - The current DML operation.; allAttrs - An array of all attribute definitions for this entity. This is passed in for performance reasons, so that the array is not built again.; retCols - An array of non-primary key attributes that are marked refresh-on-insert or refresh-on-update for an Insert or Update operation respectively. It could be an empty array or null in case of Delete operation.; retKeys - An array of primary key attributes that are marked refresh-on-insert or refresh-on-update for an Insert or Update operation respectively. It could be an empty array or null in case of Delete operation.; batchMode - True if this DML statement will be used in creating a batchmode jdbc statement.
Returns:: A StringBuffer containing the INSERT, UPDATE or DELETE SQL-Statememt based on the operation to be performed. This method is called in doDML().

bindDMLStatement

protected int bindDMLStatement(int operation,
                               PreparedStatement stmt,
                               AttributeDefImpl[] allAttrs,
                               AttributeDefImpl[] retCols,
                               AttributeDefImpl[] retKeys,
                               Map retrList,
                               boolean batchMode)
                        throws SQLException

Advanced: Most applications should not use this method. This method binds current attribute values to the given jdbc PreparedStatement.

Parameters:: operation - The current DML operation.; stmt - A jdbc PreparedStatement containing a SQL statement built in buildDMLStatement(); allAttrs - An array of all attribute definitions for this entity. This is passed in for performance reasons, so that the array is not built again.; retCols - An array of non-primary key attributes that are marked refresh-on-insert or refresh-on-update for an Insert or Update operation respectively. It could be an empty array or null in case of Delete operation.; retKeys - An array of primary key attributes that are marked refresh-on-insert or refresh-on-update for an Insert or Update operation respectively. It could be an empty array or null in case of Delete operation.; retrList - Hashmap of bind-variable indices (as keys) and attribute definitions (as values) that are being returned for refresh-on-insert/update in this DML.; batchMode - True if this DML statement will be used in creating a batchmode jdbc statement.
Returns:: Last index of a jdbc-bind variable
Throws:: SQLException

setAttrInvokeAccessor

protected void setAttrInvokeAccessor(int index,
                                     java.lang.Object val,
                                     AttributeDefImpl attrDef)
                              throws java.lang.Exception

Throws:: java.lang.Exception

handleEffectiveDateOperations

protected void handleEffectiveDateOperations()

Before posting the row to the database this method is invoked for effective date book-keeping. For Entity Rows that are created for the first time, the Effective Date values are populated. Entity row update may cause an effective date split. Entity row delete may cause more than one physical row to be deleted. If the Effective Date mode is set to Expert mode the framework assumes that the client has populated all the required values and effective date logic need not be applied. For more information about Effective Date Update and Delete modes refer to setEffectiveDateMode.

validateDateEffectivity

public void validateDateEffectivity()

Validates the Effective Date aspects of an Entity to ensure that gaps or overlaps are not introduced. If the Entity is updated, created or deleted in expert mode no effective date validation is performed.

notifyAttributesAndBlgChanged

protected void notifyAttributesAndBlgChanged(int[] attrIndices,
                                             java.lang.Object[] values,
                                             boolean blg)

domainToBeModified

public void domainToBeModified(DomainInterface d)

Description copied from interface: DomainOwnerInterface

Notification method that this domain calls whenever any of its attribute values are about to be modified. This Domain should always notify its owner.

Specified by:: domainToBeModified in interface DomainOwnerInterface

Parameters:: d - the domain being modified.

getPKBasedRef

protected java.lang.Object getPKBasedRef(AttributeDefImpl attr)

findViewAccessorDef

public ViewAccessorDef findViewAccessorDef(java.lang.String name)

This method returns ViewAccessorDef with the specified name.

Overrides:: findViewAccessorDef in class RowImpl

Parameters:: name - The name of the ViewAccessorDef.
Returns:: The ViewAccessorDef

findOrCreateViewAccessorRS

public RowSet findOrCreateViewAccessorRS(ViewAccessorDef va)

Internal: Applications should not use this method.

getListBindings

protected List getListBindings()

Specified by:: getListBindings in class RowImpl

getListBindingRSI

protected RowSetIterator getListBindingRSI(ListBindingDef def)

Specified by:: getListBindingRSI in class RowImpl

createViewAccessorRS

protected RowSet createViewAccessorRS(java.lang.String vaName)

Internal: Applications should not use this method.

findOrCreateViewAccessorRS

public RowSet findOrCreateViewAccessorRS(java.lang.String vaName)

Internal: Applications should not use this method.

createViewAccessorRS

protected RowSet createViewAccessorRS(ViewAccessorDef va)

Internal: Applications should not use this method.

findViewAccessorVO

protected ViewObject findViewAccessorVO(ViewAccessorDef va)

Internal: Applications should not use this method.

initData

protected SparseArrayInterface initData(int attrsCount)

getAttributeCount

public final int getAttributeCount()

Counts the number of attributes in this Entity Object.

The count includes persistent, transient, and association attributes. Attributes need not presently have values. This method will return the same value for all the Entity Object's rows.

This method should not be overridden.

The following code sample uses this method in a loop to retrieve and print Entity Object attribute names:

 //  Return the first Entity Object Row
 Row r = eo.first();
 // If we have a row, do this...
 if (r != null)
 {
   // Loop over the attributes in the Row and Print out the values
   for (int i = 0; i < eo.getAttributeCount(); i++)
   {
     String attrName = eo.getAttributeDef(i).getName();
     String attrVal = r.getAttribute(i).toString();
     out.println(attrName + " = " + attrVal);
   }
 }

Specified by:: getAttributeCount in interface AttributeList
Overrides:: getAttributeCount in class RowImpl

Returns:: the number of attributes.

isDirty

public boolean isDirty(int i)

Overrides:: isDirty in class RowImpl

bindWhereClause

protected int bindWhereClause(PreparedStatement stmt,
                              AttributeDefImpl[] keyCols,
                              java.lang.Object rowid,
                              int bindIndex)
                       throws SQLException

Bind the Primary key values for the designated Statement. This routine will perform the bind operation for each of the Primary Key columns.

The presence or absence of the ROWID value determines whether the ROWID will be used for Row access.

Parameters:: stmt - the statement to bind the columns to.; keyCols - the Primary key columns.; rowid - the ROWID for the row if known.; bindIndex - the baseline idx for performing the bind operations.
Throws:: SQLException

setLocked

protected void setLocked(boolean lockedState)

Sets the locked state.

This method is protected since users should call lock to place the row into the correct locked state.

Parameters:: lockedState - set to true to lock the row.

checkConsistency

protected boolean checkConsistency(SparseArray target,
                                   boolean lock)

Override this method to speed up comparing the attribute values of fetched entity data with this entity's data. This method is called when the entity is locked or when this entity is being faulted in and the entity is in un-modified state in a non-pessimistic transaction.

In builds before 10.1.2, this method was not called and for modified or removed Entities under optimisitic locking mode that were faulted in, did not go through this consistency check. They would simply faultin any db values on unmodified attributes. To achieve that old behavior, return true in this method's override, when the entity is modified or removed and lock parameter is sent in as false i.e., if (getPostState() != STATUS_UNMODIFIED && !lock) return true;

This method calls compare(SparseArray target) for comparision implementation.

This method returns true the return value from compare(target) call. If this method returns false, SQLBuilder will throw a RowInconsistentException to indicate difference in the database values for this entity.

Returns:: true if the data is the same; false otherwise.

getAttributeNames

public java.lang.String[] getAttributeNames()

Description copied from class: RowImpl

Gets a list of the names of all attributes

Specified by:: getAttributeNames in interface AttributeList
Overrides:: getAttributeNames in class RowImpl

Returns:: An array containing all attribute names. Returns a 0-length array if there are none. Note that the array elements are ordered by attribute index

getAttributeValues

public java.lang.Object[] getAttributeValues()

Description copied from class: RowImpl

Gets a list of the values of all attributes

Specified by:: getAttributeValues in interface AttributeList
Overrides:: getAttributeValues in class RowImpl

Returns:: An array containing all attribute values. Returns a 0-length array if there are none. Note that the array elements are ordered by attribute index

afterRemove

public void afterRemove(TransactionEvent e)

Description copied from interface: TransactionListener

A cleanup routine to be invoked by transaction manager when this transaction listener is removed from the manager's list.

Specified by:: afterRemove in interface TransactionListener

Parameters:: e - a transaction event.

getTransactionListenersList

protected List getTransactionListenersList()

Returns a copy of the list of "detail" Entities associated to this Entity Object by a composition association, participating in a transaction post and commit operations.

This method can be overridden, for example, to re-order the list of detail Entities in a specified order such as "post" order.

Returns:: ArrayList containing modified children Entities that are either validated or need to be validated.

prepareForBatchDML

protected void prepareForBatchDML(int operation,
                                  TransactionEvent te)

Advanced: Most applications should not use this method. A pre-doDML() step which calls prepareForDML() with the appropriate operation so that applications can perform attribute updates like history column etc.

This method also adjusts count of entities of a particular operation type to figure out if that operation has to be batched or not. Subclasses that override this method should call super.prepareForBatchDML() with the right operation type if this entity has consider batch operations.

prepareForDML

protected void prepareForDML(int operation,
                             TransactionEvent e)

A pre-doDML() notification that allows subclasses to modify any attributes on this entity that should be updated in the database.

In case of batch mode, the modified entities in a Transaction are posted in two steps. First all entities are notified with prepareForDML() so that enties can make changes to any attributes like say history column that needs to be updated right before a DML occurs. Then the doDML() is called on the entities to execute the DML that includes any changes done to this entity during the prepareForDML() phase.

Incase of non-batch mode, postChanges() method on the Entity invokes prepareForDML() followed by doDML() for so that subclasses can consistently write custom setAttribute logic in prepareForDML() which will be posted to the database via a DML statement in doDML().

Parameters:: operation - the integer representation of DML_INSERT, DML_UPDATE, or DML_DELETE.; e - this Entity Object's transaction event.

donePostingAll

protected void donePostingAll(TransactionEvent e)

doRefreshSQL

protected void doRefreshSQL(int operation,
                            List refreshAttrs)

This method is called after the entity is posted to the database to refresh the required attributes. This method is called for entities that have refresh-on-insert or refresh-on-update attributes in the following cases:

When Oracle SQLBuilder is in use and this Entity is set to use Batch-mode DML

When any other SQLBuilder is in use

In both cases however, if refresh-on-insert or update setting is set on an attribute which is a primary key attribute, then this method will fail to fetch the entity as the primary key in the database for the equivalent row would have potentially changed. If that's true, then subclasses need to implement this method and perform "custom" sql to fetch the refresh-attrs based on some unique criteria for this entity.

buildRefreshSQL

protected AttributeDefImpl[] buildRefreshSQL(java.lang.StringBuffer sqlBuffer,
                                             int operation,
                                             AttributeDefImpl[] columns,
                                             AttributeDefImpl[] retKeycols,
                                             boolean withInto)

Builds the sql SELECT statement to fetch refresh-on-insert or update attributes and uses getRefreshSQLKeyAttrs() to create WHERE clause for this SELECT statement. This method is called for entities that have refresh-on-insert or refresh-on-update attributes in the following cases:

When Oracle SQLBuilder is in use and this Entity is set to use Batch-mode DML

When Oracle SQLBuilder is in use and this Entity's definition is set to not use RETURNING clause

When any other SQLBuilder is in use

Returns:: AttributeDefImpl array containing the attributes that are used in the WHERE clause.

getRefreshSQLKeyAttrs

protected AttributeDefImpl[] getRefreshSQLKeyAttrs(int operation)

Returns an array of AttributeDefImpl containing attributes that should be used in the where-clause (as key columns) when a select statement is executed to fetch refresh-on attributes.

If the primary key attributes do not have refresh-on flag set for the given operation (Insert or Update), then these attributes are returned.

If one or more of the primary key attributes are also refresh-on-insert or update attributes and unique-key attributes are set on this entity, then this method returns an array of unique-key attributes. If not, then a warning is printed on the diagnostic and this method returns an array of primary keys.

Subclasses should override this method to return a customized list of attributes to use to create a where-clause for the select statement to be used to fetch refresh-on attributes. This method is called for entities that have refresh-on-insert or refresh-on-update attributes in the following cases:

When Oracle SQLBuilder is in use and this Entity is set to use Batch-mode DML

When Oracle SQLBuilder is in use and this Entity's definition is set to not use RETURNING clause

When any other SQLBuilder is in use

handlePostChangesError

protected void handlePostChangesError()

Called when a problem occurs while posting changes and restores an EntityImpl's state.

For example, when a user performs an operation (such as a commit) that posts changes, the framework will go through each EntityImpl instance that was modified during this transaction and call postChanges() to post the changes to database. If something goes wrong during this process and an exception is caught, then the framework notifies those EntityImpls by calling handlePostChangesError. The default implementation of handlePostChangesError essentially restores the EntityImpl's state.

In a composition post cycle, when the posting of one of the detail Entities throws an exception, the framework calls this method on the master Entity which internally calls this method on all of the composite Entities

A user can create a custom EntityImpl (by extending EntityImpl), and handle such an error differently from the default implemention by overriding handlePostChangesError and adding custom error-handling logic.

If this method is overridden, then the default implementation must be called with super.handlePostChangesError() to restore the Entity post states, as well as notify posted "child" Entities to handle post changes errors.

refreshFKInNewContainees

protected void refreshFKInNewContainees()

This method is invoked by SQLBuilder when one or more of the PrimaryKey attributes are marked refresh-on-insert and DML for this entity has been executed. In this method, this entity checks for existence of composition containees and if found, sets the foreign key attributes on these composed entities to the new values from this Entity.

lock

public void lock()

Locks the row.

If the row is new or already locked by this Entity Object, or if the transaction's locking mode is LOCK_NONE, this method has no effect.

If this Entity Object is contained by another (that is, it is part of a composition association and has a master Entity Object), this method locks the top-most Entity Object in the chain of containers before attempting to lock itself.

This method should not be overridden unless the application is maintaining Entity lock states.

Specified by:: lock in interface Row
Overrides:: lock in class RowImpl

Throws:: AlreadyLockedException - if the row is locked by another user or transaction.; DeadEntityAccessException - if the Entity Object is marked "unusable" or is STATUS_DEAD.

eventsDebugOnly

public boolean eventsDebugOnly()

Indicates whether events are being tested. If it returns true, it implies that Fabric is not present and we should not attempt to actually raise the event. We should just dump its output for testing. If it returns false, the default, Fabric is assumed to be present and we will attempt to raise the appropriate events to Fabric. This is necessary to be able to have adequate error handling in the Fabric case while not interfering with the test case.

outputEventString

public void outputEventString(EventInvocation event)

isAttributeChangedInTransaction

protected final boolean isAttributeChangedInTransaction(int index)

Advanced method: Applications should typically not use this method.

Return true if the attribute at given index was modified in this transaction (even if it's current Changed state is false meaning this value was posted to the DB (but has not been committed).

vetoRemoveWithDetails

protected void vetoRemoveWithDetails(AttributeDef associationDef)

If this Entity Object is a master in a composition association, this method checks that all details have already been removed from the given association attribute. Typically, this method is used to effectively remove compositions.

Parameters:: associationDef - the association attribute defining the composition.
Throws:: RemoveWithDetailsException - if an attempt is made to remove the master Entity Object before removing its children.

removeAndRetain

public void removeAndRetain()

An Entity row does not support removeAndRetain().

Specified by:: removeAndRetain in interface Row
Specified by:: removeAndRetain in class RowImpl

Throws:: InvalidOperException - it is illegal to call this method on an Entity row.

Overview

Package

Class

Tree

Deprecated

Index

Help

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

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.jbo.server Class EntityImpl

DML_INSERT

DML_UPDATE

DML_DELETE

ORACLE_ROWID_COLUMN

CLASS_INSTANCE

EntityImpl

initialize

setEntityDef

getAttributeIndexOf

getKey

getStructureDef

getEntityDef

hasUpdatePrivilege

isAttributeUpdateable

isDead

getAllExceptions

clearAllExceptions

refresh

remove

removeFromCollection

getPostState

getPrimaryKey

isValid

isInvalid

revert

afterCommit

afterRollback

beforeCommit

beforeRollback

addToValidationListeners

setNewRowState

setAttribute

populateAttribute

setAttribute

getEntityState

createEntityViewLinkAccessorVO

getDBTransaction

createAssociationAccessorVO

findEntityViewLinkAccessorVO

findAssociationAccessorVO

getBaseAttributeCount

getEntityCache

getDynamicAttributeCount

getDynamicAttributeValue

setDynamicAttributeValue

createAssociationAccessorRS

createEntityViewLinkAccessorRS

getAttribute

getAttribute

getAttributeInternal

getAttrInvokeAccessor

getPostedAttribute

isAttributeChanged

isOrigDataPopulated

getOrigData

populateAttributeAsChanged

setAttributeChanged

addToTransactionManager

getContainerEntity

doSelectForAltKey

doSelect

getSQLBuilder

buildWhereClause

isTransientTransactionListener

setTransPostHandle

setPostedToDB

getTransPostHandle

isPostedToDB

isTransientTransactionPostListener

doDMLForCascadeUpdate

postChanges

initDefaults

getHistoryContextForAttribute

isAttributePopulated

getAltKey

isInCache

setInvalid

populateAttribute

notifyAttributesChanged

oracle.jbo.server
Class EntityImpl