org.datanucleus.store.federation

Class FederatedPersistenceHandler

java.lang.Object

org.datanucleus.store.federation.FederatedPersistenceHandler

All Implemented Interfaces:

StorePersistenceHandler

public class FederatedPersistenceHandler
extends Object
implements StorePersistenceHandler

Persistence handler for federated datastores. Distributes the inserts/updates/deletes/fetches to the appropriate datastore.

Nested Class Summary

Nested classes/interfaces inherited from interface org.datanucleus.store.StorePersistenceHandler

StorePersistenceHandler.PersistenceBatchType

Constructor Summary

Constructors

Constructor and Description
FederatedPersistenceHandler(StoreManager storeMgr) Constructor.

Method Summary

Modifier and Type	Method and Description
void	batchEnd(ExecutionContext ec, StorePersistenceHandler.PersistenceBatchType type) Signal that the current batch of operations are ending for the specified ExecutionContext.
void	batchStart(ExecutionContext ec, StorePersistenceHandler.PersistenceBatchType batchType) Signal that a batch of operations are starting for the specified ExecutionContext.
void	close() Method to close the persistence handler, and release any resources.
void	deleteObject(ObjectProvider op) Deletes a persistent object from the datastore.
void	deleteObjects(ObjectProvider... ops) Method to delete an array of objects from the datastore.
void	fetchObject(ObjectProvider op, int[] fieldNumbers) Fetches specified fields of a persistent object from the database.
void	fetchObjects(int[] fieldNumbers, ObjectProvider... ops) Fetches specified fields of several persistent objects (of the same type) from the database.
Object	findObject(ExecutionContext ec, Object id) Method to find a persistable object with the specified id from the datastore, if the StoreManager supports this operation (optional).
Object	findObjectForUnique(ExecutionContext ec, AbstractClassMetaData cmd, String[] memberNames, Object[] values) Method to find the object with the specified value(s) for the member(s) of the specified type.
Object[]	findObjects(ExecutionContext ec, Object[] ids) Method to find an array of objects with the specified identities from the datastore.
void	insertObject(ObjectProvider op) Inserts a persistent object into the database.
void	insertObjects(ObjectProvider... ops) Method to insert an array of objects to the datastore.
void	locateObject(ObjectProvider op) Locates this object in the datastore.
void	locateObjects(ObjectProvider[] ops) Locates object(s) in the datastore.
void	updateObject(ObjectProvider op, int[] fieldNumbers) Updates a persistent object in the datastore.
boolean	useReferentialIntegrity()

Methods inherited from class java.lang.Object

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

Constructor Detail

FederatedPersistenceHandler

public FederatedPersistenceHandler(StoreManager storeMgr)

Constructor.

Parameters:

storeMgr - StoreManager

Method Detail

close

public void close()

Description copied from interface: StorePersistenceHandler

Method to close the persistence handler, and release any resources.

Specified by:

close in interface StorePersistenceHandler

useReferentialIntegrity

public boolean useReferentialIntegrity()

insertObjects

public void insertObjects(ObjectProvider... ops)

Description copied from interface: StorePersistenceHandler

Method to insert an array of objects to the datastore.

Specified by:

insertObjects in interface StorePersistenceHandler

Parameters:

ops - ObjectProviders for the objects to insert

deleteObjects

public void deleteObjects(ObjectProvider... ops)

Description copied from interface: StorePersistenceHandler

Method to delete an array of objects from the datastore.

Specified by:

deleteObjects in interface StorePersistenceHandler

Parameters:

ops - ObjectProviders for the objects to delete

batchStart

public void batchStart(ExecutionContext ec,
                       StorePersistenceHandler.PersistenceBatchType batchType)

Description copied from interface: StorePersistenceHandler

Signal that a batch of operations are starting for the specified ExecutionContext. The batch type allows the store plugin to create whatever type of batch it needs.

Specified by:

batchStart in interface StorePersistenceHandler

Parameters:

ec - The ExecutionContext

batchType - Type of this batch that is starting

batchEnd

public void batchEnd(ExecutionContext ec,
                     StorePersistenceHandler.PersistenceBatchType type)

Description copied from interface: StorePersistenceHandler

Signal that the current batch of operations are ending for the specified ExecutionContext.

Specified by:

batchEnd in interface StorePersistenceHandler

Parameters:

ec - The ExecutionContext

type - Type of batch that is ending

insertObject

public void insertObject(ObjectProvider op)

Description copied from interface: StorePersistenceHandler

Inserts a persistent object into the database.

Specified by:

insertObject in interface StorePersistenceHandler

Parameters:

op - The ObjectProvider of the object to be inserted.

updateObject

public void updateObject(ObjectProvider op,
                         int[] fieldNumbers)

Description copied from interface: StorePersistenceHandler

Updates a persistent object in the datastore.

Specified by:

updateObject in interface StorePersistenceHandler

Parameters:

op - The ObjectProvider of the object to be updated.

fieldNumbers - The numbers of the fields to be updated.

deleteObject

public void deleteObject(ObjectProvider op)

Description copied from interface: StorePersistenceHandler

Deletes a persistent object from the datastore.

Specified by:

deleteObject in interface StorePersistenceHandler

Parameters:

op - The ObjectProvider of the object to be deleted.

fetchObject

public void fetchObject(ObjectProvider op,
                        int[] fieldNumbers)

Description copied from interface: StorePersistenceHandler

Fetches specified fields of a persistent object from the database.

Specified by:

fetchObject in interface StorePersistenceHandler

Parameters:

op - The ObjectProvider of the object to be fetched.

fieldNumbers - The numbers of the fields to be fetched.

fetchObjects

public void fetchObjects(int[] fieldNumbers,
                         ObjectProvider... ops)

Description copied from interface: StorePersistenceHandler

Fetches specified fields of several persistent objects (of the same type) from the database.

Specified by:

fetchObjects in interface StorePersistenceHandler

Parameters:

fieldNumbers - The numbers of the fields to be fetched.

ops - The ObjectProviders of the objects to be fetched.

locateObject

public void locateObject(ObjectProvider op)

Description copied from interface: StorePersistenceHandler

Locates this object in the datastore.

Specified by:

locateObject in interface StorePersistenceHandler

Parameters:

op - The ObjectProvider for the object to be found

locateObjects

public void locateObjects(ObjectProvider[] ops)

Description copied from interface: StorePersistenceHandler

Locates object(s) in the datastore.

Specified by:

locateObjects in interface StorePersistenceHandler

Parameters:

ops - ObjectProvider(s) for the object(s) to be found

findObject

public Object findObject(ExecutionContext ec,
                         Object id)

Description copied from interface: StorePersistenceHandler

Method to find a persistable object with the specified id from the datastore, if the StoreManager supports this operation (optional). This allows for datastores that perform the instantiation of objects directly (such as ODBMS). With other types of datastores (e.g RDBMS) this method returns null.

Specified by:

findObject in interface StorePersistenceHandler

Parameters:

ec - The ExecutionContext

id - the id of the object in question.

Returns:

a persistable object with a valid object state (for example: hollow) or null, indicating that the implementation leaves the instantiation work to DataNucleus.

findObjects

public Object[] findObjects(ExecutionContext ec,
                            Object[] ids)

Description copied from interface: StorePersistenceHandler

Method to find an array of objects with the specified identities from the datastore. This allows for datastores that perform the instantiation of objects directly (such as ODBMS). With other types of datastores (e.g RDBMS) this method returns null.

Specified by:

findObjects in interface StorePersistenceHandler

Parameters:

ec - The ExecutionContext

ids - identities of the object(s) to retrieve

Returns:

The persistable objects with these identities (in the same order as

ids

)

findObjectForUnique

public Object findObjectForUnique(ExecutionContext ec,
                                  AbstractClassMetaData cmd,
                                  String[] memberNames,
                                  Object[] values)

Description copied from interface: StorePersistenceHandler

Method to find the object with the specified value(s) for the member(s) of the specified type.

Specified by:

findObjectForUnique in interface StorePersistenceHandler

Parameters:

ec - ExecutionContext

cmd - Metadata for the class in question

memberNames - Member(s) that define the object

values - Value(s) for the member(s)

Returns:

The object with these member value(s)