Package org.apache.openjpa.kernel
Class ObjectIdStateManager
- java.lang.Object
-
- org.apache.openjpa.kernel.ObjectIdStateManager
-
- All Implemented Interfaces:
FieldConsumer
,FieldManager
,FieldSupplier
,StateManager
,OpenJPAStateManager
public class ObjectIdStateManager extends java.lang.Object implements OpenJPAStateManager
State manager used to access state of embedded object id primary key fields.- Author:
- Abe White
-
-
Field Summary
-
Fields inherited from interface org.apache.openjpa.kernel.OpenJPAStateManager
SET_ATTACH, SET_REMOTE, SET_USER
-
-
Constructor Summary
Constructors Constructor Description ObjectIdStateManager(java.lang.Object oid, OpenJPAStateManager owner, ValueMetaData ownerVal)
Constructor; supply embedded object id and its owner.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accessingField(int idx)
Field access callback.boolean
assignObjectId(boolean flush)
Ask the store manager to assign a permanent oid to this new instance.boolean
beforeRefresh(boolean all)
Prepare the instance for refreshvoid
dirty(int field)
Mark the given field as dirty.void
dirty(java.lang.String field)
Make named field dirty.java.lang.Object
fetch(int field)
Return the externalized value of the field with the given index as an object.boolean
fetchBoolean(int field)
Return the external value of the given field.boolean
fetchBooleanField(int field)
Return the value of the given field.byte
fetchByte(int field)
Return the external value of the given field.byte
fetchByteField(int field)
Return the value of the given field.char
fetchChar(int field)
Return the external value of the given field.char
fetchCharField(int field)
Return the value of the given field.double
fetchDouble(int field)
Return the external value of the given field.double
fetchDoubleField(int field)
Return the value of the given field.java.lang.Object
fetchField(int field, boolean transitions)
Return the value of the field with the given index as an object.float
fetchFloat(int field)
Return the external value of the given field.float
fetchFloatField(int field)
Return the value of the given field.java.lang.Object
fetchInitialField(int field)
Return the value of the field at the specified index as of the beginning of the transaction.int
fetchInt(int field)
Return the external value of the given field.int
fetchIntField(int field)
Return the value of the given field.long
fetchLong(int field)
Return the external value of the given field.long
fetchLongField(int field)
Return the value of the given field.java.lang.Object
fetchObject(int field)
Return the external value of the given field.java.lang.Object
fetchObjectField(int field)
Fetch an object field by index.java.lang.Object
fetchObjectId()
Return the object id, assigning it if necessary.short
fetchShort(int field)
Return the external value of the given field.short
fetchShortField(int field)
Return the value of the given field.java.lang.String
fetchString(int field)
Return the external value of the given field.java.lang.String
fetchStringField(int field)
Return the value of the given field.StoreContext
getContext()
Return the managing context.java.util.BitSet
getDirty()
Return a read-only mask of the indexes of all dirty fields.java.util.BitSet
getFlushed()
Return a read-only mask of the indexes of all fields that have been flushed since they were last changed.java.lang.Object
getGenericContext()
Persistence context.java.lang.Object
getId()
Return the identifier for this state manager.java.lang.Object
getImplData()
An object that concrete back ends can associate with each instance.java.lang.Object
getImplData(int field)
Field-level impl data.java.lang.Object
getIntermediate(int field)
Use intermediate field data to store intermediate information that might be available before the field is fully loaded.java.util.BitSet
getLoaded()
Return a read-only mask of the indexes of all loaded fields.java.lang.Object
getLock()
The lock object set for this instance.java.lang.Object
getManagedInstance()
Return the managed instance.ClassMetaData
getMetaData()
Get the metadata for this instance.java.lang.Object
getObjectId()
Return the instance's object id.OpenJPAStateManager
getOwner()
Return the owning state if this is an embedded instance.int
getOwnerIndex()
Return the owning value's field indexjava.lang.Object
getPCPrimaryKey(java.lang.Object oid, int field)
Return the persistence-capable primary key object by extracting the identity value of the related instance stored in the given field from the given object id.PCState
getPCState()
Return the state that this object is in.PersistenceCapable
getPersistenceCapable()
Return thePersistenceCapable
instance that provides access to the instance managed by this state manager.java.util.BitSet
getUnloaded(FetchConfiguration fetch)
Return a mutable mask of the unloaded fields that need loading based on the given fetch configuration.java.lang.Object
getVersion()
Return the current version indicator for this instance.void
initialize(java.lang.Class forType, PCState state)
Initialize the state manager with a new instance of the given persistence capable type and the proper lifecycle state.boolean
isDefaultValue(int field)
Return true if the given field has a default value.boolean
isDelayed(int field)
Some field types (collection proxies) support delayed loading.boolean
isDeleted()
Whether the instance is deleted in this transaction.boolean
isDetached()
Whether the instance is detached (i.e. this manager is a detached state manager)boolean
isDirty()
Whether the instance has been modified in this transaction.boolean
isEmbedded()
Return true if this instance has an owner, meaning it is an embedded value.boolean
isFlushed()
Return whether this object has been flushed to the datastore in this transaction.boolean
isFlushedDirty()
Return whether this object has been flushed, then dirtied again.boolean
isImplDataCacheable()
Whether the instance-level impl data can be shared among instances in different contexts if L2 caching is enabled.boolean
isImplDataCacheable(int field)
Whether the field's impl data is loaded and can be shared among instances in different contexts if L2 caching is enabled.boolean
isNew()
Whether the instance is newly-persisted in this transaction.boolean
isPersistent()
Whether the instance is persistent.boolean
isProvisional()
Return whether this object is provisionally persistent.boolean
isTransactional()
Whether the instance is transactional.boolean
isVersionCheckRequired()
Returns true if this state needs to issue a version check at flush time.boolean
isVersionUpdateRequired()
Returns true if this state needs to issue a version update, possibly as a result of being locked.void
load(FetchConfiguration fetch)
Load fetch group fields.void
loadDelayedField(int field)
If a field was marked delayed in a previous load operation this method can be used to load the field.void
lock()
java.lang.Object
newFieldProxy(int field)
Create a new hollow proxy instance for the given field.java.lang.Object
newProxy(int field)
Create a new hollow proxy instance for the given field.void
providedBooleanField(PersistenceCapable pc, int idx, boolean cur)
Provide state callback.void
providedByteField(PersistenceCapable pc, int idx, byte cur)
Provide state callback.void
providedCharField(PersistenceCapable pc, int idx, char cur)
Provide state callback.void
providedDoubleField(PersistenceCapable pc, int idx, double cur)
Provide state callback.void
providedFloatField(PersistenceCapable pc, int idx, float cur)
Provide state callback.void
providedIntField(PersistenceCapable pc, int idx, int cur)
Provide state callback.void
providedLongField(PersistenceCapable pc, int idx, long cur)
Provide state callback.void
providedObjectField(PersistenceCapable pc, int idx, java.lang.Object cur)
Provide state callback.void
providedShortField(PersistenceCapable pc, int idx, short cur)
Provide state callback.void
providedStringField(PersistenceCapable pc, int idx, java.lang.String cur)
Provide state callback.void
proxyDetachedDeserialized(int idx)
Proxy the given detached field after deserialization.void
removed(int field, java.lang.Object removed, boolean key)
Notification that an element has been removed from the given field.boolean
replaceBooleanField(PersistenceCapable pc, int idx)
Replace state callback.byte
replaceByteField(PersistenceCapable pc, int idx)
Replace state callback.char
replaceCharField(PersistenceCapable pc, int idx)
Replace state callback.double
replaceDoubleField(PersistenceCapable pc, int idx)
Replace state callback.float
replaceFloatField(PersistenceCapable pc, int idx)
Replace state callback.int
replaceIntField(PersistenceCapable pc, int idx)
Replace state callback.long
replaceLongField(PersistenceCapable pc, int idx)
Replace state callback.java.lang.Object
replaceObjectField(PersistenceCapable pc, int idx)
Replace state callback.short
replaceShortField(PersistenceCapable pc, int idx)
Replace state callback.StateManager
replaceStateManager(StateManager sm)
Change state manager.java.lang.String
replaceStringField(PersistenceCapable pc, int idx)
Replace state callback.boolean
serializing()
Callback to prepare instance for serialization.void
setDelayed(int field, boolean delay)
Some field types (collection proxies) support delayed loading.java.lang.Object
setImplData(int field, java.lang.Object data)
Field-level impl data.java.lang.Object
setImplData(java.lang.Object data, boolean cacheable)
An object that concrete back ends can associate with each instance.void
setIntermediate(int field, java.lang.Object data)
Use intermediate field data to store intermediate information that might be available before the field is fully loaded.void
setLock(java.lang.Object lock)
The lock object set for this instance.void
setNextVersion(java.lang.Object version)
Set the next version indicator in the datastore pending a successful flush.void
setObjectId(java.lang.Object oid)
Set the object id for the managed instance.void
setRemote(int field, java.lang.Object value)
Set the given field to the given value.void
settingBooleanField(PersistenceCapable pc, int idx, boolean cur, boolean next, int set)
Setting state callback.void
settingByteField(PersistenceCapable pc, int idx, byte cur, byte next, int set)
Setting state callback.void
settingCharField(PersistenceCapable pc, int idx, char cur, char next, int set)
Setting state callback.void
settingDoubleField(PersistenceCapable pc, int idx, double cur, double next, int set)
Setting state callback.void
settingFloatField(PersistenceCapable pc, int idx, float cur, float next, int set)
Setting state callback.void
settingIntField(PersistenceCapable pc, int idx, int cur, int next, int set)
Setting state callback.void
settingLongField(PersistenceCapable pc, int idx, long cur, long next, int set)
Setting state callback.void
settingObjectField(PersistenceCapable pc, int idx, java.lang.Object cur, java.lang.Object next, int set)
Setting state callback.void
settingShortField(PersistenceCapable pc, int idx, short cur, short next, int set)
Setting state callback.void
settingStringField(PersistenceCapable pc, int idx, java.lang.String cur, java.lang.String next, int set)
Setting state callback.void
setVersion(java.lang.Object version)
Set the version indicator for this instance, as loaded from the data store.void
store(int field, java.lang.Object extVal)
Set the value of the field with the given index as from the external object value.void
storeBoolean(int field, boolean extVal)
Set the given external value back into the given field.void
storeBooleanField(int field, boolean extVal)
Set the value of the given field.void
storeByte(int field, byte extVal)
Set the given external value back into the given field.void
storeByteField(int field, byte extVal)
Set the value of the given field.void
storeChar(int field, char extVal)
Set the given external value back into the given field.void
storeCharField(int field, char extVal)
Set the value of the given field.void
storeDouble(int field, double extVal)
Set the given external value back into the given field.void
storeDoubleField(int field, double extVal)
Set the value of the given field.void
storeField(int field, java.lang.Object value)
Set the value of the field with the given index as an object.void
storeFloat(int field, float extVal)
Set the given external value back into the given field.void
storeFloatField(int field, float extVal)
Set the value of the given field.void
storeInt(int field, int extVal)
Set the given external value back into the given field.void
storeIntField(int field, int extVal)
Set the value of the given field.void
storeLong(int field, long extVal)
Set the given external value back into the given field.void
storeLongField(int field, long extVal)
Set the value of the given field.void
storeObject(int field, java.lang.Object extVal)
Set the given external value back into the given field.void
storeObjectField(int field, java.lang.Object extVal)
Set the value of the given field.void
storeShort(int field, short extVal)
Set the given external value back into the given field.void
storeShortField(int field, short extVal)
Set the value of the given field.void
storeString(int field, java.lang.String extVal)
Set the given external value back into the given field.void
storeStringField(int field, java.lang.String extVal)
Set the value of the given field.void
unlock()
boolean
writeDetached(java.io.ObjectOutput out)
Write detached state object and detached state manager to the given stream.
-
-
-
Constructor Detail
-
ObjectIdStateManager
public ObjectIdStateManager(java.lang.Object oid, OpenJPAStateManager owner, ValueMetaData ownerVal)
Constructor; supply embedded object id and its owner.- Parameters:
owner
- may be null
-
-
Method Detail
-
getGenericContext
public java.lang.Object getGenericContext()
Description copied from interface:StateManager
Persistence context.- Specified by:
getGenericContext
in interfaceStateManager
-
getPCPrimaryKey
public java.lang.Object getPCPrimaryKey(java.lang.Object oid, int field)
Description copied from interface:StateManager
Return the persistence-capable primary key object by extracting the identity value of the related instance stored in the given field from the given object id.- Specified by:
getPCPrimaryKey
in interfaceStateManager
-
replaceStateManager
public StateManager replaceStateManager(StateManager sm)
Description copied from interface:StateManager
Change state manager.- Specified by:
replaceStateManager
in interfaceStateManager
-
getVersion
public java.lang.Object getVersion()
Description copied from interface:OpenJPAStateManager
Return the current version indicator for this instance.- Specified by:
getVersion
in interfaceOpenJPAStateManager
- Specified by:
getVersion
in interfaceStateManager
-
setVersion
public void setVersion(java.lang.Object version)
Description copied from interface:OpenJPAStateManager
Set the version indicator for this instance, as loaded from the data store. This method is used by theStoreManager
when loading instance data. On rollback, the version will be rolled back to this value. Version objects should be serializable and should not require vendor-specific classes, because they are transferred to detached objects.- Specified by:
setVersion
in interfaceOpenJPAStateManager
-
isDirty
public boolean isDirty()
Description copied from interface:StateManager
Whether the instance has been modified in this transaction.- Specified by:
isDirty
in interfaceStateManager
-
isTransactional
public boolean isTransactional()
Description copied from interface:StateManager
Whether the instance is transactional.- Specified by:
isTransactional
in interfaceStateManager
-
isPersistent
public boolean isPersistent()
Description copied from interface:StateManager
Whether the instance is persistent.- Specified by:
isPersistent
in interfaceStateManager
-
isNew
public boolean isNew()
Description copied from interface:StateManager
Whether the instance is newly-persisted in this transaction.- Specified by:
isNew
in interfaceStateManager
-
isDeleted
public boolean isDeleted()
Description copied from interface:StateManager
Whether the instance is deleted in this transaction.- Specified by:
isDeleted
in interfaceStateManager
-
isDetached
public boolean isDetached()
Description copied from interface:StateManager
Whether the instance is detached (i.e. this manager is a detached state manager)- Specified by:
isDetached
in interfaceStateManager
-
isVersionUpdateRequired
public boolean isVersionUpdateRequired()
Description copied from interface:OpenJPAStateManager
Returns true if this state needs to issue a version update, possibly as a result of being locked.- Specified by:
isVersionUpdateRequired
in interfaceOpenJPAStateManager
-
isVersionCheckRequired
public boolean isVersionCheckRequired()
Description copied from interface:OpenJPAStateManager
Returns true if this state needs to issue a version check at flush time.- Specified by:
isVersionCheckRequired
in interfaceOpenJPAStateManager
-
dirty
public void dirty(java.lang.String field)
Description copied from interface:StateManager
Make named field dirty.- Specified by:
dirty
in interfaceStateManager
-
fetchObjectId
public java.lang.Object fetchObjectId()
Description copied from interface:StateManager
Return the object id, assigning it if necessary.- Specified by:
fetchObjectId
in interfaceStateManager
-
accessingField
public void accessingField(int idx)
Description copied from interface:StateManager
Field access callback.- Specified by:
accessingField
in interfaceStateManager
-
serializing
public boolean serializing()
Description copied from interface:StateManager
Callback to prepare instance for serialization.- Specified by:
serializing
in interfaceStateManager
- Returns:
- true to null detached state after serialize
-
writeDetached
public boolean writeDetached(java.io.ObjectOutput out) throws java.io.IOException
Description copied from interface:StateManager
Write detached state object and detached state manager to the given stream.- Specified by:
writeDetached
in interfaceStateManager
- Returns:
- true if managed fields also written to stream
- Throws:
java.io.IOException
-
proxyDetachedDeserialized
public void proxyDetachedDeserialized(int idx)
Description copied from interface:StateManager
Proxy the given detached field after deserialization.- Specified by:
proxyDetachedDeserialized
in interfaceStateManager
-
settingBooleanField
public void settingBooleanField(PersistenceCapable pc, int idx, boolean cur, boolean next, int set)
Description copied from interface:StateManager
Setting state callback.- Specified by:
settingBooleanField
in interfaceStateManager
-
settingCharField
public void settingCharField(PersistenceCapable pc, int idx, char cur, char next, int set)
Description copied from interface:StateManager
Setting state callback.- Specified by:
settingCharField
in interfaceStateManager
-
settingByteField
public void settingByteField(PersistenceCapable pc, int idx, byte cur, byte next, int set)
Description copied from interface:StateManager
Setting state callback.- Specified by:
settingByteField
in interfaceStateManager
-
settingShortField
public void settingShortField(PersistenceCapable pc, int idx, short cur, short next, int set)
Description copied from interface:StateManager
Setting state callback.- Specified by:
settingShortField
in interfaceStateManager
-
settingIntField
public void settingIntField(PersistenceCapable pc, int idx, int cur, int next, int set)
Description copied from interface:StateManager
Setting state callback.- Specified by:
settingIntField
in interfaceStateManager
-
settingLongField
public void settingLongField(PersistenceCapable pc, int idx, long cur, long next, int set)
Description copied from interface:StateManager
Setting state callback.- Specified by:
settingLongField
in interfaceStateManager
-
settingFloatField
public void settingFloatField(PersistenceCapable pc, int idx, float cur, float next, int set)
Description copied from interface:StateManager
Setting state callback.- Specified by:
settingFloatField
in interfaceStateManager
-
settingDoubleField
public void settingDoubleField(PersistenceCapable pc, int idx, double cur, double next, int set)
Description copied from interface:StateManager
Setting state callback.- Specified by:
settingDoubleField
in interfaceStateManager
-
settingStringField
public void settingStringField(PersistenceCapable pc, int idx, java.lang.String cur, java.lang.String next, int set)
Description copied from interface:StateManager
Setting state callback.- Specified by:
settingStringField
in interfaceStateManager
-
settingObjectField
public void settingObjectField(PersistenceCapable pc, int idx, java.lang.Object cur, java.lang.Object next, int set)
Description copied from interface:StateManager
Setting state callback.- Specified by:
settingObjectField
in interfaceStateManager
-
providedBooleanField
public void providedBooleanField(PersistenceCapable pc, int idx, boolean cur)
Description copied from interface:StateManager
Provide state callback.- Specified by:
providedBooleanField
in interfaceStateManager
-
providedCharField
public void providedCharField(PersistenceCapable pc, int idx, char cur)
Description copied from interface:StateManager
Provide state callback.- Specified by:
providedCharField
in interfaceStateManager
-
providedByteField
public void providedByteField(PersistenceCapable pc, int idx, byte cur)
Description copied from interface:StateManager
Provide state callback.- Specified by:
providedByteField
in interfaceStateManager
-
providedShortField
public void providedShortField(PersistenceCapable pc, int idx, short cur)
Description copied from interface:StateManager
Provide state callback.- Specified by:
providedShortField
in interfaceStateManager
-
providedIntField
public void providedIntField(PersistenceCapable pc, int idx, int cur)
Description copied from interface:StateManager
Provide state callback.- Specified by:
providedIntField
in interfaceStateManager
-
providedLongField
public void providedLongField(PersistenceCapable pc, int idx, long cur)
Description copied from interface:StateManager
Provide state callback.- Specified by:
providedLongField
in interfaceStateManager
-
providedFloatField
public void providedFloatField(PersistenceCapable pc, int idx, float cur)
Description copied from interface:StateManager
Provide state callback.- Specified by:
providedFloatField
in interfaceStateManager
-
providedDoubleField
public void providedDoubleField(PersistenceCapable pc, int idx, double cur)
Description copied from interface:StateManager
Provide state callback.- Specified by:
providedDoubleField
in interfaceStateManager
-
providedStringField
public void providedStringField(PersistenceCapable pc, int idx, java.lang.String cur)
Description copied from interface:StateManager
Provide state callback.- Specified by:
providedStringField
in interfaceStateManager
-
providedObjectField
public void providedObjectField(PersistenceCapable pc, int idx, java.lang.Object cur)
Description copied from interface:StateManager
Provide state callback.- Specified by:
providedObjectField
in interfaceStateManager
-
replaceBooleanField
public boolean replaceBooleanField(PersistenceCapable pc, int idx)
Description copied from interface:StateManager
Replace state callback.- Specified by:
replaceBooleanField
in interfaceStateManager
-
replaceCharField
public char replaceCharField(PersistenceCapable pc, int idx)
Description copied from interface:StateManager
Replace state callback.- Specified by:
replaceCharField
in interfaceStateManager
-
replaceByteField
public byte replaceByteField(PersistenceCapable pc, int idx)
Description copied from interface:StateManager
Replace state callback.- Specified by:
replaceByteField
in interfaceStateManager
-
replaceShortField
public short replaceShortField(PersistenceCapable pc, int idx)
Description copied from interface:StateManager
Replace state callback.- Specified by:
replaceShortField
in interfaceStateManager
-
replaceIntField
public int replaceIntField(PersistenceCapable pc, int idx)
Description copied from interface:StateManager
Replace state callback.- Specified by:
replaceIntField
in interfaceStateManager
-
replaceLongField
public long replaceLongField(PersistenceCapable pc, int idx)
Description copied from interface:StateManager
Replace state callback.- Specified by:
replaceLongField
in interfaceStateManager
-
replaceFloatField
public float replaceFloatField(PersistenceCapable pc, int idx)
Description copied from interface:StateManager
Replace state callback.- Specified by:
replaceFloatField
in interfaceStateManager
-
replaceDoubleField
public double replaceDoubleField(PersistenceCapable pc, int idx)
Description copied from interface:StateManager
Replace state callback.- Specified by:
replaceDoubleField
in interfaceStateManager
-
replaceStringField
public java.lang.String replaceStringField(PersistenceCapable pc, int idx)
Description copied from interface:StateManager
Replace state callback.- Specified by:
replaceStringField
in interfaceStateManager
-
replaceObjectField
public java.lang.Object replaceObjectField(PersistenceCapable pc, int idx)
Description copied from interface:StateManager
Replace state callback.- Specified by:
replaceObjectField
in interfaceStateManager
-
initialize
public void initialize(java.lang.Class forType, PCState state)
Description copied from interface:OpenJPAStateManager
Initialize the state manager with a new instance of the given persistence capable type and the proper lifecycle state. Invoking this method may change the object id and metadata for the state manager, as the concrete type specified in the parameter may be a subclass of the expected type.- Specified by:
initialize
in interfaceOpenJPAStateManager
- Parameters:
forType
- the type for which to create a new instancestate
- the initial state to which to set the instance
-
load
public void load(FetchConfiguration fetch)
Description copied from interface:OpenJPAStateManager
Load fetch group fields.- Specified by:
load
in interfaceOpenJPAStateManager
-
getManagedInstance
public java.lang.Object getManagedInstance()
Description copied from interface:OpenJPAStateManager
Return the managed instance.- Specified by:
getManagedInstance
in interfaceOpenJPAStateManager
-
getPersistenceCapable
public PersistenceCapable getPersistenceCapable()
Description copied from interface:OpenJPAStateManager
Return thePersistenceCapable
instance that provides access to the instance managed by this state manager. May be a proxy around the actual managed instance.- Specified by:
getPersistenceCapable
in interfaceOpenJPAStateManager
-
getMetaData
public ClassMetaData getMetaData()
Description copied from interface:OpenJPAStateManager
Get the metadata for this instance.- Specified by:
getMetaData
in interfaceOpenJPAStateManager
-
getOwner
public OpenJPAStateManager getOwner()
Description copied from interface:OpenJPAStateManager
Return the owning state if this is an embedded instance.- Specified by:
getOwner
in interfaceOpenJPAStateManager
-
getOwnerIndex
public int getOwnerIndex()
Description copied from interface:OpenJPAStateManager
Return the owning value's field index- Specified by:
getOwnerIndex
in interfaceOpenJPAStateManager
-
isEmbedded
public boolean isEmbedded()
Description copied from interface:OpenJPAStateManager
Return true if this instance has an owner, meaning it is an embedded value.- Specified by:
isEmbedded
in interfaceOpenJPAStateManager
-
isFlushed
public boolean isFlushed()
Description copied from interface:OpenJPAStateManager
Return whether this object has been flushed to the datastore in this transaction.- Specified by:
isFlushed
in interfaceOpenJPAStateManager
-
isFlushedDirty
public boolean isFlushedDirty()
Description copied from interface:OpenJPAStateManager
Return whether this object has been flushed, then dirtied again.- Specified by:
isFlushedDirty
in interfaceOpenJPAStateManager
-
isProvisional
public boolean isProvisional()
Description copied from interface:OpenJPAStateManager
Return whether this object is provisionally persistent.- Specified by:
isProvisional
in interfaceOpenJPAStateManager
-
getLoaded
public java.util.BitSet getLoaded()
Description copied from interface:OpenJPAStateManager
Return a read-only mask of the indexes of all loaded fields.- Specified by:
getLoaded
in interfaceOpenJPAStateManager
-
getDirty
public java.util.BitSet getDirty()
Description copied from interface:OpenJPAStateManager
Return a read-only mask of the indexes of all dirty fields.- Specified by:
getDirty
in interfaceOpenJPAStateManager
-
getFlushed
public java.util.BitSet getFlushed()
Description copied from interface:OpenJPAStateManager
Return a read-only mask of the indexes of all fields that have been flushed since they were last changed.- Specified by:
getFlushed
in interfaceOpenJPAStateManager
-
getUnloaded
public java.util.BitSet getUnloaded(FetchConfiguration fetch)
Description copied from interface:OpenJPAStateManager
Return a mutable mask of the unloaded fields that need loading based on the given fetch configuration. Pass in null to retrieve all unloaded fields.- Specified by:
getUnloaded
in interfaceOpenJPAStateManager
-
newProxy
public java.lang.Object newProxy(int field)
Description copied from interface:OpenJPAStateManager
Create a new hollow proxy instance for the given field. In cases where the field externalizes to an SCO but is declared something else, the returned object may not implementProxy
. In all other cases, this method delegates to the systemProxyManager
with the correct field information. The returned proxy's owner is unset so that modifications to the proxy will not be tracked while its state is initialized. CallingOpenJPAStateManager.storeField(int, java.lang.Object)
orOpenJPAStateManager.store(int, java.lang.Object)
will set the proxy's owner automatically.- Specified by:
newProxy
in interfaceOpenJPAStateManager
-
newFieldProxy
public java.lang.Object newFieldProxy(int field)
Description copied from interface:OpenJPAStateManager
Create a new hollow proxy instance for the given field. This method differs fromOpenJPAStateManager.newProxy(int)
in that it returns a proxy for the field's declared type, not its externalized type.- Specified by:
newFieldProxy
in interfaceOpenJPAStateManager
- See Also:
OpenJPAStateManager.newProxy(int)
-
isDefaultValue
public boolean isDefaultValue(int field)
Description copied from interface:OpenJPAStateManager
Return true if the given field has a default value.- Specified by:
isDefaultValue
in interfaceOpenJPAStateManager
-
getContext
public StoreContext getContext()
Description copied from interface:OpenJPAStateManager
Return the managing context.- Specified by:
getContext
in interfaceOpenJPAStateManager
-
getPCState
public PCState getPCState()
Description copied from interface:OpenJPAStateManager
Return the state that this object is in.- Specified by:
getPCState
in interfaceOpenJPAStateManager
-
getObjectId
public java.lang.Object getObjectId()
Description copied from interface:OpenJPAStateManager
Return the instance's object id. This method will return null if no oid has been assigned. Oids are assigned to newly-persisted instances when the user first asks for it, or on flush.- Specified by:
getObjectId
in interfaceOpenJPAStateManager
-
setObjectId
public void setObjectId(java.lang.Object oid)
Description copied from interface:OpenJPAStateManager
Set the object id for the managed instance. Some back ends may not be able to assign a permanent oid until flush. Do not call this method on application identity instances; changing the primary key fields of application identity objects through thestoreXXXField
methods will automatically change the oid.- Specified by:
setObjectId
in interfaceOpenJPAStateManager
-
assignObjectId
public boolean assignObjectId(boolean flush)
Description copied from interface:OpenJPAStateManager
Ask the store manager to assign a permanent oid to this new instance.- Specified by:
assignObjectId
in interfaceOpenJPAStateManager
- Parameters:
flush
- if true, flush if necessary to get a permanent oid; if false, the oid may be left unassigned- Returns:
- true if an oid assigned, false otherwise
-
getId
public java.lang.Object getId()
Description copied from interface:OpenJPAStateManager
Return the identifier for this state manager. This may return a temporary identifier for new unflushed instances that have not been assigned an object id, or for non-persistent or embedded instances. For all other instances this method is the same asOpenJPAStateManager.getObjectId()
.- Specified by:
getId
in interfaceOpenJPAStateManager
-
getLock
public java.lang.Object getLock()
Description copied from interface:OpenJPAStateManager
The lock object set for this instance. This object is generally managed by the system lock manager.- Specified by:
getLock
in interfaceOpenJPAStateManager
-
setLock
public void setLock(java.lang.Object lock)
Description copied from interface:OpenJPAStateManager
The lock object set for this instance. This object is generally managed by the system lock manager.- Specified by:
setLock
in interfaceOpenJPAStateManager
-
setNextVersion
public void setNextVersion(java.lang.Object version)
Description copied from interface:OpenJPAStateManager
Set the next version indicator in the datastore pending a successful flush. TheStoreManager
uses this method during flush.- Specified by:
setNextVersion
in interfaceOpenJPAStateManager
-
getImplData
public java.lang.Object getImplData()
Description copied from interface:OpenJPAStateManager
An object that concrete back ends can associate with each instance. This object is not used or modified in any way by the generic persistence layer.- Specified by:
getImplData
in interfaceOpenJPAStateManager
-
setImplData
public java.lang.Object setImplData(java.lang.Object data, boolean cacheable)
Description copied from interface:OpenJPAStateManager
An object that concrete back ends can associate with each instance. This object is not used or modified in any way by the generic persistence layer.- Specified by:
setImplData
in interfaceOpenJPAStateManager
cacheable
- whether the impl data can be shared among instances in different contexts if L2 caching is enabled- Returns:
- the previous impl data value, if any
-
isImplDataCacheable
public boolean isImplDataCacheable()
Description copied from interface:OpenJPAStateManager
Whether the instance-level impl data can be shared among instances in different contexts if L2 caching is enabled.- Specified by:
isImplDataCacheable
in interfaceOpenJPAStateManager
-
getImplData
public java.lang.Object getImplData(int field)
Description copied from interface:OpenJPAStateManager
Field-level impl data. Field-level data only applies to loaded fields, and is cleared when the field is cleared.- Specified by:
getImplData
in interfaceOpenJPAStateManager
-
setImplData
public java.lang.Object setImplData(int field, java.lang.Object data)
Description copied from interface:OpenJPAStateManager
Field-level impl data. Field-level data only applies to loaded fields, and is cleared when the field is cleared. Whether the data is cached across instances depends on the corresponding field metadata's response toFieldMetaData.usesImplData()
.- Specified by:
setImplData
in interfaceOpenJPAStateManager
- Returns:
- the previous impl data value, if any
-
isImplDataCacheable
public boolean isImplDataCacheable(int field)
Description copied from interface:OpenJPAStateManager
Whether the field's impl data is loaded and can be shared among instances in different contexts if L2 caching is enabled.- Specified by:
isImplDataCacheable
in interfaceOpenJPAStateManager
-
getIntermediate
public java.lang.Object getIntermediate(int field)
Description copied from interface:OpenJPAStateManager
Use intermediate field data to store intermediate information that might be available before the field is fully loaded. The system will automatically clear this data when the field gets loaded. This data should be cacheable; the datastore cache will attempt to cache it if the field value is not available.- Specified by:
getIntermediate
in interfaceOpenJPAStateManager
-
setIntermediate
public void setIntermediate(int field, java.lang.Object data)
Description copied from interface:OpenJPAStateManager
Use intermediate field data to store intermediate information that might be available before the field is fully loaded. The system will automatically clear this data when the field gets loaded. This data should be cacheable; the datastore cache will attempt to cache it if the field value is not available.- Specified by:
setIntermediate
in interfaceOpenJPAStateManager
-
removed
public void removed(int field, java.lang.Object removed, boolean key)
Description copied from interface:OpenJPAStateManager
Notification that an element has been removed from the given field.- Specified by:
removed
in interfaceOpenJPAStateManager
-
beforeRefresh
public boolean beforeRefresh(boolean all)
Description copied from interface:OpenJPAStateManager
Prepare the instance for refresh- Specified by:
beforeRefresh
in interfaceOpenJPAStateManager
- Parameters:
all
- true if this instance is one of a collection of objects being refreshed- Returns:
- true if the object needs a refresh, false otherwise
- See Also:
Broker.refresh(java.lang.Object, org.apache.openjpa.kernel.OpCallbacks)
-
dirty
public void dirty(int field)
Description copied from interface:OpenJPAStateManager
Mark the given field as dirty.- Specified by:
dirty
in interfaceOpenJPAStateManager
-
storeBoolean
public void storeBoolean(int field, boolean extVal)
Description copied from interface:OpenJPAStateManager
Set the given external value back into the given field.- Specified by:
storeBoolean
in interfaceOpenJPAStateManager
-
storeByte
public void storeByte(int field, byte extVal)
Description copied from interface:OpenJPAStateManager
Set the given external value back into the given field.- Specified by:
storeByte
in interfaceOpenJPAStateManager
-
storeChar
public void storeChar(int field, char extVal)
Description copied from interface:OpenJPAStateManager
Set the given external value back into the given field.- Specified by:
storeChar
in interfaceOpenJPAStateManager
-
storeInt
public void storeInt(int field, int extVal)
Description copied from interface:OpenJPAStateManager
Set the given external value back into the given field.- Specified by:
storeInt
in interfaceOpenJPAStateManager
-
storeShort
public void storeShort(int field, short extVal)
Description copied from interface:OpenJPAStateManager
Set the given external value back into the given field.- Specified by:
storeShort
in interfaceOpenJPAStateManager
-
storeLong
public void storeLong(int field, long extVal)
Description copied from interface:OpenJPAStateManager
Set the given external value back into the given field.- Specified by:
storeLong
in interfaceOpenJPAStateManager
-
storeFloat
public void storeFloat(int field, float extVal)
Description copied from interface:OpenJPAStateManager
Set the given external value back into the given field.- Specified by:
storeFloat
in interfaceOpenJPAStateManager
-
storeDouble
public void storeDouble(int field, double extVal)
Description copied from interface:OpenJPAStateManager
Set the given external value back into the given field.- Specified by:
storeDouble
in interfaceOpenJPAStateManager
-
storeString
public void storeString(int field, java.lang.String extVal)
Description copied from interface:OpenJPAStateManager
Set the given external value back into the given field.- Specified by:
storeString
in interfaceOpenJPAStateManager
-
storeObject
public void storeObject(int field, java.lang.Object extVal)
Description copied from interface:OpenJPAStateManager
Set the given external value back into the given field.- Specified by:
storeObject
in interfaceOpenJPAStateManager
-
store
public void store(int field, java.lang.Object extVal)
Description copied from interface:OpenJPAStateManager
Set the value of the field with the given index as from the external object value. If there is no externalizer, this is equivalent toOpenJPAStateManager.storeField(int, java.lang.Object)
.- Specified by:
store
in interfaceOpenJPAStateManager
-
storeBooleanField
public void storeBooleanField(int field, boolean extVal)
Description copied from interface:FieldConsumer
Set the value of the given field.- Specified by:
storeBooleanField
in interfaceFieldConsumer
-
storeByteField
public void storeByteField(int field, byte extVal)
Description copied from interface:FieldConsumer
Set the value of the given field.- Specified by:
storeByteField
in interfaceFieldConsumer
-
storeCharField
public void storeCharField(int field, char extVal)
Description copied from interface:FieldConsumer
Set the value of the given field.- Specified by:
storeCharField
in interfaceFieldConsumer
-
storeIntField
public void storeIntField(int field, int extVal)
Description copied from interface:FieldConsumer
Set the value of the given field.- Specified by:
storeIntField
in interfaceFieldConsumer
-
storeShortField
public void storeShortField(int field, short extVal)
Description copied from interface:FieldConsumer
Set the value of the given field.- Specified by:
storeShortField
in interfaceFieldConsumer
-
storeLongField
public void storeLongField(int field, long extVal)
Description copied from interface:FieldConsumer
Set the value of the given field.- Specified by:
storeLongField
in interfaceFieldConsumer
-
storeFloatField
public void storeFloatField(int field, float extVal)
Description copied from interface:FieldConsumer
Set the value of the given field.- Specified by:
storeFloatField
in interfaceFieldConsumer
-
storeDoubleField
public void storeDoubleField(int field, double extVal)
Description copied from interface:FieldConsumer
Set the value of the given field.- Specified by:
storeDoubleField
in interfaceFieldConsumer
-
storeStringField
public void storeStringField(int field, java.lang.String extVal)
Description copied from interface:FieldConsumer
Set the value of the given field.- Specified by:
storeStringField
in interfaceFieldConsumer
-
storeObjectField
public void storeObjectField(int field, java.lang.Object extVal)
Description copied from interface:FieldConsumer
Set the value of the given field.- Specified by:
storeObjectField
in interfaceFieldConsumer
-
storeField
public void storeField(int field, java.lang.Object value)
Description copied from interface:OpenJPAStateManager
Set the value of the field with the given index as an object.- Specified by:
storeField
in interfaceOpenJPAStateManager
-
fetchBoolean
public boolean fetchBoolean(int field)
Description copied from interface:OpenJPAStateManager
Return the external value of the given field.- Specified by:
fetchBoolean
in interfaceOpenJPAStateManager
-
fetchByte
public byte fetchByte(int field)
Description copied from interface:OpenJPAStateManager
Return the external value of the given field.- Specified by:
fetchByte
in interfaceOpenJPAStateManager
-
fetchChar
public char fetchChar(int field)
Description copied from interface:OpenJPAStateManager
Return the external value of the given field.- Specified by:
fetchChar
in interfaceOpenJPAStateManager
-
fetchShort
public short fetchShort(int field)
Description copied from interface:OpenJPAStateManager
Return the external value of the given field.- Specified by:
fetchShort
in interfaceOpenJPAStateManager
-
fetchInt
public int fetchInt(int field)
Description copied from interface:OpenJPAStateManager
Return the external value of the given field.- Specified by:
fetchInt
in interfaceOpenJPAStateManager
-
fetchLong
public long fetchLong(int field)
Description copied from interface:OpenJPAStateManager
Return the external value of the given field.- Specified by:
fetchLong
in interfaceOpenJPAStateManager
-
fetchFloat
public float fetchFloat(int field)
Description copied from interface:OpenJPAStateManager
Return the external value of the given field.- Specified by:
fetchFloat
in interfaceOpenJPAStateManager
-
fetchDouble
public double fetchDouble(int field)
Description copied from interface:OpenJPAStateManager
Return the external value of the given field.- Specified by:
fetchDouble
in interfaceOpenJPAStateManager
-
fetchString
public java.lang.String fetchString(int field)
Description copied from interface:OpenJPAStateManager
Return the external value of the given field.- Specified by:
fetchString
in interfaceOpenJPAStateManager
-
fetchObject
public java.lang.Object fetchObject(int field)
Description copied from interface:OpenJPAStateManager
Return the external value of the given field.- Specified by:
fetchObject
in interfaceOpenJPAStateManager
-
fetch
public java.lang.Object fetch(int field)
Description copied from interface:OpenJPAStateManager
Return the externalized value of the field with the given index as an object. If there is no externalizer, this is equivalent toOpenJPAStateManager.fetchField(int, boolean)
.- Specified by:
fetch
in interfaceOpenJPAStateManager
-
fetchBooleanField
public boolean fetchBooleanField(int field)
Description copied from interface:FieldSupplier
Return the value of the given field.- Specified by:
fetchBooleanField
in interfaceFieldSupplier
-
fetchByteField
public byte fetchByteField(int field)
Description copied from interface:FieldSupplier
Return the value of the given field.- Specified by:
fetchByteField
in interfaceFieldSupplier
-
fetchCharField
public char fetchCharField(int field)
Description copied from interface:FieldSupplier
Return the value of the given field.- Specified by:
fetchCharField
in interfaceFieldSupplier
-
fetchShortField
public short fetchShortField(int field)
Description copied from interface:FieldSupplier
Return the value of the given field.- Specified by:
fetchShortField
in interfaceFieldSupplier
-
fetchIntField
public int fetchIntField(int field)
Description copied from interface:FieldSupplier
Return the value of the given field.- Specified by:
fetchIntField
in interfaceFieldSupplier
-
fetchLongField
public long fetchLongField(int field)
Description copied from interface:FieldSupplier
Return the value of the given field.- Specified by:
fetchLongField
in interfaceFieldSupplier
-
fetchFloatField
public float fetchFloatField(int field)
Description copied from interface:FieldSupplier
Return the value of the given field.- Specified by:
fetchFloatField
in interfaceFieldSupplier
-
fetchDoubleField
public double fetchDoubleField(int field)
Description copied from interface:FieldSupplier
Return the value of the given field.- Specified by:
fetchDoubleField
in interfaceFieldSupplier
-
fetchStringField
public java.lang.String fetchStringField(int field)
Description copied from interface:FieldSupplier
Return the value of the given field.- Specified by:
fetchStringField
in interfaceFieldSupplier
-
fetchObjectField
public java.lang.Object fetchObjectField(int field)
Description copied from interface:OpenJPAStateManager
Fetch an object field by index.- Specified by:
fetchObjectField
in interfaceFieldSupplier
- Specified by:
fetchObjectField
in interfaceOpenJPAStateManager
-
fetchField
public java.lang.Object fetchField(int field, boolean transitions)
Description copied from interface:OpenJPAStateManager
Return the value of the field with the given index as an object.- Specified by:
fetchField
in interfaceOpenJPAStateManager
transitions
- if true, this method will cause state transitions to occur as if the field were accessed normally
-
fetchInitialField
public java.lang.Object fetchInitialField(int field)
Description copied from interface:OpenJPAStateManager
Return the value of the field at the specified index as of the beginning of the transaction.- Specified by:
fetchInitialField
in interfaceOpenJPAStateManager
-
setRemote
public void setRemote(int field, java.lang.Object value)
Description copied from interface:OpenJPAStateManager
Set the given field to the given value. Make the field dirty as if user code set it. Do not delete dependent objects in the field's current value. This method is invoked by the remote package to synch a server-side state manager with remote changes. We do not need to delete dependent instances because they will have been deleted when the field changed on the client side, and those client-side deletes will be transmitted independently.- Specified by:
setRemote
in interfaceOpenJPAStateManager
-
lock
public void lock()
-
unlock
public void unlock()
-
isDelayed
public boolean isDelayed(int field)
Description copied from interface:OpenJPAStateManager
Some field types (collection proxies) support delayed loading. Delayed loading is a step beyond lazy loading. Delayed load allows an instance of a field to be returned without actually loading it.- Specified by:
isDelayed
in interfaceOpenJPAStateManager
- Returns:
- true if the field is setup for delayed access
-
setDelayed
public void setDelayed(int field, boolean delay)
Description copied from interface:OpenJPAStateManager
Some field types (collection proxies) support delayed loading. Delayed loading is a step beyond lazy loading. Delayed load allows an instance of a field to be returned without actually loading it.- Specified by:
setDelayed
in interfaceOpenJPAStateManager
-
loadDelayedField
public void loadDelayedField(int field)
Description copied from interface:OpenJPAStateManager
If a field was marked delayed in a previous load operation this method can be used to load the field.- Specified by:
loadDelayedField
in interfaceOpenJPAStateManager
-
-