org.apache.jetspeed.components.persistence.store

Interface PersistenceStore

public interface PersistenceStore

PersistenceStore

The persistence store allows access to the persistent storage mechanism within the application.
PersistenceStore instances ARE NOT thread safe. The best practices approach for using the persistence store is to use PersistenceStoreContainer.getStoreForThread() any time the store is to be accessed.

Version:

$ $

Author:

Scott T. Weaver

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOCK_NO_LOCK No lock at all aka the object is read only changes WILL NOT be persisted at checkPoints or commits.
static int	LOCK_PESSIMISTIC changes to the object will be written to the database.
static int	LOCK_READ changes to the object will be written to the database, in this case the lock will be automatically upgraded to the write lock on transaction

Method Summary

Methods

Modifier and Type	Method and Description
void	addEventListener(PersistenceStoreEventListener listener)
void	close()
void	deleteAll(Object query)
void	deletePersistent(Object obj)
Collection	getCollectionByQuery(Object query)
Collection	getCollectionByQuery(Object query, int lockLevel)
int	getCount(Object query)
Collection	getExtent(Class clazz)
Collection	getExtent(Class clazz, int lockLevel)
Iterator	getIteratorByQuery(Object query)
Iterator	getIteratorByQuery(Object query, int lockLevel)
Object	getObjectByIdentity(Object object)
Object	getObjectByIdentity(Object object, int lockLevel)
Object	getObjectByQuery(Object query)
Object	getObjectByQuery(Object query, int lockLevel)
Transaction	getTransaction() getTransaction
void	invalidate(Object obj)
void	invalidateAll()
void	invalidateByQuery(Object query)
void	invalidateExtent(Class clazz)
boolean	isClosed() isClosed
void	lockForWrite(Object obj)
void	makePersistent(Object obj)
Filter	newFilter()
Object	newQuery(Class clazz, Filter filter)

Field Detail

LOCK_NO_LOCK

static final int LOCK_NO_LOCK

No lock at all aka the object is read only changes WILL NOT be persisted at checkPoints or commits.

See Also:

Constant Field Values

LOCK_READ

static final int LOCK_READ

changes to the object will be written to the database, in this case the lock will be automatically upgraded to the write lock on transaction

See Also:

Constant Field Values

LOCK_PESSIMISTIC

static final int LOCK_PESSIMISTIC

changes to the object will be written to the database.

See Also:

Constant Field Values

Method Detail

addEventListener

void addEventListener(PersistenceStoreEventListener listener)

close

void close()

deletePersistent

void deletePersistent(Object obj)
                      throws LockFailedException

Throws:

LockFailedException

deleteAll

void deleteAll(Object query)
               throws LockFailedException

Throws:

LockFailedException

getCollectionByQuery

Collection getCollectionByQuery(Object query)

getCollectionByQuery

Collection getCollectionByQuery(Object query,
                              int lockLevel)

getObjectByQuery

Object getObjectByQuery(Object query)

getObjectByQuery

Object getObjectByQuery(Object query,
                      int lockLevel)

getObjectByIdentity

Object getObjectByIdentity(Object object)
                           throws LockFailedException

Throws:

LockFailedException

getObjectByIdentity

Object getObjectByIdentity(Object object,
                         int lockLevel)
                           throws LockFailedException

Throws:

LockFailedException

getCount

int getCount(Object query)

getIteratorByQuery

Iterator getIteratorByQuery(Object query)

getIteratorByQuery

Iterator getIteratorByQuery(Object query,
                          int lockLevel)

isClosed

boolean isClosed()

isClosed

indicates whether or not this PersistenceStore instance has been closed. A closed store will generally throw exceptions when any operation is performed upon it.

Returns:

getTransaction

Transaction getTransaction()

getTransaction

Returns the current Transaction for thsis PersistenceStore instance. The transaction will always be the same for the lifetime of the PersistenceStore instance.

Returns:

Transaction for this PersistenceStore

invalidate

void invalidate(Object obj)
                throws LockFailedException

Throws:

LockFailedException

invalidateAll

void invalidateAll()
                   throws LockFailedException

Throws:

LockFailedException

invalidateExtent

void invalidateExtent(Class clazz)
                      throws LockFailedException

Throws:

LockFailedException

invalidateByQuery

void invalidateByQuery(Object query)
                       throws LockFailedException

Throws:

LockFailedException

lockForWrite

void lockForWrite(Object obj)
                  throws LockFailedException

Throws:

LockFailedException

makePersistent

void makePersistent(Object obj)
                    throws LockFailedException

Throws:

LockFailedException

newFilter

Filter newFilter()

newQuery

Object newQuery(Class clazz,
              Filter filter)

getExtent

Collection getExtent(Class clazz)

getExtent

Collection getExtent(Class clazz,
                   int lockLevel)