net.sf.joafip.service

Class AbstractDataAccessSession

java.lang.Object

net.sf.joafip.service.AbstractDataAccessSession

All Implemented Interfaces:

IDataAccessSessionCommon

Direct Known Subclasses:

DataAccessSession, ExclusiveDataAccessSession

@NotStorableClass
@NoStorableAccess
public abstract class AbstractDataAccessSession
extends Object
implements IDataAccessSessionCommon

common to all data access session

Author:

luc peuvrier

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CLOSE_ERROR
protected FilePersistence	filePersistence file persistence manager
protected JoafipLogger	logger
protected JoafipMutex	mutex for thread synchronization
protected static String	OPEN_ERROR
protected boolean	opened true when data access session is opened
protected boolean	opening true while in opening phase

Constructor Summary

Constructors

Constructor and Description
AbstractDataAccessSession(FilePersistence filePersistence)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assertClosed()
protected void	assertOpened()
protected void	assertPersistenceOpenned()
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	removeAllObject() remove all persistent object
Object	removeObject(String key) remove a persistent object associated to a key
protected void	setCloserTrace()
void	setEnumState(Enum<?> enumObject) Deprecated.
Object	setObject(String key, Object object) add a persistent object associated to a key
protected void	setOpenerTrace()
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)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.joafip.service.IDataAccessSessionCommon

open

Field Detail

OPEN_ERROR

protected static final String OPEN_ERROR

See Also:

Constant Field Values

CLOSE_ERROR

protected static final String CLOSE_ERROR

See Also:

Constant Field Values

logger

protected final JoafipLogger logger

filePersistence

protected final FilePersistence filePersistence

file persistence manager

mutex

protected final JoafipMutex mutex

for thread synchronization

opened

protected boolean opened

true when data access session is opened

opening

protected boolean opening

true while in opening phase

Constructor Detail

AbstractDataAccessSession

public AbstractDataAccessSession(FilePersistence filePersistence)

Method Detail

getMutex

public JoafipMutex getMutex()

Specified by:

getMutex in interface IDataAccessSessionCommon

isOpened

public boolean isOpened()
                 throws FilePersistenceException

Specified by:

isOpened in interface IDataAccessSessionCommon

Returns:

true if this data access session is opened

Throws:

FilePersistenceException

isClosed

public boolean isClosed()
                 throws FilePersistenceException

Specified by:

isClosed in interface IDataAccessSessionCommon

Returns:

true if this data access session is closed

Throws:

FilePersistenceException

storedEnum

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

Deprecated.

Description copied from interface: IDataAccessSessionCommon

inform that enum class is persisted

Specified by:

storedEnum in interface IDataAccessSessionCommon

Parameters:

enumClass - the enum class

Throws:

FilePersistenceException

storedImmutableEnum

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

Specified by:

storedImmutableEnum in interface IDataAccessSessionCommon

Throws:

FilePersistenceException

storedImmutableEnum

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

Specified by:

storedImmutableEnum in interface IDataAccessSessionCommon

Throws:

FilePersistenceException

storedMutableEnum

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

Specified by:

storedMutableEnum in interface IDataAccessSessionCommon

Throws:

FilePersistenceException

storedMutableEnum

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

Specified by:

storedMutableEnum in interface IDataAccessSessionCommon

Throws:

FilePersistenceException

getObject

public Object getObject(String key)
                 throws FilePersistenceException

Description copied from interface: IDataAccessSessionCommon

get a persistent object by its key

Specified by:

getObject in interface IDataAccessSessionCommon

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

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

Specified by:

getObject in interface IDataAccessSessionCommon

Throws:

FilePersistenceException

FilePersistenceClassNotFoundException

FilePersistenceInvalidClassException

FilePersistenceDataCorruptedException

FilePersistenceNotSerializableException

setEnumState

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

Deprecated.

Description copied from interface: IDataAccessSessionCommon

set enum state from file

Specified by:

setEnumState in interface IDataAccessSessionCommon

Parameters:

enumObject - the enum for which state must be set

Throws:

FilePersistenceException

setObject

public Object setObject(String key,
               Object object)
                 throws FilePersistenceException

Description copied from interface: IDataAccessSessionCommon

add a persistent object associated to a key

Specified by:

setObject in interface IDataAccessSessionCommon

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

public Object removeObject(String key)
                    throws FilePersistenceException

Description copied from interface: IDataAccessSessionCommon

remove a persistent object associated to a key

Specified by:

removeObject in interface IDataAccessSessionCommon

Parameters:

key - the object access key

Returns:

the removed object, null if none

Throws:

FilePersistenceException - this data access session not opened

removeAllObject

public void removeAllObject()
                     throws FilePersistenceException

Description copied from interface: IDataAccessSessionCommon

remove all persistent object

Specified by:

removeAllObject in interface IDataAccessSessionCommon

Throws:

FilePersistenceException

objectKeySet

public Set<String> objectKeySet()
                         throws FilePersistenceException

Specified by:

objectKeySet in interface IDataAccessSessionCommon

Returns:

key set of persistent objects

Throws:

FilePersistenceException - this data access session not opened

getObjects

public Collection<Object> getObjects()
                              throws FilePersistenceException

Specified by:

getObjects in interface IDataAccessSessionCommon

Returns:

all persistent objects

Throws:

FilePersistenceException

getClassIdentifier

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

Specified by:

getClassIdentifier in interface IDataAccessSessionCommon

Returns:

class identifier for a class

Throws:

FilePersistenceException

FilePersistenceClassNotFoundException

assertPersistenceOpenned

protected void assertPersistenceOpenned()
                                 throws FilePersistenceException

Throws:

FilePersistenceException

assertClosed

protected void assertClosed()
                     throws FilePersistenceException

Throws:

FilePersistenceException

assertOpened

protected void assertOpened()
                     throws FilePersistenceException

Throws:

FilePersistenceException

setOpenerTrace

protected void setOpenerTrace()

setCloserTrace

protected final void setCloserTrace()