Purpose: An abstract superclass of some implementations of the OptimisticLockingPolicy interface. All of the subclasses of this class implement OptimisticLocking based on mapped fields in the object. These fields are only compared and not modified. Any modification (incrementing etc..) must be handled by the application.
AllFieldsLockingPolicy, ChangedFieldsLockingPolicy, SelectedFieldsLockingPolicy
| Modifier and Type | Field and Description |
|---|---|
| protected List | |
| protected ClassDescriptor |
| Access | Constructor and Description |
|---|---|
| protected |
| allNonPrimaryKeyFields | back to summary |
|---|---|
| protected List<DatabaseField> allNonPrimaryKeyFields | |
| descriptor | back to summary |
|---|---|
| protected ClassDescriptor descriptor | |
| FieldsLockingPolicy | back to summary |
|---|---|
| protected FieldsLockingPolicy() PUBLIC: Create a new field locking policy. A field locking policy is based on locking on a subset of fields by comparing with their previous values to detect field-level collisions. Note the unit of work must be used for all updates when using field locking. | |
| addLockFieldsToUpdateRow | back to summary |
|---|---|
| public void addLockFieldsToUpdateRow(AbstractRecord Record, AbstractSession session) Implements org. INTERNAL: Add update fields for template row. These are any unmapped fields required to write in an update. Since all fields are mapped, there is nothing required.
| |
| addLockValuesToTranslationRow | back to summary |
|---|---|
| public abstract void addLockValuesToTranslationRow(ObjectLevelModifyQuery query) Redeclares org. INTERNAL: Values to be included in the locking mechanism are added to the translation row. Set the translation row to all the original field values.
| |
| buildAllNonPrimaryKeyFields | back to summary |
|---|---|
| protected List INTERNAL: Returns the fields that should be compared in the where clause. In this case, it is all the fields, except for the primary key and class indicator fields. This is called during lazy initialization. | |
| buildDeleteExpression | back to summary |
|---|---|
| public Expression buildDeleteExpression(DatabaseTable table, Expression mainExpression, AbstractRecord row) Implements org. INTERNAL: When given an expression, this method will return a new expression with the optimistic locking values included. The values are taken from the passed in database row. This expression will be used in a delete call.
| |
| buildExpression | back to summary |
|---|---|
| protected Expression buildExpression(DatabaseTable table, AbstractRecord transRow, AbstractRecord modifyRow, ExpressionBuilder builder) INTERNAL: returns the expression to be used in both the delete and update where clause. | |
| buildUpdateExpression | back to summary |
|---|---|
| public Expression buildUpdateExpression(DatabaseTable table, Expression mainExpression, AbstractRecord transRow, AbstractRecord modifyRow) Implements org. INTERNAL: This method must be included in any locking policy. When given an expression, this method will return a new expression with the optimistic locking values included. The values are taken from the passed in database row. This expression will be used in a delete call.
| |
| clone | back to summary |
|---|---|
| public Object clone() Overrides java. Implements org. INTERNAL: Clone the policy
| |
| compareWriteLockValues | back to summary |
|---|---|
| public int compareWriteLockValues(Object value1, Object value2) Implements org. INTERNAL: This method shouldn't be called if supportsWriteLockValuesComparison() returns false. This method compares two writeLockValues. The writeLockValues should be non-null and of the correct type. Returns: -1 if value1 is less (older) than value2; 0 if value1 equals value2; 1 if value1 is greater (newer) than value2. Throws: NullPointerException if the passed value is null; ClassCastException if the passed value is of a wrong type.
| |
| getAllNonPrimaryKeyFields | back to summary |
|---|---|
| protected List INTERNAL: Returns the fields that should be compared in the where clause. In this case, it is all the fields, except for the primary key and class indicator field. | |
| getAllNonPrimaryKeyFields | back to summary |
|---|---|
| protected List INTERNAL: filter the fields based on the passed in table. Only return fields of this table. | |
| getBaseValue | back to summary |
|---|---|
| public <T> T getBaseValue() Implements org. INTERNAL: This is the base value that is older than all other values, it is used in the place of null in some situations.
| |
| getFieldsToCompare | back to summary |
|---|---|
| protected abstract List INTERNAL: Returns the fields that should be compared in the where clause. This method must be implemented by the subclass | |
| getLockOnChangeMode | back to summary |
|---|---|
| public OptimisticLockingPolicy. Implements org. ADVANCED: returns the LockOnChange mode for this policy. This mode specifies if a Optimistic Write lock should be enforced on this entity when a set of mappings are changed. Unfortunately this locking policy can not enforce an optimistic write lock unless a FK or DTF field has changed so this type returns LockOnChange.NONE
| |
| getValueToPutInCache | back to summary |
|---|---|
| public <T> T getValueToPutInCache(AbstractRecord row, AbstractSession session) Implements org. INTERNAL: Return the value that should be stored in the identity map. If the value is stored in the object, then return a null.
| |
| getVersionDifference | back to summary |
|---|---|
| public int getVersionDifference(Object currentValue, Object domainObject, Object primaryKeys, AbstractSession session) Implements org. INTERNAL: Return the number of version difference between the two states of the object.
| |
| getWriteLockField | back to summary |
|---|---|
| public DatabaseField getWriteLockField() Implements org. INTERNAL: Return the write lock field.
| |
| getWriteLockUpdateExpression | back to summary |
|---|---|
| public Expression getWriteLockUpdateExpression(ExpressionBuilder builder, AbstractSession session) Implements org. INTERNAL:
| |
| getWriteLockValue | back to summary |
|---|---|
| public <T> T getWriteLockValue(Object domainObject, Object primaryKey, AbstractSession session) Implements org. INTERNAL: This method will return the optimistic lock value for the object
| |
| initialize | back to summary |
|---|---|
| public void initialize(AbstractSession session) Implements org. INTERNAL: It is responsible for initializing the policy;
| |
| initializeProperties | back to summary |
|---|---|
| public void initializeProperties() Implements org. INTERNAL: It is responsible for initializing the policy;
| |
| isCascaded | back to summary |
|---|---|
| public boolean isCascaded() Implements org. PUBLIC: Return true if the policy uses cascade locking. Currently, not supported on this policy at this time.
| |
| isNewerVersion | back to summary |
|---|---|
| public boolean isNewerVersion(Object currentValue, Object domainObject, Object primaryKey, AbstractSession session) Implements org. INTERNAL: Compares the value and the value from the object (or cache). Will return true if the object is newer than the row.
| |
| isNewerVersion | back to summary |
|---|---|
| public boolean isNewerVersion(AbstractRecord Record, Object domainObject, Object primaryKey, AbstractSession session) Implements org. INTERNAL: Compares the value from the row and from the object (or cache). Will return true if the object is newer than the row.
| |
| isPrimaryKey | back to summary |
|---|---|
| protected boolean isPrimaryKey(DatabaseField dbField) INTERNAL: Returns whether or not this field is a primary key. This method will also return true for secondary table primarykeys | |
| isStoredInCache | back to summary |
|---|---|
| public boolean isStoredInCache() Implements org. PUBLIC: Return true if the lock value is stored in the cache.
| |
| mergeIntoParentCache | back to summary |
|---|---|
| public void mergeIntoParentCache(UnitOfWorkImpl uow, Object primaryKey, Object object) Implements org. INTERNAL: Only applicable when the value is stored in the cache.
| |
| mergeIntoParentCache | back to summary |
|---|---|
| public void mergeIntoParentCache(CacheKey unitOfWorkCacheKey, CacheKey parentSessionCacheKey) Implements org. INTERNAL: This method should merge changes from the parent into the child. #see this method in VersionLockingPolicy
| |
| setAllNonPrimaryKeyFields | back to summary |
|---|---|
| protected void setAllNonPrimaryKeyFields(List<DatabaseField> allNonPrimaryKeyFields) INTERNAL: Set method for all the primary keys | |
| setDescriptor | back to summary |
|---|---|
| public void setDescriptor(ClassDescriptor descriptor) Implements org. INTERNAL: Set method for the descriptor
| |
| setLockOnChangeMode | back to summary |
|---|---|
| public void setLockOnChangeMode(OptimisticLockingPolicy. Implements org. ADVANCED: Sets the LockOnChange mode for this policy. This mode specifies if a Optimistic Write lock should be enforced on this entity when set of mappings are changed. Unfortunately this locking policy can not always force an optimistic lock unless the core fields have changed
| |
| setupWriteFieldsForInsert | back to summary |
|---|---|
| public void setupWriteFieldsForInsert(ObjectLevelModifyQuery query) Implements org. INTERNAL: Put the initial writelock value into the modifyRow. There is nothing to do because all the lock values are in the mappings.
| |
| shouldUpdateVersionOnMappingChange | back to summary |
|---|---|
| public boolean shouldUpdateVersionOnMappingChange() Implements org. INTERNAL: Returns true if the policy has been set to set an optimistic read lock when any mapping changes. Unfortunately this locking policy can not always force an optimistic lock unless the core fields have changed
| |
| shouldUpdateVersionOnOwnedMappingChange | back to summary |
|---|---|
| public boolean shouldUpdateVersionOnOwnedMappingChange() Implements org. INTERNAL: Returns true if the policy has been set to set an optimistic read lock when a owning mapping changes. Unfortunately this locking policy can not always force an optimistic lock unless the core fields have changed
| |
| supportsWriteLockValuesComparison | back to summary |
|---|---|
| public boolean supportsWriteLockValuesComparison() Implements org. INTERNAL: Indicates whether compareWriteLockValues method is supported by the policy. Numeric or timestamp lock values could be compared: for every pair of values v1 and v2 - either v1<v2; or v1==v2; or v1>v2. However it's impossible to compare values for FieldsLockingPolicy for two reasons: 1. there is no "linear order": v1<v2 and v>v2 is not defined: either v1==v2 or v1!=v2; 2. locking value is not a single field which is not part of mapped object value but rather a set of object's mapped fields. That means any object's mapped attribute change is potentially a change of the locking value. For ChangedFieldsLockingPolicy every mapped attribute's change is a change of locking value. The pattern used by versioning: "if the original locking value is unchanged then the object hasn't been changed outside of the application", which allows to distinguish between the change made inside and outside the application, doesn't work for fields locking. It degenerates into useless pattern: "if the original locking value is unchanged then the object hasn't been changed". Use compareWriteLockValues method only if this method returns true.
| |
| updateRowAndObjectForUpdate | back to summary |
|---|---|
| public void updateRowAndObjectForUpdate(ObjectLevelModifyQuery query, Object domainObject) Implements org. INTERNAL: Nothing to do because all updates are handled by the application
| |
| validateDelete | back to summary |
|---|---|
| public void validateDelete(int rowCount, Object object, DeleteObjectQuery query) Implements org. INTERNAL: Check the row count for lock failure.
| |
| validateUpdate | back to summary |
|---|---|
| public void validateUpdate(int rowCount, Object object, WriteObjectQuery query) Implements org. INTERNAL: Check the row count for lock failure.
| |
| verifyUsage | back to summary |
|---|---|
| protected void verifyUsage(AbstractSession session) INTERNAL: throw an exception if not inside a unit of work at this point | |