org.datanucleus.store

Class AbstractPersistenceHandler

java.lang.Object

org.datanucleus.store.AbstractPersistenceHandler

All Implemented Interfaces:

StorePersistenceHandler

public abstract class AbstractPersistenceHandler
extends Object
implements StorePersistenceHandler

Abstract representation of a persistence handler, to be extended by datastores own variant.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Localiser	LOCALISER Localiser for messages.
protected StoreManager	storeMgr

Constructor Summary

Constructors

Constructor and Description
AbstractPersistenceHandler(StoreManager storeMgr)

Method Summary

Methods

Modifier and Type	Method and Description
void	assertReadOnlyForUpdateOfObject(ObjectProvider op) Convenience method to assert when this StoreManager is read-only and the specified object is attempting to be updated.
void	batchEnd(ExecutionContext ec, PersistenceBatchType type) Signal that the current batch of operations are ending for the specified ExecutionContext.
void	batchStart(ExecutionContext ec, PersistenceBatchType batchType) Signal that a batch of operations are starting for the specified ExecutionContext.
void	deleteObjects(ObjectProvider... ops) Method to delete an array of objects from the datastore.
Object[]	findObjects(ExecutionContext ec, Object[] ids) Simple implementation of find of multiple objects, relaying the find for each object to
void	insertObjects(ObjectProvider... ops) Method to insert an array of objects to the datastore.
void	locateObjects(ObjectProvider[] ops) Simple implementation of location of multiple objects, relaying the locate check for each object to

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.datanucleus.store.StorePersistenceHandler

close, deleteObject, fetchObject, findObject, insertObject, locateObject, updateObject

Field Detail

LOCALISER

protected static final Localiser LOCALISER

Localiser for messages.

storeMgr

protected StoreManager storeMgr

Constructor Detail

AbstractPersistenceHandler

public AbstractPersistenceHandler(StoreManager storeMgr)

Method Detail

batchStart

public void batchStart(ExecutionContext ec,
              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,
            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

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

locateObjects

public void locateObjects(ObjectProvider[] ops)

Simple implementation of location of multiple objects, relaying the locate check for each object to

locateObject

. Should be overridden by the datastore implementation if it is possible to do bulk locates.

Specified by:

locateObjects in interface StorePersistenceHandler

Parameters:

ops - ObjectProviders for the objects to locate

Throws:

NucleusObjectNotFoundException - if an object doesn't exist

NucleusDataStoreException - when an error occurs in the datastore communication

findObjects

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

Simple implementation of find of multiple objects, relaying the find for each object to

findObject

. Should be overridden by the datastore implementation if it is possible to do bulk retrieval.

Specified by:

findObjects in interface StorePersistenceHandler

Parameters:

ec - execution context

ids - identities of the object(s) to retrieve

Returns:

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

ids

)

Throws:

NucleusObjectNotFoundException - if an object doesn't exist

NucleusDataStoreException - when an error occurs in the datastore communication

assertReadOnlyForUpdateOfObject

public void assertReadOnlyForUpdateOfObject(ObjectProvider op)

Convenience method to assert when this StoreManager is read-only and the specified object is attempting to be updated.

Parameters:

op - ObjectProvider for the object