AbstractStateManager (DataNucleus Core 3.2.11 API)

java.lang.Object
- org.datanucleus.state.AbstractStateManager

All Implemented Interfaces:

ObjectProvider

Direct Known Subclasses:

JDOStateManager
```
public abstract class AbstractStateManager
extends Object
implements ObjectProvider
```
Abstract representation of an implementation of a bytecode enhancement-based StateManager. This class should have no reference to any JDO class, so it can be reused by a JPAStateManager too (in the future).

Field Summary

Fields
Modifier and Type	Field and Description
`protected ActivityState`	`activity` state for transitions of activities.
`protected AbstractClassMetaData`	`cmd` the metadata for the class.
`protected FieldManager`	`currFM` Current FieldManager.
`protected boolean`	`dirty` Indicator for whether the persistable instance is dirty.
`protected boolean[]`	`dirtyFields` indicators for which fields are currently dirty in the persistable instance.
`protected static int`	`FLAG_ATTACHING` Flag for `flags` whether we are in the process of attaching the object.
`protected static int`	`FLAG_BECOMING_DELETED`
`protected static int`	`FLAG_CHANGING_STATE`
`protected static int`	`FLAG_DETACHING` Flag for `flags` whether we are in the process of detaching the object.
`protected static int`	`FLAG_DISCONNECTING` Flag for `flags` whether we are in the process of disconnecting the object.
`protected static int`	`FLAG_FLUSHED_NEW` if the persistable object is new and was flushed to the datastore.
`protected static int`	`FLAG_FLUSHING` Flag for `flags` whether we are in the process of flushing changes to the object.
`protected static int`	`FLAG_LOADINGFPFIELDS`
`protected static int`	`FLAG_MAKING_TRANSIENT` Flag for `flags` whether we are in the process of making transient the object.
`protected static int`	`FLAG_NEED_INHERITANCE_VALIDATION` Whether the managed object needs the inheritance level validating before loading fields.
`protected static int`	`FLAG_POSTINSERT_UPDATE`
`protected static int`	`FLAG_POSTLOAD_PENDING`
`protected static int`	`FLAG_RESETTING_DETACHED_STATE` Flag for `flags` whether we are resetting the detached state.
`protected static int`	`FLAG_RETRIEVING_DETACHED_STATE` Flag for `flags` whether we are retrieving detached state from the detached object.
`protected static int`	`FLAG_STORING_PC` Flag to signify that we are currently storing the persistable object, so we don't detach it on serialisation.
`protected static int`	`FLAG_UPDATING_EMBEDDING_FIELDS_WITH_OWNER` Flag whether this SM is updating the ownership of its embedded/serialised field(s).
`protected int`	`flags` Bit-packed flags for operational settings (packed into "int" for memory benefit).
`protected static SingleTypeFieldManager`	`HOLLOWFIELDMANAGER`
`protected boolean[]`	`loadedFields` indicators for which fields are currently loaded in the persistable instance.
`protected static Localiser`	`LOCALISER`
`protected Lock`	`lock` Lock object to synchronise execution when reading/writing fields.
`protected short`	`lockMode` The current lock mode for this object.
`protected ExecutionContext`	`myEC` The ExecutionContext for this StateManager
`protected FetchPlanForClass`	`myFP` Fetch plan for the class of the managed object.
`protected Object`	`myID` The object identity in the datastore
`protected Object`	`myInternalID` The object identity in the JVM.
`protected LifeCycleState`	`myLC` The actual LifeCycleState for the persistable instance
`protected Object`	`myVersion` version field for optimistic transactions
`protected short`	`objectType` The type of the managed object (0 = PC, 1 = embedded PC, 2 = embedded element, 3 = embedded key, 4 = embedded value.
`static HashMap<String,ObjectValueGenerator>`	`objectValGenerators` Cache of object-value-generators, keyed by their symbolic name.
`protected byte`	`persistenceFlags` Flags for state stored with the object.
`protected boolean`	`restoreValues` Whether to restore values at StateManager.
`protected byte`	`savedFlags` Flags of the PersistenceCapable instance when the instance is enlisted in the transaction.
`protected boolean[]`	`savedLoadedFields` Loaded fields of the PersistenceCapable instance when the instance is enlisted in the transaction.
`protected Object`	`transactionalVersion` version field for optimistic transactions, after a insert/update but not yet committed.

Fields inherited from interface org.datanucleus.state.ObjectProvider
EMBEDDED_COLLECTION_ELEMENT_PC, EMBEDDED_MAP_KEY_PC, EMBEDDED_MAP_VALUE_PC, EMBEDDED_PC, ORIGINAL_FIELD_VALUE_KEY_PREFIX, PC

Constructor Summary

Constructors
Constructor and Description
`AbstractStateManager(ExecutionContext ec, AbstractClassMetaData cmd)` Constructor for object of specified type managed by the provided ExecutionContext.

Method Summary

Methods
Modifier and Type	Method and Description
`protected boolean`	`areFieldsLoaded(int[] fieldNumbers)` Accessor for whether all of the specified field numbers are loaded.
`boolean`	`becomingDeleted()` Whether this object is moving to a deleted state.
`protected void`	`clearDirtyFlags()` Method to clear all dirty flags on the object.
`protected void`	`clearDirtyFlags(int[] fieldNumbers)` Method to clear all dirty flags on the object.
`protected void`	`clearFieldsByNumbers(int[] fieldNumbers)`
`void`	`connect(ExecutionContext ec, AbstractClassMetaData cmd)` Method to (re)connect the provider to the specified ExecutionContext and object type.
`boolean`	`containsAssociatedValue(Object key)`
`void`	`evict()` Method to change the object state to evicted.
`boolean`	`getAllFieldsLoaded()` Returns whether all fields are loaded.
`Object`	`getAssociatedValue(Object key)` Accessor for an associated value stored with this object.
`protected CallbackHandler`	`getCallbackHandler()` returns the handler for callback events.
`AbstractClassMetaData`	`getClassMetaData()` Accessor for the ClassMetaData for this object.
`String[]`	`getDirtyFieldNames()` Convenience accessor for the names of the fields that are dirty.
`int[]`	`getDirtyFieldNumbers()` Accessor for the field numbers of all dirty fields.
`boolean[]`	`getDirtyFields()` Creates a copy of the `dirtyFields` bitmap.
`ExecutionContext`	`getExecutionContext()` Accessor for the ExecutionContext for this object.
`protected int[]`	`getFieldNumbersOfLoadedOrDirtyFields(boolean[] loadedFields, boolean[] dirtyFields)` Convenience accessor to return the field numbers for the input loaded and dirty field arrays.
`Object`	`getInternalObjectId()` Accessor for the internal object id of the object we are managing.
`LifeCycleState`	`getLifecycleState()` Accessor for the LifeCycleState
`String[]`	`getLoadedFieldNames()` Convenience accessor for the names of the fields that are loaded.
`int[]`	`getLoadedFieldNumbers()` Accessor for the field numbers of all loaded fields in this managed instance.
`boolean[]`	`getLoadedFields()` Accessor for the fields
`short`	`getLockMode()` Accessor for the current lock mode.
`abstract Object`	`getObject()` Accessor for the persistable object being managed.
`String`	`getObjectAsPrintable()` Returns a printable form of the managed object.
`protected static ObjectValueGenerator`	`getObjectValueGenerator(ExecutionContext ec, String genName)` Method to find an object value generator based on its name.
`Object`	`getTransactionalVersion(Object pc)` Return the object representing the transactional version of the calling instance.
`protected void`	`internalDeletePersistent()` Method to delete the object from the datastore.
`boolean`	`isAttaching()`
`protected boolean`	`isChangingState()`
`boolean`	`isDeleting()` Tests whether this object is in the process of being deleted.
`boolean`	`isDetaching()`
`protected boolean`	`isDisconnecting()`
`boolean`	`isEmbedded()` Convenience accessor for whether this StateManager manages an embedded/serialised object.
`boolean`	`isFieldLoaded(int fieldNumber)` Accessor for whether a field is currently loaded.
`boolean`	`isFlushedNew()` Whether this record has been flushed to the datastore in this transaction (i.e called persist() and is in the datastore now).
`boolean`	`isFlushedToDatastore()` Accessor for whether all changes have been written to the datastore.
`protected boolean`	`isFlushing()`
`boolean`	`isInserting()` Tests whether this object is being inserted.
`protected boolean`	`isMakingTransient()`
`protected boolean`	`isPostLoadPending()`
`protected boolean`	`isResettingDetachedState()`
`boolean`	`isRestoreValues()` Accessor for whether we are in the process of restoring the values.
`protected boolean`	`isRetrievingDetachedState()`
`protected boolean`	`isStoringPC()`
`boolean`	`isWaitingToBeFlushedToDatastore()` Accessor for whether the instance is newly persistent yet hasnt yet been flushed to the datastore.
`void`	`loadFieldFromDatastore(int fieldNumber)` Convenience method to load a field from the datastore.
`protected void`	`loadFieldsFromDatastore(int[] fieldNumbers)` Convenience method to load fields from the datastore.
`protected int[]`	`loadFieldsFromLevel2Cache(int[] fieldNumbers)` Convenience method to retrieve field values from an L2 cached object if they are loaded in that object.
`void`	`loadFieldsInFetchPlan(FetchPlanState state)` Method to load all unloaded fields in the FetchPlan.
`void`	`locate()` Locate the object in the datastore.
`void`	`lock(short lockMode)` Method to lock the object owned by this ObjectProvider.
`void`	`makeNontransactional()` Method to change the object state to nontransactional.
`void`	`makePersistentTransactionalTransient()` Makes Transactional Transient instances persistent.
`void`	`markAsFlushed()` Method to notify the object provider that the object has now been flushed to the datastore.
`void`	`markForInheritanceValidation()` Mark the state manager as needing to validate the inheritance of the managed object existence before loading fields.
`protected void`	`markPKFieldsAsLoaded()` Convenience method to mark PK fields as loaded (if using app id).
`void`	`postCommit(Transaction tx)` This method is invoked just after a commit is performed in a Transaction involving the persistable object managed by this StateManager
`protected abstract void`	`postStateChange()` Method called after a change in state.
`void`	`preBegin(Transaction tx)` Method invoked just before a transaction starts for the ExecutionContext managing us.
`void`	`preRollback(Transaction tx)` This method is invoked just before a rollback is performed in a Transaction involving the persistable object managed by this StateManager.
`protected void`	`preStateChange()` Method called before a change in state.
`abstract void`	`provideFields(int[] fieldNumbers, FieldManager fm)` Called from the StoreManager after StoreManager.update() is called to obtain updated values from the PersistenceCapable associated with this StateManager.
`void`	`refresh()` Method to refresh the object.
`void`	`removeAssociatedValue(Object key)` Method to remove the associated value with the specified key (if it exists).
`abstract void`	`replaceFields(int[] fieldNumbers, FieldManager fm)` Called from the StoreManager to refresh data in the persistable object associated with this StateManager.
`void`	`retrieve(boolean fgOnly)` Method to retrieve the object.
`void`	`setAssociatedValue(Object key, Object value)` Method to set an associated value stored with this object.
`void`	`setFlushedNew(boolean flag)`
`void`	`setFlushing(boolean flushing)`
`void`	`setPcObjectType(short objType)` Method to set this StateManager as managing an embedded/serialised object.
`void`	`setStoringPC()` Method to set the storing PC flag.
`void`	`setTransactionalVersion(Object version)` Sets the value for the version column in a transaction not yet committed
`void`	`setVersion(Object version)` Sets the value for the version column in the datastore
`String`	`toString()`
`protected void`	`transitionReadField(boolean isLoaded)` Method to change the object state to read-field.
`protected void`	`transitionWriteField()` Method to change the object state to write-field.
`void`	`unloadField(String fieldName)` Convenience method to unload a field/property.
`void`	`unloadNonFetchPlanFields()` Method that will unload all fields that are not in the FetchPlan.
`void`	`unlock()` Method to unlock the object owned by this ObjectProvider (if locked).
`void`	`unsetStoringPC()` Method to unset the storing PC flag.
`protected void`	`updateLevel2CacheForFields(int[] fieldNumbers)` Convenience method to update a Level2 cached version of this object if cacheable and has not been modified during this transaction.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.datanucleus.state.ObjectProvider
attach, attach, attachCopy, changeActivityState, checkInheritance, clearFields, clearLoadedFlags, clearNonPrimaryKeyFields, clearSavedFields, copyFieldsFromObject, deletePersistent, detach, detachCopy, disconnect, enlistInTransaction, evictFromTransaction, flush, getEmbeddedOwners, getExternalObjectId, getReferencedPC, getTransactionalVersion, getVersion, initialiseForCachedPC, initialiseForDetached, initialiseForEmbedded, initialiseForHollow, initialiseForHollowAppId, initialiseForHollowPreConstructed, initialiseForPersistentClean, initialiseForPersistentNew, initialiseForPNewToBeDeleted, initialiseForTransactionalTransient, isLoaded, loadField, loadFieldValues, loadUnloadedFields, loadUnloadedFieldsInFetchPlan, loadUnloadedFieldsOfClassInFetchPlan, makeDirty, makePersistent, makeTransactional, makeTransient, nullifyFields, provideField, refreshFieldsInFetchPlan, refreshLoadedFields, registerTransactional, replaceAllLoadedSCOFieldsWithValues, replaceAllLoadedSCOFieldsWithWrappers, replaceField, replaceFieldMakeDirty, replaceFields, replaceFieldValue, replaceManagedPC, replaceNonLoadedFields, resetDetachState, restoreFields, retrieveDetachState, runReachability, saveFields, setPostStoreNewObjectId, unwrapSCOField, updateFieldAfterInsert, validate, wrapSCOField

- Field Detail
  - LOCALISER
```
protected static final Localiser LOCALISER
```
  - HOLLOWFIELDMANAGER
```
protected static final SingleTypeFieldManager HOLLOWFIELDMANAGER
```
  - FLAG_STORING_PC
```
protected static final int FLAG_STORING_PC
```
    Flag to signify that we are currently storing the persistable object, so we don't detach it on serialisation.
    
    See Also:
    Constant Field Values
  - FLAG_NEED_INHERITANCE_VALIDATION
```
protected static final int FLAG_NEED_INHERITANCE_VALIDATION
```
    Whether the managed object needs the inheritance level validating before loading fields.
    
    See Also:
    Constant Field Values
  - FLAG_POSTINSERT_UPDATE
```
protected static final int FLAG_POSTINSERT_UPDATE
```
    See Also:
    Constant Field Values
  - FLAG_LOADINGFPFIELDS
```
protected static final int FLAG_LOADINGFPFIELDS
```
    See Also:
    Constant Field Values
  - FLAG_POSTLOAD_PENDING
```
protected static final int FLAG_POSTLOAD_PENDING
```
    See Also:
    Constant Field Values
  - FLAG_CHANGING_STATE
```
protected static final int FLAG_CHANGING_STATE
```
    See Also:
    Constant Field Values
  - FLAG_FLUSHED_NEW
```
protected static final int FLAG_FLUSHED_NEW
```
    if the persistable object is new and was flushed to the datastore.
    
    See Also:
    Constant Field Values
  - FLAG_BECOMING_DELETED
```
protected static final int FLAG_BECOMING_DELETED
```
    See Also:
    Constant Field Values
  - FLAG_UPDATING_EMBEDDING_FIELDS_WITH_OWNER
```
protected static final int FLAG_UPDATING_EMBEDDING_FIELDS_WITH_OWNER
```
    Flag whether this SM is updating the ownership of its embedded/serialised field(s).
    
    See Also:
    Constant Field Values
  - FLAG_RETRIEVING_DETACHED_STATE
```
protected static final int FLAG_RETRIEVING_DETACHED_STATE
```
    Flag for flags whether we are retrieving detached state from the detached object.
    
    See Also:
    Constant Field Values
  - FLAG_RESETTING_DETACHED_STATE
```
protected static final int FLAG_RESETTING_DETACHED_STATE
```
    Flag for flags whether we are resetting the detached state.
    
    See Also:
    Constant Field Values
  - FLAG_ATTACHING
```
protected static final int FLAG_ATTACHING
```
    Flag for flags whether we are in the process of attaching the object.
    
    See Also:
    Constant Field Values
  - FLAG_DETACHING
```
protected static final int FLAG_DETACHING
```
    Flag for flags whether we are in the process of detaching the object.
    
    See Also:
    Constant Field Values
  - FLAG_MAKING_TRANSIENT
```
protected static final int FLAG_MAKING_TRANSIENT
```
    Flag for flags whether we are in the process of making transient the object.
    
    See Also:
    Constant Field Values
  - FLAG_FLUSHING
```
protected static final int FLAG_FLUSHING
```
    Flag for flags whether we are in the process of flushing changes to the object.
    
    See Also:
    Constant Field Values
  - FLAG_DISCONNECTING
```
protected static final int FLAG_DISCONNECTING
```
    Flag for flags whether we are in the process of disconnecting the object.
    
    See Also:
    Constant Field Values
  - flags
```
protected int flags
```
    Bit-packed flags for operational settings (packed into "int" for memory benefit).
  - restoreValues
```
protected boolean restoreValues
```
    Whether to restore values at StateManager. If true, overwrites the restore values at tx level.
  - myEC
```
protected ExecutionContext myEC
```
    The ExecutionContext for this StateManager
  - cmd
```
protected AbstractClassMetaData cmd
```
    the metadata for the class.
  - myInternalID
```
protected Object myInternalID
```
    The object identity in the JVM. Will be "myID" (if set) or otherwise a temporary id based on this StateManager.
  - myID
```
protected Object myID
```
    The object identity in the datastore
  - myLC
```
protected LifeCycleState myLC
```
    The actual LifeCycleState for the persistable instance
  - myVersion
```
protected Object myVersion
```
    version field for optimistic transactions
  - transactionalVersion
```
protected Object transactionalVersion
```
    version field for optimistic transactions, after a insert/update but not yet committed.
  - persistenceFlags
```
protected byte persistenceFlags
```
    Flags for state stored with the object. Maps onto JDO PersistenceCapable flags.
  - myFP
```
protected FetchPlanForClass myFP
```
    Fetch plan for the class of the managed object.
  - dirty
```
protected boolean dirty
```
    Indicator for whether the persistable instance is dirty. Note that "dirty" in this case is not equated to being in the P_DIRTY state. The P_DIRTY state means that at least one field in the object has been written by the user during the current transaction, whereas for this parameter, a field is "dirty" if it's been written by the user but not yet updated in the data store. The difference is, it's possible for an object's state to be P_DIRTY, yet have no "dirty" fields because flush() has been called at least once during the transaction.
  - dirtyFields
```
protected boolean[] dirtyFields
```
    indicators for which fields are currently dirty in the persistable instance.
  - loadedFields
```
protected boolean[] loadedFields
```
    indicators for which fields are currently loaded in the persistable instance.
  - lock
```
protected Lock lock
```
    Lock object to synchronise execution when reading/writing fields.
  - lockMode
```
protected short lockMode
```
    The current lock mode for this object.
  - savedFlags
```
protected byte savedFlags
```
    Flags of the PersistenceCapable instance when the instance is enlisted in the transaction.
  - savedLoadedFields
```
protected boolean[] savedLoadedFields
```
    Loaded fields of the PersistenceCapable instance when the instance is enlisted in the transaction.
  - activity
```
protected ActivityState activity
```
    state for transitions of activities.
  - currFM
```
protected FieldManager currFM
```
    Current FieldManager.
  - objectType
```
protected short objectType
```
    The type of the managed object (0 = PC, 1 = embedded PC, 2 = embedded element, 3 = embedded key, 4 = embedded value.
  - objectValGenerators
```
public static final HashMap<String,ObjectValueGenerator> objectValGenerators
```
    Cache of object-value-generators, keyed by their symbolic name.
- Constructor Detail
  - AbstractStateManager
```
public AbstractStateManager(ExecutionContext ec,
                    AbstractClassMetaData cmd)
```
    Constructor for object of specified type managed by the provided ExecutionContext.
    
    Parameters:
    ec - ExecutionContext
    cmd - the metadata for the class.
- Method Detail
  - connect
```
public void connect(ExecutionContext ec,
           AbstractClassMetaData cmd)
```
    Method to (re)connect the provider to the specified ExecutionContext and object type.
    
    Specified by:
    
    connect in interface ObjectProvider
  - getClassMetaData
```
public AbstractClassMetaData getClassMetaData()
```
    Accessor for the ClassMetaData for this object.
    
    Specified by:
    
    getClassMetaData in interface ObjectProvider
    
    Returns:
    The ClassMetaData.
  - getExecutionContext
```
public ExecutionContext getExecutionContext()
```
    Accessor for the ExecutionContext for this object.
    
    Specified by:
    
    getExecutionContext in interface ObjectProvider
    
    Returns:
    Execution Context
  - getLifecycleState
```
public LifeCycleState getLifecycleState()
```
    Accessor for the LifeCycleState
    
    Specified by:
    
    getLifecycleState in interface ObjectProvider
    
    Returns:
    the LifeCycleState
  - getCallbackHandler
```
protected CallbackHandler getCallbackHandler()
```
    returns the handler for callback events.
    
    Returns:
    the handler for callback events.
  - getObject
```
public abstract Object getObject()
```
    Accessor for the persistable object being managed.
    
    Specified by:
    
    getObject in interface ObjectProvider
    
    Returns:
    The persistable object
  - getObjectAsPrintable
```
public String getObjectAsPrintable()
```
    Description copied from interface: ObjectProvider
    
    Returns a printable form of the managed object. Typically returns Object.toString() form of the managed object.
    
    Specified by:
    
    getObjectAsPrintable in interface ObjectProvider
    
    Returns:
    The printable form of the object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getInternalObjectId
```
public Object getInternalObjectId()
```
    Accessor for the internal object id of the object we are managing. This will return the "id" if it has been set, otherwise a temporary id based on this StateManager.
    
    Specified by:
    
    getInternalObjectId in interface ObjectProvider
    
    Returns:
    The internal object id
  - isInserting
```
public boolean isInserting()
```
    Tests whether this object is being inserted.
    
    Specified by:
    
    isInserting in interface ObjectProvider
    
    Returns:
    true if this instance is inserting.
  - isWaitingToBeFlushedToDatastore
```
public boolean isWaitingToBeFlushedToDatastore()
```
    Accessor for whether the instance is newly persistent yet hasnt yet been flushed to the datastore.
    
    Specified by:
    
    isWaitingToBeFlushedToDatastore in interface ObjectProvider
    
    Returns:
    Whether not yet flushed to the datastore
  - isRestoreValues
```
public boolean isRestoreValues()
```
    Accessor for whether we are in the process of restoring the values.
    
    Specified by:
    
    isRestoreValues in interface ObjectProvider
    
    Returns:
    Whether we are restoring values
  - setStoringPC
```
public void setStoringPC()
```
    Description copied from interface: ObjectProvider
    
    Method to set the storing PC flag.
    
    Specified by:
    
    setStoringPC in interface ObjectProvider
  - unsetStoringPC
```
public void unsetStoringPC()
```
    Description copied from interface: ObjectProvider
    
    Method to unset the storing PC flag.
    
    Specified by:
    
    unsetStoringPC in interface ObjectProvider
  - isStoringPC
```
protected boolean isStoringPC()
```
  - isPostLoadPending
```
protected boolean isPostLoadPending()
```
  - isChangingState
```
protected boolean isChangingState()
```
  - isResettingDetachedState
```
protected boolean isResettingDetachedState()
```
  - isRetrievingDetachedState
```
protected boolean isRetrievingDetachedState()
```
  - isDisconnecting
```
protected boolean isDisconnecting()
```
  - isMakingTransient
```
protected boolean isMakingTransient()
```
  - isDeleting
```
public boolean isDeleting()
```
    Description copied from interface: ObjectProvider
    
    Tests whether this object is in the process of being deleted.
    
    Specified by:
    
    isDeleting in interface ObjectProvider
    
    Returns:
    true if this instance is being deleted.
  - becomingDeleted
```
public boolean becomingDeleted()
```
    Description copied from interface: ObjectProvider
    
    Whether this object is moving to a deleted state.
    
    Specified by:
    
    becomingDeleted in interface ObjectProvider
    
    Returns:
    Whether the object will be moved into a deleted state during this operation
  - markForInheritanceValidation
```
public void markForInheritanceValidation()
```
    Description copied from interface: ObjectProvider
    
    Mark the state manager as needing to validate the inheritance of the managed object existence before loading fields.
    
    Specified by:
    
    markForInheritanceValidation in interface ObjectProvider
  - isDetaching
```
public boolean isDetaching()
```
  - isAttaching
```
public boolean isAttaching()
```
  - setTransactionalVersion
```
public void setTransactionalVersion(Object version)
```
    Sets the value for the version column in a transaction not yet committed
    
    Specified by:
    
    setTransactionalVersion in interface ObjectProvider
    
    Parameters:
    version - The version
  - getTransactionalVersion
```
public Object getTransactionalVersion(Object pc)
```
    Return the object representing the transactional version of the calling instance.
    
    Parameters:
    pc - the calling persistable instance
    
    Returns:
    the object representing the version of the calling instance
  - setVersion
```
public void setVersion(Object version)
```
    Sets the value for the version column in the datastore
    
    Specified by:
    
    setVersion in interface ObjectProvider
    
    Parameters:
    version - The version
  - setFlushedNew
```
public void setFlushedNew(boolean flag)
```
    Specified by:
    
    setFlushedNew in interface ObjectProvider
  - isFlushedNew
```
public boolean isFlushedNew()
```
    Description copied from interface: ObjectProvider
    
    Whether this record has been flushed to the datastore in this transaction (i.e called persist() and is in the datastore now). If user has called persist() on it yet not yet persisted then returns false.
    
    Specified by:
    
    isFlushedNew in interface ObjectProvider
    
    Returns:
    Whether this is flushed new.
  - isFlushedToDatastore
```
public boolean isFlushedToDatastore()
```
    Description copied from interface: ObjectProvider
    
    Accessor for whether all changes have been written to the datastore.
    
    Specified by:
    
    isFlushedToDatastore in interface ObjectProvider
    
    Returns:
    Whether the datastore has all changes
  - setFlushing
```
public void setFlushing(boolean flushing)
```
    Specified by:
    
    setFlushing in interface ObjectProvider
  - isFlushing
```
protected boolean isFlushing()
```
  - markAsFlushed
```
public void markAsFlushed()
```
    Description copied from interface: ObjectProvider
    
    Method to notify the object provider that the object has now been flushed to the datastore. This is performed when handling inserts or deletes in a batch external to the ObjectProvider.
    
    Specified by:
    
    markAsFlushed in interface ObjectProvider
  - preStateChange
```
protected void preStateChange()
```
    Method called before a change in state.
  - postStateChange
```
protected abstract void postStateChange()
```
    Method called after a change in state.
  - refresh
```
public void refresh()
```
    Method to refresh the object.
    
    Specified by:
    
    refresh in interface ObjectProvider
  - retrieve
```
public void retrieve(boolean fgOnly)
```
    Method to retrieve the object.
    
    Specified by:
    
    retrieve in interface ObjectProvider
    
    Parameters:
    fgOnly - Only load the current fetch group fields
  - makePersistentTransactionalTransient
```
public void makePersistentTransactionalTransient()
```
    Makes Transactional Transient instances persistent.
    
    Specified by:
    
    makePersistentTransactionalTransient in interface ObjectProvider
  - makeNontransactional
```
public void makeNontransactional()
```
    Method to change the object state to nontransactional.
    
    Specified by:
    
    makeNontransactional in interface ObjectProvider
  - transitionReadField
```
protected void transitionReadField(boolean isLoaded)
```
    Method to change the object state to read-field.
    
    Parameters:
    isLoaded - if the field was previously loaded
  - transitionWriteField
```
protected void transitionWriteField()
```
    Method to change the object state to write-field.
  - evict
```
public void evict()
```
    Method to change the object state to evicted.
    
    Specified by:
    
    evict in interface ObjectProvider
  - preBegin
```
public void preBegin(Transaction tx)
```
    Method invoked just before a transaction starts for the ExecutionContext managing us.
    
    Specified by:
    
    preBegin in interface ObjectProvider
    
    Parameters:
    tx - The transaction
  - postCommit
```
public void postCommit(Transaction tx)
```
    This method is invoked just after a commit is performed in a Transaction involving the persistable object managed by this StateManager
    
    Specified by:
    
    postCommit in interface ObjectProvider
    
    Parameters:
    tx - The transaction
  - preRollback
```
public void preRollback(Transaction tx)
```
    This method is invoked just before a rollback is performed in a Transaction involving the persistable object managed by this StateManager.
    
    Specified by:
    
    preRollback in interface ObjectProvider
    
    Parameters:
    tx - The transaction
  - internalDeletePersistent
```
protected void internalDeletePersistent()
```
    Method to delete the object from the datastore.
  - locate
```
public void locate()
```
    Locate the object in the datastore.
    
    Specified by:
    
    locate in interface ObjectProvider
    
    Throws:
    
    NucleusObjectNotFoundException - if the object doesnt exist.
  - provideFields
```
public abstract void provideFields(int[] fieldNumbers,
                 FieldManager fm)
```
    Called from the StoreManager after StoreManager.update() is called to obtain updated values from the PersistenceCapable associated with this StateManager.
    
    Specified by:
    
    provideFields in interface ObjectProvider
    
    Parameters:
    fieldNumbers - An array of field numbers to be updated by the Store
    fm - The updated values are stored in this object. This object is only valid for the duration of this call.
  - replaceFields
```
public abstract void replaceFields(int[] fieldNumbers,
                 FieldManager fm)
```
    Called from the StoreManager to refresh data in the persistable object associated with this StateManager.
    
    Specified by:
    
    replaceFields in interface ObjectProvider
    
    Parameters:
    fieldNumbers - An array of field numbers to be refreshed by the Store
    fm - The updated values are stored in this object. This object is only valid for the duration of this call.
  - areFieldsLoaded
```
protected boolean areFieldsLoaded(int[] fieldNumbers)
```
    Accessor for whether all of the specified field numbers are loaded.
    
    Parameters:
    fieldNumbers - The field numbers to check
    
    Returns:
    Whether the specified fields are all loaded.
  - unloadNonFetchPlanFields
```
public void unloadNonFetchPlanFields()
```
    Method that will unload all fields that are not in the FetchPlan. This is typically for use when the instance is being refreshed.
    
    Specified by:
    
    unloadNonFetchPlanFields in interface ObjectProvider
  - markPKFieldsAsLoaded
```
protected void markPKFieldsAsLoaded()
```
    Convenience method to mark PK fields as loaded (if using app id).
  - updateLevel2CacheForFields
```
protected void updateLevel2CacheForFields(int[] fieldNumbers)
```
    Convenience method to update a Level2 cached version of this object if cacheable and has not been modified during this transaction. If any of the specified fields are not loaded in the current L2 cached object this will update the loaded value for that field(s).
    
    Parameters:
    fieldNumbers - Numbers of fields to update in L2 cached object
  - loadFieldsFromLevel2Cache
```
protected int[] loadFieldsFromLevel2Cache(int[] fieldNumbers)
```
    Convenience method to retrieve field values from an L2 cached object if they are loaded in that object. If the object is not in the L2 cache then just returns, and similarly if the required fields aren't available.
    
    Parameters:
    fieldNumbers - Numbers of fields to load from the L2 cache
    
    Returns:
    The fields that couldn't be loaded
  - loadFieldsInFetchPlan
```
public void loadFieldsInFetchPlan(FetchPlanState state)
```
    Method to load all unloaded fields in the FetchPlan. Recurses through the FetchPlan objects and loads fields of sub-objects where needed. Used as a precursor to detaching objects at commit since fields can't be loaded during the postCommit phase when the detach actually happens.
    
    Specified by:
    
    loadFieldsInFetchPlan in interface ObjectProvider
    
    Parameters:
    state - The FetchPlan state
  - loadFieldFromDatastore
```
public void loadFieldFromDatastore(int fieldNumber)
```
    Convenience method to load a field from the datastore. Used in attaching fields and checking their old values (so we dont want any postLoad method being called). TODO Merge this with one of the loadXXXFields methods.
    
    Specified by:
    
    loadFieldFromDatastore in interface ObjectProvider
    
    Parameters:
    fieldNumber - The field number.
  - loadFieldsFromDatastore
```
protected void loadFieldsFromDatastore(int[] fieldNumbers)
```
    Convenience method to load fields from the datastore. Note that if the fieldNumbers is null/empty we still should call the persistence handler since it may mean that the version field needs loading.
    
    Parameters:
    fieldNumbers - The field numbers.
  - getFieldNumbersOfLoadedOrDirtyFields
```
protected int[] getFieldNumbersOfLoadedOrDirtyFields(boolean[] loadedFields,
                                         boolean[] dirtyFields)
```
    Convenience accessor to return the field numbers for the input loaded and dirty field arrays.
    
    Parameters:
    loadedFields - Fields that were detached with the object
    dirtyFields - Fields that have been modified while detached
  - getDirtyFields
```
public boolean[] getDirtyFields()
```
    Creates a copy of the dirtyFields bitmap.
    
    Specified by:
    
    getDirtyFields in interface ObjectProvider
    
    Returns:
    a copy of the dirtyFields bitmap.
  - getDirtyFieldNumbers
```
public int[] getDirtyFieldNumbers()
```
    Accessor for the field numbers of all dirty fields.
    
    Specified by:
    
    getDirtyFieldNumbers in interface ObjectProvider
    
    Returns:
    Absolute field numbers of the dirty fields in this instance.
  - getLoadedFields
```
public boolean[] getLoadedFields()
```
    Accessor for the fields
    
    Specified by:
    
    getLoadedFields in interface ObjectProvider
    
    Returns:
    boolean array of loaded state in order of absolute field numbers
  - getLoadedFieldNumbers
```
public int[] getLoadedFieldNumbers()
```
    Accessor for the field numbers of all loaded fields in this managed instance.
    
    Specified by:
    
    getLoadedFieldNumbers in interface ObjectProvider
    
    Returns:
    Field numbers of all (currently) loaded fields
  - getAllFieldsLoaded
```
public boolean getAllFieldsLoaded()
```
    Returns whether all fields are loaded.
    
    Specified by:
    
    getAllFieldsLoaded in interface ObjectProvider
    
    Returns:
    Returns true if all fields are loaded.
  - getDirtyFieldNames
```
public String[] getDirtyFieldNames()
```
    Convenience accessor for the names of the fields that are dirty.
    
    Specified by:
    
    getDirtyFieldNames in interface ObjectProvider
    
    Returns:
    Names of the dirty fields
  - getLoadedFieldNames
```
public String[] getLoadedFieldNames()
```
    Convenience accessor for the names of the fields that are loaded.
    
    Specified by:
    
    getLoadedFieldNames in interface ObjectProvider
    
    Returns:
    Names of the loaded fields
  - isFieldLoaded
```
public boolean isFieldLoaded(int fieldNumber)
```
    Accessor for whether a field is currently loaded. Just returns the status, unlike "isLoaded" which also loads it if not.
    
    Specified by:
    
    isFieldLoaded in interface ObjectProvider
    
    Parameters:
    fieldNumber - The (absolute) field number
    
    Returns:
    Whether it is loaded
  - clearFieldsByNumbers
```
protected void clearFieldsByNumbers(int[] fieldNumbers)
```
  - clearDirtyFlags
```
protected void clearDirtyFlags()
```
    Method to clear all dirty flags on the object.
  - clearDirtyFlags
```
protected void clearDirtyFlags(int[] fieldNumbers)
```
    Method to clear all dirty flags on the object.
    
    Parameters:
    fieldNumbers - the fields to clear
  - unloadField
```
public void unloadField(String fieldName)
```
    Convenience method to unload a field/property.
    
    Specified by:
    
    unloadField in interface ObjectProvider
    
    Parameters:
    fieldName - Name of the field/property
    
    Throws:
    
    NucleusUserException - if the object managed by this StateManager is embedded
  - isEmbedded
```
public boolean isEmbedded()
```
    Convenience accessor for whether this StateManager manages an embedded/serialised object.
    
    Specified by:
    
    isEmbedded in interface ObjectProvider
    
    Returns:
    Whether the managed object is embedded/serialised.
  - setPcObjectType
```
public void setPcObjectType(short objType)
```
    Method to set this StateManager as managing an embedded/serialised object.
    
    Specified by:
    
    setPcObjectType in interface ObjectProvider
    
    Parameters:
    objType - The type of object being managed
  - lock
```
public void lock(short lockMode)
```
    Description copied from interface: ObjectProvider
    
    Method to lock the object owned by this ObjectProvider.
    
    Specified by:
    
    lock in interface ObjectProvider
    
    Parameters:
    lockMode - Lock mode to apply
  - unlock
```
public void unlock()
```
    Description copied from interface: ObjectProvider
    
    Method to unlock the object owned by this ObjectProvider (if locked).
    
    Specified by:
    
    unlock in interface ObjectProvider
  - getLockMode
```
public short getLockMode()
```
    Description copied from interface: ObjectProvider
    
    Accessor for the current lock mode.
    
    Specified by:
    
    getLockMode in interface ObjectProvider
    
    Returns:
    Lock mode
  - setAssociatedValue
```
public void setAssociatedValue(Object key,
                      Object value)
```
    Method to set an associated value stored with this object. This is for a situation such as in ORM where this object can have an "external" foreign-key provided by an owning object (e.g 1-N uni relation and this is the element with no knowledge of the owner, so the associated value is the FK value).
    
    Specified by:
    
    setAssociatedValue in interface ObjectProvider
    
    Parameters:
    key - Key for the value
    value - The associated value
  - getAssociatedValue
```
public Object getAssociatedValue(Object key)
```
    Accessor for an associated value stored with this object. This is for a situation such as in ORM where this object can have an "external" foreign-key provided by an owning object (e.g 1-N uni relation and this is the element with no knowledge of the owner, so the associated value is the FK value).
    
    Specified by:
    
    getAssociatedValue in interface ObjectProvider
    
    Parameters:
    key - Key for the value
    
    Returns:
    The associated value
  - removeAssociatedValue
```
public void removeAssociatedValue(Object key)
```
    Description copied from interface: ObjectProvider
    
    Method to remove the associated value with the specified key (if it exists).
    
    Specified by:
    
    removeAssociatedValue in interface ObjectProvider
    
    Parameters:
    key - The key
  - containsAssociatedValue
```
public boolean containsAssociatedValue(Object key)
```
  - getObjectValueGenerator
```
protected static ObjectValueGenerator getObjectValueGenerator(ExecutionContext ec,
                                           String genName)
```
    Method to find an object value generator based on its name. Caches the generators once generated.
    
    Parameters:
    ec - ExecutionContext
    genName - The generator name
    
    Returns:
    The value generator (if any)
    
    Throws:
    
    NucleusException - if no generator of that name is found

Class AbstractStateManager

Field Summary

Fields inherited from interface org.datanucleus.state.ObjectProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.datanucleus.state.ObjectProvider

Field Detail

LOCALISER

HOLLOWFIELDMANAGER

FLAG_STORING_PC

FLAG_NEED_INHERITANCE_VALIDATION

FLAG_POSTINSERT_UPDATE

FLAG_LOADINGFPFIELDS

FLAG_POSTLOAD_PENDING

FLAG_CHANGING_STATE

FLAG_FLUSHED_NEW

FLAG_BECOMING_DELETED

FLAG_UPDATING_EMBEDDING_FIELDS_WITH_OWNER

FLAG_RETRIEVING_DETACHED_STATE

FLAG_RESETTING_DETACHED_STATE

FLAG_ATTACHING

FLAG_DETACHING

FLAG_MAKING_TRANSIENT

FLAG_FLUSHING

FLAG_DISCONNECTING

flags

restoreValues

myEC

cmd

myInternalID

myID

myLC

myVersion

transactionalVersion

persistenceFlags

myFP

dirty

dirtyFields

loadedFields

lock

lockMode

savedFlags

savedLoadedFields

activity

currFM

objectType

objectValGenerators

Constructor Detail

AbstractStateManager

Method Detail

connect

getClassMetaData

getExecutionContext

getLifecycleState

getCallbackHandler

getObject

getObjectAsPrintable

toString

getInternalObjectId

isInserting

isWaitingToBeFlushedToDatastore

isRestoreValues

setStoringPC

unsetStoringPC

isStoringPC

isPostLoadPending

isChangingState

isResettingDetachedState

isRetrievingDetachedState

isDisconnecting

isMakingTransient

isDeleting

becomingDeleted

markForInheritanceValidation

isDetaching

isAttaching

setTransactionalVersion

getTransactionalVersion

setVersion