org.gatein.wsrp.jcr

Class BaseChromatticPersister

java.lang.Object

org.gatein.wsrp.jcr.BaseChromatticPersister

All Implemented Interfaces:

ChromatticPersister

public abstract class BaseChromatticPersister
extends Object
implements ChromatticPersister

Base class for ChromatticPersister implementations.

Version:

$Revision$

Author:

Chris Laprun

Nested Class Summary

Nested classes/interfaces inherited from interface org.gatein.wsrp.jcr.ChromatticPersister

ChromatticPersister.PortletNameFormatter, ChromatticPersister.QNameFormatter

Field Summary

Fields

Modifier and Type	Field and Description
static String	PORTLET_STATES_WORKSPACE_NAME
protected static String	REPOSITORY_NAME
protected String	workspaceName
static String	WSRP_WORKSPACE_NAME

Constructor Summary

Constructors

Constructor and Description
BaseChromatticPersister(String workspaceName)

Method Summary

Methods

Modifier and Type	Method and Description
void	closeSession(boolean save) Closes the current ChromatticSession, saving the associated operations if so specified
<T> boolean	delete(T toDelete, StoresByPathManager<T> manager) Deletes the specified object from the specified manager, the manager being, most of the time, the parent of the object to be deleted.
org.chromattic.api.ChromatticSession	getSession() Retrieves the current ChromatticSession or open a new one if none already existed.
void	initializeBuilderFor(List<Class> mappingClasses) Initializes Chromattic with the specified mapping classes.
boolean	isSessionClosed() Checks whether the current session is closed.
void	save() Saves the modifications made in the context of the current session but keep the session open.
protected abstract void	setBuilderOptions(org.chromattic.api.ChromatticBuilder builder)

Methods inherited from class java.lang.Object

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

Field Detail

WSRP_WORKSPACE_NAME

public static final String WSRP_WORKSPACE_NAME

See Also:

Constant Field Values

PORTLET_STATES_WORKSPACE_NAME

public static final String PORTLET_STATES_WORKSPACE_NAME

See Also:

Constant Field Values

REPOSITORY_NAME

protected static final String REPOSITORY_NAME

See Also:

Constant Field Values

workspaceName

protected String workspaceName

Constructor Detail

BaseChromatticPersister

public BaseChromatticPersister(String workspaceName)

Method Detail

initializeBuilderFor

public void initializeBuilderFor(List<Class> mappingClasses)
                          throws Exception

Initializes Chromattic with the specified mapping classes. Mapping classes convert from a JCR representation to an object representation of the persisted data and back.

Parameters:

mappingClasses - the list of mapping classes this ChromatticPersister will be able to deal with.

Throws:

Exception

setBuilderOptions

protected abstract void setBuilderOptions(org.chromattic.api.ChromatticBuilder builder)

getSession

public org.chromattic.api.ChromatticSession getSession()

Description copied from interface: ChromatticPersister

Retrieves the current ChromatticSession or open a new one if none already existed.

Specified by:

getSession in interface ChromatticPersister

Returns:

the current ChromatticSession or a new one if none already existed

closeSession

public void closeSession(boolean save)

Description copied from interface: ChromatticPersister

Closes the current ChromatticSession, saving the associated operations if so specified

Specified by:

closeSession in interface ChromatticPersister

Parameters:

save - whether or not to save the operations associated with the session

isSessionClosed

public boolean isSessionClosed()

Description copied from interface: ChromatticPersister

Checks whether the current session is closed.

Specified by:

isSessionClosed in interface ChromatticPersister

Returns:

true if no current session exists or if it's closed, false otherwise

save

public void save()

Description copied from interface: ChromatticPersister

Saves the modifications made in the context of the current session but keep the session open.

Specified by:

save in interface ChromatticPersister

delete

public <T> boolean delete(T toDelete,
                 StoresByPathManager<T> manager)

Description copied from interface: ChromatticPersister

Deletes the specified object from the specified manager, the manager being, most of the time, the parent of the object to be deleted.

Specified by:

delete in interface ChromatticPersister

Type Parameters:

T - the type of the object to delete

Parameters:

toDelete - the object to delete

manager - the StoresByPathManager object that needs to be notified (to be updated) of the deletion

Returns:

the object that was deleted or null if no such object existed in persistence