org.springframework.extensions.surf.persister

Class MultiObjectPersister

java.lang.Object

org.springframework.extensions.surf.persister.AbstractObjectPersister

org.springframework.extensions.surf.persister.MultiObjectPersister

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, ModelObjectPersister, CachedPersister

public class MultiObjectPersister
extends AbstractObjectPersister
implements CachedPersister

MultiModelObjectPersister class maintains the ModelObjectPersister contract but redirects the retrieval of objects to a number of delegates. The delegate persisters can be of any persister implementation and are called in order of the supplied map of persisters during construction.

Author:

muzquiano, kevinr, David Draper

Field Summary

Fields inherited from class org.springframework.extensions.surf.persister.AbstractObjectPersister

MODELOBJECT_CLASSES

Constructor Summary

Constructors

Constructor and Description
MultiObjectPersister()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,ModelObject>	getAllObjects(ModelPersistenceContext context, String objectTypeId) Returns a map of all of the objects referenced by this persister.
Map<String,ModelObject>	getAllObjectsByFilter(ModelPersistenceContext context, String objectTypeId, String filter) Returns a map of all of the objects referenced by this persister filtered by the given ID filter.
ModelObject	getObject(ModelPersistenceContext context, String objectTypeId, String objectId) Iterates over the persisters list attempting to find a ModelObject of the supplied type with the supplied id.
List<ModelObjectPersister>	getPersisters() Gets the persisters.
long	getTimestamp(ModelPersistenceContext context, String objectTypeId, String objectId) Returns the timestamp of the given object in the underlying store
boolean	hasObject(ModelPersistenceContext context, ModelObject object) Checks whether the given object is persisted
boolean	hasObject(ModelPersistenceContext context, String objectTypeId, String objectId) Checks whether an object with the given path is persisted
boolean	hasReadOnlyStore() Indicates whether or not the persister uses a store that is read only.
void	init(ModelPersistenceContext context) If this MultiObjectPerister has been added to the list of ModelObjectPersisters managed by a PeristerService then this method will be invoked when that PeristerService is initialised.
void	invalidateCache() Invalidates the cache
ModelObject	newObject(ModelPersistenceContext context, String objectTypeId, String objectId) Creates a new object of the supplied type with the supplied id using the
boolean	removeObject(ModelPersistenceContext context, ModelObject object) Removes the supplied object the first ModelObjectPersister containing a match.
boolean	removeObject(ModelPersistenceContext context, String objectTypeId, String objectId) Removes an object with the supplied type and id from the first ModelObjectPersister containing a match.
boolean	saveObject(ModelPersistenceContext context, ModelObject object) Saves the supplied ModelObject using the default ModelObjectPersister (Please note: saving does not iterate over the persisters list - it only used the default persister.
boolean	saveObjects(ModelPersistenceContext context, List<ModelObject> objects) Saves the supplied ModelObject list using the default ModelObjectPersister (Please note: saving does not iterate over the persisters list - it only used the default persister.
void	setCache(boolean cache) Enables or disables the caching mechanics
void	setCacheCheckDelay(int cacheCheckDelay) Sets the number of seconds to wait between cache checks, -1 for never.
void	setCacheMaxSize(int cacheMaxSize) Sets the maximum size of the underlying cache, -1 for no max size.
void	setDefaultPersister(ModelObjectPersister defaultPersister) Sets the default persister.
void	setPersisters(List<ModelObjectPersister> persisters) Sets the persisters.
String	toString()

Methods inherited from class org.springframework.extensions.surf.persister.AbstractObjectPersister

disable, getId, getPersisterService, getServiceRegistry, getWebFrameworkConfiguration, isEnabled, reset, setBeanName, setPersisterService, setServiceRegistry, setWebFrameworkConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiObjectPersister

public MultiObjectPersister()

Method Detail

setPersisters

public void setPersisters(List<ModelObjectPersister> persisters)

Sets the persisters.

Parameters:

persisters - the new persisters

getPersisters

public List<ModelObjectPersister> getPersisters()

Gets the persisters.

Returns:

the list of persisters

setDefaultPersister

public void setDefaultPersister(ModelObjectPersister defaultPersister)

Sets the default persister.

Parameters:

defaultPersister - the new default persister

getObject

public ModelObject getObject(ModelPersistenceContext context,
                    String objectTypeId,
                    String objectId)
                      throws ModelObjectPersisterException

Iterates over the persisters list attempting to find a ModelObject of the supplied type with the supplied id. The first match will be returned.

Specified by:

getObject in interface ModelObjectPersister

Parameters:

context - The current persistence context

objectTypeId - The type of object to retrieve

objectId - The id of the object to retrieve

Returns:

A ModelObject matching the supplied type and id (or null if a match could not be found.

Throws:

ModelObjectPersisterException

saveObject

public boolean saveObject(ModelPersistenceContext context,
                 ModelObject object)
                   throws ModelObjectPersisterException

Saves the supplied ModelObject using the default ModelObjectPersister (Please note: saving does not iterate over the persisters list - it only used the default persister.

Specified by:

saveObject in interface ModelObjectPersister

Parameters:

context - The current persistence context

object - The ModelObject to save.

Returns:

true if the object was successfully saved and false otherwise.

Throws:

ModelObjectPersisterException - If an error occurred saving the object.

saveObjects

public boolean saveObjects(ModelPersistenceContext context,
                  List<ModelObject> objects)
                    throws ModelObjectPersisterException

Saves the supplied ModelObject list using the default ModelObjectPersister (Please note: saving does not iterate over the persisters list - it only used the default persister.

Specified by:

saveObjects in interface ModelObjectPersister

Parameters:

context - The current persistence context

objects - The List of ModelObjects to save.

Returns:

true if the objects were successfully saved and false otherwise.

Throws:

ModelObjectPersisterException - If an error occurred saving the objects.

removeObject

public boolean removeObject(ModelPersistenceContext context,
                   ModelObject object)
                     throws ModelObjectPersisterException

Removes the supplied object the first ModelObjectPersister containing a match.

Specified by:

removeObject in interface ModelObjectPersister

Overrides:

removeObject in class AbstractObjectPersister

Parameters:

context - The current persistence context

object - The object to remove

Returns:

true if the object was successfully removed and false otherwise.

Throws:

ModelObjectPersisterException - If an error occurs while removing the object.

removeObject

public boolean removeObject(ModelPersistenceContext context,
                   String objectTypeId,
                   String objectId)
                     throws ModelObjectPersisterException

Removes an object with the supplied type and id from the first ModelObjectPersister containing a match.

Specified by:

removeObject in interface ModelObjectPersister

Parameters:

context - The current persistence context

objectTypeId - The type of object to remove

objectId - The id of the object to remove

Returns:

true if the object was successfully removed and false otherwise.

Throws:

ModelObjectPersisterException - If an error occurs while removing the object.

hasObject

public boolean hasObject(ModelPersistenceContext context,
                ModelObject object)
                  throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Checks whether the given object is persisted

Specified by:

hasObject in interface ModelObjectPersister

Overrides:

hasObject in class AbstractObjectPersister

Parameters:

context - ModelPersistenceContext

object - ModelObject

Returns:

whether the object is persisted

Throws:

ModelObjectPersisterException

hasObject

public boolean hasObject(ModelPersistenceContext context,
                String objectTypeId,
                String objectId)
                  throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Checks whether an object with the given path is persisted

Specified by:

hasObject in interface ModelObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

objectId - String

Returns:

whether the object is persisted

Throws:

ModelObjectPersisterException

newObject

public ModelObject newObject(ModelPersistenceContext context,
                    String objectTypeId,
                    String objectId)
                      throws ModelObjectPersisterException

Creates a new object of the supplied type with the supplied id using the

Specified by:

newObject in interface ModelObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

objectId - String

Returns:

the object

Throws:

ModelObjectPersisterException

getAllObjects

public Map<String,ModelObject> getAllObjects(ModelPersistenceContext context,
                                    String objectTypeId)
                                      throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Returns a map of all of the objects referenced by this persister.

In general, this is a very expensive call and should be avoided. Each object descriptor referenced by the persister is loaded into the model object cache.

Specified by:

getAllObjects in interface ModelObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

Returns:

Map of object IDs to ModelObject instances

Throws:

ModelObjectPersisterException

getAllObjectsByFilter

public Map<String,ModelObject> getAllObjectsByFilter(ModelPersistenceContext context,
                                            String objectTypeId,
                                            String filter)
                                              throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Returns a map of all of the objects referenced by this persister filtered by the given ID filter.

In general, this is an expensive call but less expensive than getAllObjects(). Each object descriptor referenced by the persister found using the filter is loaded into the model object cache.

Specified by:

getAllObjectsByFilter in interface ModelObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

filter - String

Returns:

Map of object IDs to ModelObject instances

Throws:

ModelObjectPersisterException

getTimestamp

public long getTimestamp(ModelPersistenceContext context,
                String objectTypeId,
                String objectId)
                  throws ModelObjectPersisterException

Description copied from interface: ModelObjectPersister

Returns the timestamp of the given object in the underlying store

Specified by:

getTimestamp in interface ModelObjectPersister

Parameters:

context - ModelPersistenceContext

objectTypeId - String

objectId - String

Returns:

long

Throws:

ModelObjectPersisterException

init

public void init(ModelPersistenceContext context)

If this MultiObjectPerister has been added to the list of ModelObjectPersisters managed by a PeristerService then this method will be invoked when that PeristerService is initialised. It initialises all the delegate ModelObjectPersisters used for retrieving objects as well as the default ModelObjectPersister used for creating/saving objects (which will also be added to the list of delegates if it has not been configured as such).

Specified by:

init in interface ModelObjectPersister

Overrides:

init in class AbstractObjectPersister

Parameters:

context - the persistence context

invalidateCache

public void invalidateCache()

Description copied from interface: CachedPersister

Invalidates the cache

Specified by:

invalidateCache in interface CachedPersister

See Also:

CachedPersister.invalidateCache()

setCache

public void setCache(boolean cache)

Description copied from interface: CachedPersister

Enables or disables the caching mechanics

Specified by:

setCache in interface CachedPersister

Parameters:

cache - boolean

See Also:

CachedPersister.setCache(boolean)

setCacheCheckDelay

public void setCacheCheckDelay(int cacheCheckDelay)

Description copied from interface: CachedPersister

Sets the number of seconds to wait between cache checks, -1 for never.

Specified by:

setCacheCheckDelay in interface CachedPersister

Parameters:

cacheCheckDelay - int

See Also:

CachedPersister.setCacheCheckDelay(int)

setCacheMaxSize

public void setCacheMaxSize(int cacheMaxSize)

Description copied from interface: CachedPersister

Sets the maximum size of the underlying cache, -1 for no max size.

Specified by:

setCacheMaxSize in interface CachedPersister

Parameters:

cacheMaxSize - int

See Also:

CachedPersister.setCacheMaxSize(int)

toString

public String toString()

Overrides:

toString in class Object

hasReadOnlyStore

public boolean hasReadOnlyStore()

Description copied from interface: ModelObjectPersister

Indicates whether or not the persister uses a store that is read only.

Specified by:

hasReadOnlyStore in interface ModelObjectPersister

Returns:

boolean