net.sf.joafip.service

Interface IDataAccessSessionCommon

All Known Subinterfaces:

IAloneDataAccessSession, IDataAccessSession, IExclusiveDataAccessSession

All Known Implementing Classes:

AbstractDataAccessSession, AloneDataAccessSession, DataAccessSession, ExclusiveDataAccessSession

public interface IDataAccessSessionCommon

common to all data access session implementation

Author:

luc peuvrier

Method Summary

Methods

Modifier and Type	Method and Description
int	getClassIdentifier(Class<?> clazz)
JoafipMutex	getMutex()
Object	getObject(long dataRecordIdentifier)
Object	getObject(String key) get a persistent object by its key
Collection<Object>	getObjects()
boolean	isClosed()
boolean	isOpened()
Set<String>	objectKeySet()
void	open() open this data access session, not synchronized with other session
void	removeAllObject() remove all persistent object
Object	removeObject(String key) remove a persistent object associated to a key
void	setEnumState(Enum<?> enumObject) Deprecated.
Object	setObject(String key, Object object) add a persistent object associated to a key
void	storedEnum(Class<? extends Enum<?>> enumClass) Deprecated.
void	storedImmutableEnum(Class<? extends Enum<?>> enumClass)
void	storedImmutableEnum(Class<? extends Enum<?>>[] enumClasses)
void	storedMutableEnum(Class<? extends Enum<?>> enumClass)
void	storedMutableEnum(Class<? extends Enum<?>>[] enumClasses)

Method Detail

storedEnum

@Deprecated
void storedEnum(Class<? extends Enum<?>> enumClass)
                throws FilePersistenceException

Deprecated.

inform that enum class is persisted

Parameters:

enumClass - the enum class

Throws:

FilePersistenceException

storedImmutableEnum

void storedImmutableEnum(Class<? extends Enum<?>> enumClass)
                         throws FilePersistenceException

Throws:

FilePersistenceException

storedImmutableEnum

void storedImmutableEnum(Class<? extends Enum<?>>[] enumClasses)
                         throws FilePersistenceException

Throws:

FilePersistenceException

storedMutableEnum

void storedMutableEnum(Class<? extends Enum<?>> enumClass)
                       throws FilePersistenceException

Throws:

FilePersistenceException

storedMutableEnum

void storedMutableEnum(Class<? extends Enum<?>>[] enumClasses)
                       throws FilePersistenceException

Throws:

FilePersistenceException

open

void open()
          throws FilePersistenceException,
                 FilePersistenceClassNotFoundException,
                 FilePersistenceInvalidClassException,
                 FilePersistenceDataCorruptedException,
                 FilePersistenceNotSerializableException

open this data access session, not synchronized with other session

Throws:

FilePersistenceException - failed read root object, session close pending can not reopen

FilePersistenceInvalidClassException - something is wrong with a class used by serialization

FilePersistenceDataCorruptedException - data is inconsistent.

FilePersistenceClassNotFoundException - Class of a serialized object cannot be found.

FilePersistenceNotSerializableException - Some object to be serialized does not follow joafip persistence rules or does not implement the java.io.Serializable interface.

isOpened

boolean isOpened()
                 throws FilePersistenceException

Returns:

true if this data access session is opened

Throws:

FilePersistenceException

isClosed

boolean isClosed()
                 throws FilePersistenceException

Returns:

true if this data access session is closed

Throws:

FilePersistenceException

getObject

Object getObject(String key)
                 throws FilePersistenceException

get a persistent object by its key

Parameters:

key - the persistent object key

Returns:

the object or null if none for the key

Throws:

FilePersistenceException - this data access session not opened

getObject

Object getObject(long dataRecordIdentifier)
                 throws FilePersistenceException,
                        FilePersistenceClassNotFoundException,
                        FilePersistenceInvalidClassException,
                        FilePersistenceDataCorruptedException,
                        FilePersistenceNotSerializableException

Throws:

FilePersistenceException

FilePersistenceClassNotFoundException

FilePersistenceInvalidClassException

FilePersistenceDataCorruptedException

FilePersistenceNotSerializableException

setObject

Object setObject(String key,
               Object object)
                 throws FilePersistenceException

add a persistent object associated to a key

Parameters:

key - the object access key

object - the persistent object

Returns:

the replaced object, null if none

Throws:

FilePersistenceException - this data access session not opened

removeObject

Object removeObject(String key)
                    throws FilePersistenceException

remove a persistent object associated to a key

Parameters:

key - the object access key

Returns:

the removed object, null if none

Throws:

FilePersistenceException - this data access session not opened

removeAllObject

void removeAllObject()
                     throws FilePersistenceException

remove all persistent object

Throws:

FilePersistenceException

setEnumState

@Deprecated
void setEnumState(Enum<?> enumObject)
                  throws FilePersistenceException

Deprecated.

set enum state from file

Parameters:

enumObject - the enum for which state must be set

Throws:

FilePersistenceException

objectKeySet

Set<String> objectKeySet()
                         throws FilePersistenceException

Returns:

key set of persistent objects

Throws:

FilePersistenceException - this data access session not opened

getObjects

Collection<Object> getObjects()
                              throws FilePersistenceException

Returns:

all persistent objects

Throws:

FilePersistenceException

getClassIdentifier

int getClassIdentifier(Class<?> clazz)
                       throws FilePersistenceException,
                              FilePersistenceClassNotFoundException

Parameters:

clazz -

Returns:

class identifier for a class

Throws:

FilePersistenceException

FilePersistenceClassNotFoundException

getMutex

JoafipMutex getMutex()