Module eclipselink

Package org.eclipse.persistence.descriptors

Class TimestampLockingPolicy

java.lang.Object

org.eclipse.persistence.descriptors.VersionLockingPolicy

org.eclipse.persistence.descriptors.AbstractTsLockingPolicy<Timestamp>

org.eclipse.persistence.descriptors.TimestampLockingPolicy

All Implemented Interfaces:

Serializable, Cloneable, org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy

public class TimestampLockingPolicy
extends AbstractTsLockingPolicy<Timestamp>

Purpose: Used to allow a single version timestamp to be used for optimistic locking.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy

org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy.LockOnChange

Field Summary

Fields inherited from class org.eclipse.persistence.descriptors.AbstractTsLockingPolicy

LOCAL_TIME, SERVER_TIME

Fields inherited from class org.eclipse.persistence.descriptors.VersionLockingPolicy

cachedExpression, descriptor, IN_CACHE, IN_OBJECT, isCascaded, lockMapping, lockOnChangeMode, lockValueStored, writeLockField

Constructor Summary

Constructors

Constructor	Description
TimestampLockingPolicy()	Create a new TimestampLockingPolicy.
TimestampLockingPolicy(String fieldName)	Create a new TimestampLockingPolicy.

Method Summary

Modifier and Type	Method	Description
int	getVersionDifference(Object currentValue, Object domainObject, Object primaryKeys, org.eclipse.persistence.internal.sessions.AbstractSession session)	INTERNAL: Return the number of versions different between these objects.

Methods inherited from class org.eclipse.persistence.descriptors.AbstractTsLockingPolicy

compareWriteLockValues, create, getBaseValue, getDefaultLockingFieldType, getInitialWriteValue, getNewLockValue, getValueToPutInCache, getWriteLockUpdateExpression, getWriteLockValue, incrementWriteLockValue, isNewerVersion, isNewerVersion, isNewerVersion, setUsesServerTime, useLocalTime, useServerTime, usesLocalTime, usesServerTime

Methods inherited from class org.eclipse.persistence.descriptors.VersionLockingPolicy

addLockFieldsToUpdateRow, addLockValuesToTranslationRow, buildDeleteExpression, buildExpression, buildUpdateExpression, clone, getDescriptor, getLockOnChangeMode, getUnmappedFields, getVersion, getVersionMapping, getWriteLockField, getWriteLockFieldName, initialize, initializeProperties, isCascaded, isStoredInCache, isStoredInObject, lockValueFromObject, mergeIntoParentCache, mergeIntoParentCache, setDescriptor, setIsCascaded, setIsStoredInCache, setLockOnChangeMode, setupWriteFieldsForInsert, setWriteLockField, setWriteLockFieldName, shouldUpdateVersionOnMappingChange, shouldUpdateVersionOnOwnedMappingChange, storeInCache, storeInObject, supportsWriteLockValuesComparison, updateObjectWithWriteValue, updateRowAndObjectForUpdate, updateWriteLockValueForWrite, validateDelete, validateUpdate, writeLockValueIntoRow

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TimestampLockingPolicy

public TimestampLockingPolicy()

Create a new TimestampLockingPolicy. Defaults to using the time retrieved from the server.

TimestampLockingPolicy

public TimestampLockingPolicy(String fieldName)

Create a new TimestampLockingPolicy. Defaults to using the time retrieved from the server.

Parameters:

fieldName - the field where the write lock value will be stored

Method Details

getVersionDifference

public int getVersionDifference(Object currentValue,
 Object domainObject,
 Object primaryKeys,
 org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Return the number of versions different between these objects.

Specified by:

getVersionDifference in interface org.eclipse.persistence.internal.descriptors.OptimisticLockingPolicy

Overrides:

getVersionDifference in class VersionLockingPolicy

Parameters:

currentValue - the new lock value

domainObject - the object containing the version to be compared to

primaryKeys - a vector containing the primary keys of the domainObject

session - the session to be used with the comparison