org.datanucleus.state
Class ObjectProviderFactory

java.lang.Object
  extended by org.datanucleus.state.ObjectProviderFactory

public class ObjectProviderFactory
extends java.lang.Object

Factory of ObjectProviders. Should not be used by org.datanucleus.store.* classes


Nested Class Summary
protected static class ObjectProviderFactory.Initialization
           
 
Field Summary
protected static Localiser LOCALISER
          Localiser for messages.
 
Constructor Summary
ObjectProviderFactory()
           
 
Method Summary
static ObjectProvider newForCachedPC(ExecutionContext ec, java.lang.Object id, CachedPC cachedPC)
          Constructor to create a ObjectProvider for an object taken from the L2 cache with the specified id.
static ObjectProvider newForDetached(ExecutionContext ec, java.lang.Object pc, java.lang.Object id, java.lang.Object version)
          Constructor for creating SM instances to manage persistable objects in detached state.
static ObjectProvider newForEmbedded(ExecutionContext ec, java.lang.Object pc, boolean copyPc)
          Constructs a state manager to manage a persistable instance that will be EMBEDDED/SERIALISED into another persistable object.
static ObjectProvider newForHollow(ExecutionContext ec, java.lang.Class pcClass, java.lang.Object id)
          Constructs a state manager to manage a hollow instance having the given object ID.
static ObjectProvider newForHollowPopulated(ExecutionContext ec, java.lang.Class pcClass, java.lang.Object id, FieldValues fv)
          Constructs a state manager to manage a recently populated hollow instance having the given object ID and the given field values.
static ObjectProvider newForHollowPopulatedAppId(ExecutionContext ec, java.lang.Class pcClass, FieldValues2 fv)
          Constructs a state manager to manage a hollow (or pclean) instance having the given FieldValues.
static ObjectProvider newForHollowPreConstructed(ExecutionContext ec, java.lang.Object id, java.lang.Object pc)
          Constructs a state manager to manage a hollow instance having the given object ID.
static ObjectProvider newForPersistentClean(ExecutionContext ec, java.lang.Object id, java.lang.Object pc)
          Constructs a state manager to manage the specified persistent instance having the given object ID.
static ObjectProvider newForPersistentNew(ExecutionContext ec, java.lang.Object pc, FieldValues preInsertChanges)
          Constructs a state manager to manage a transient instance that is becoming newly persistent.
static ObjectProvider newForPNewToBeDeleted(ExecutionContext ec, java.lang.Object pc)
          Constructor for creating SM instances to manage persistable objects that are not persistent yet are about to be deleted.
static ObjectProvider newForTransactionalTransient(ExecutionContext ec, java.lang.Object pc)
          Constructs a state manager to manage a Transactional Transient instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOCALISER

protected static final Localiser LOCALISER
Localiser for messages.

Constructor Detail

ObjectProviderFactory

public ObjectProviderFactory()
Method Detail

newForHollow

public static ObjectProvider newForHollow(ExecutionContext ec,
                                          java.lang.Class pcClass,
                                          java.lang.Object id)
Constructs a state manager to manage a hollow instance having the given object ID. This constructor is used for creating new instances of existing persistent objects.

Parameters:
ec - the ExecutionContext
pcClass - the class of the new instance to be created.
id - the JDO identity of the object.

newForHollowPreConstructed

public static ObjectProvider newForHollowPreConstructed(ExecutionContext ec,
                                                        java.lang.Object id,
                                                        java.lang.Object pc)
Constructs a state manager to manage a hollow instance having the given object ID. The instance is already supplied.

Parameters:
ec - ExecutionContext
id - the JDO identity of the object.
pc - The object that is hollow that we are going to manage

newForHollowPopulated

public static ObjectProvider newForHollowPopulated(ExecutionContext ec,
                                                   java.lang.Class pcClass,
                                                   java.lang.Object id,
                                                   FieldValues fv)
Constructs a state manager to manage a recently populated hollow instance having the given object ID and the given field values. This constructor is used for creating new instances of persistent objects obtained e.g. via a Query or backed by a view.

Parameters:
ec - ExecutionContext
pcClass - the class of the new instance to be created.
id - the JDO identity of the object.
fv - the initial field values of the object.

newForPersistentClean

public static ObjectProvider newForPersistentClean(ExecutionContext ec,
                                                   java.lang.Object id,
                                                   java.lang.Object pc)
Constructs a state manager to manage the specified persistent instance having the given object ID.

Parameters:
ec - the execution context controlling this state manager.
id - the JDO identity of the object.
pc - The object that is persistent that we are going to manage

newForHollowPopulatedAppId

public static ObjectProvider newForHollowPopulatedAppId(ExecutionContext ec,
                                                        java.lang.Class pcClass,
                                                        FieldValues2 fv)
Constructs a state manager to manage a hollow (or pclean) instance having the given FieldValues. This constructor is used for creating new instances of existing persistent objects using application identity.

Parameters:
ec - ExecutionContext
pcClass - the class of the new instance to be created.
fv - the initial field values of the object.

newForEmbedded

public static ObjectProvider newForEmbedded(ExecutionContext ec,
                                            java.lang.Object pc,
                                            boolean copyPc)
Constructs a state manager to manage a persistable instance that will be EMBEDDED/SERIALISED into another persistable object. The instance will not be assigned an identity in the process since it is a SCO.

Parameters:
ec - ExecutionContext
pc - The persistable to manage (see copyPc also)
copyPc - Whether the SM should manage a copy of the passed PC or that one

newForPersistentNew

public static ObjectProvider newForPersistentNew(ExecutionContext ec,
                                                 java.lang.Object pc,
                                                 FieldValues preInsertChanges)
Constructs a state manager to manage a transient instance that is becoming newly persistent. A new object ID for the instance is obtained from the store manager and the object is inserted in the data store. This constructor is used for assigning state managers to existing instances that are transitioning to a persistent state.

Parameters:
ec - ExecutionContext
pc - the instance being make persistent.
preInsertChanges - Any changes to make before inserting

newForTransactionalTransient

public static ObjectProvider newForTransactionalTransient(ExecutionContext ec,
                                                          java.lang.Object pc)
Constructs a state manager to manage a Transactional Transient instance. A new object ID for the instance is obtained from the store manager and the object is inserted in the data store. This constructor is used for assigning state managers to Transient instances that are transitioning to a transient clean state.

Parameters:
ec - ExecutionContext
pc - the instance being make persistent.

newForDetached

public static ObjectProvider newForDetached(ExecutionContext ec,
                                            java.lang.Object pc,
                                            java.lang.Object id,
                                            java.lang.Object version)
Constructor for creating SM instances to manage persistable objects in detached state.

Parameters:
ec - ExecutionContext
pc - the detached object
id - the JDO identity of the object.
version - the detached version

newForPNewToBeDeleted

public static ObjectProvider newForPNewToBeDeleted(ExecutionContext ec,
                                                   java.lang.Object pc)
Constructor for creating SM instances to manage persistable objects that are not persistent yet are about to be deleted. Consequently the initial lifecycle state will be P_NEW, but will soon move to P_NEW_DELETED.

Parameters:
ec - Execution Context
pc - the object being deleted from persistence

newForCachedPC

public static ObjectProvider newForCachedPC(ExecutionContext ec,
                                            java.lang.Object id,
                                            CachedPC cachedPC)
Constructor to create a ObjectProvider for an object taken from the L2 cache with the specified id. Makes a copy of the cached object, assigns a ObjectProvider to it, and copies across the fields that were loaded when cached.

Parameters:
ec - ExecutionContext
id - Id to assign to the persistable object
cachedPC - CachedPC object from the L2 cache


Copyright © 2011. All Rights Reserved.