org.gatein.wsrp.jcr

Interface ChromatticPersister

All Known Implementing Classes:

BaseChromatticPersister

public interface ChromatticPersister

Encapsulates Chromattic to make it a little simpler to use.

Version:

$Revision$

Author:

Chris Laprun

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ChromatticPersister.PortletNameFormatter Encodes and decodes portlet contexts to be properly persisted in JCR as '/' is a reserved char.
static class	ChromatticPersister.QNameFormatter Encodes and decodes QName to be properly persisted in JCR since ':', '{' and '}' are reserved chars.

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.
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.

Method Detail

getSession

org.chromattic.api.ChromatticSession getSession()

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

Returns:

the current ChromatticSession or a new one if none already existed

closeSession

void closeSession(boolean save)

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

Parameters:

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

save

void save()

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

delete

<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.

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

isSessionClosed

boolean isSessionClosed()

Checks whether the current session is closed.

Returns:

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