org.springframework.extensions.surf

Class ObjectPersistenceService

java.lang.Object

org.springframework.extensions.surf.ObjectPersistenceService

public final class ObjectPersistenceService
extends Object

Object Persistence Service

Generalized service for the loading, retrieving and persisting of model objects to one or more back-end persisters.

This service works at the level of objects - it does not concern itself with path-based representations of the objects (that is the role of the persisters).

Objects that are loaded from a persisters retain knowledge of their source location so that future writes occur against the same persister.

New objects are created using a specified persister or they will default to using the particular object type's registered default persister.

Author:

muzquiano, kevinr

Constructor Summary

Constructors

Constructor and Description
ObjectPersistenceService()

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,ModelObject>	getAllObjects(String objectTypeId) Retrieves all objects of a given type id.
Map<String,ModelObject>	getAllObjects(String objectTypeId, String filter) Retrieves all objects of a given type id with the given object ID filter
ModelObject	getObject(String objectTypeId, String objectId) Retrieves an object from the persister that manages the given object type.
ModelPersistenceContext	getPersistenceContext() Provides a model persistence context If Surf is running in preview mode, the model persistence context will be populated with information to inform the persisters of how to bind to the appropriate Alfresco store.
PersisterService	getPersisterService() Returns the persister service
boolean	hasObject(ModelObject object) Returns true if the object is present in a persister
boolean	hasObject(String objectTypeId, String objectId) Returns true if the object is present in a persister
void	invalidateCache() Invalidates the cache for all persisters in this persistence context
ModelObject	newObject(String objectTypeId) Create a new object.
ModelObject	newObject(String objectTypeId, String objectId) Create a new object.
boolean	removeObject(ModelObject object) Removes the object.
boolean	removeObject(String objectTypeId, String objectId) Removes the object.
boolean	saveObject(ModelObject object) Saves the object to its persister.
boolean	saveObjects(List<ModelObject> objects) Saves a list of objects to their respective persisters.
void	setPersisterService(PersisterService persisterService) Sets the persister service

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectPersistenceService

public ObjectPersistenceService()

Method Detail

setPersisterService

public void setPersisterService(PersisterService persisterService)

Sets the persister service

Parameters:

persisterService - persister service

getPersisterService

public PersisterService getPersisterService()

Returns the persister service

Returns:

persister service

getPersistenceContext

public ModelPersistenceContext getPersistenceContext()

Provides a model persistence context If Surf is running in preview mode, the model persistence context will be populated with information to inform the persisters of how to bind to the appropriate Alfresco store.

Returns:

ModelPersistenceContext

getObject

public ModelObject getObject(String objectTypeId,
                    String objectId)

Retrieves an object from the persister that manages the given object type.

If the object is not available in cache, it is loaded from storage.

Parameters:

objectTypeId - the object type id

objectId - the object id

Returns:

the ModelObject or null if not found

newObject

public ModelObject newObject(String objectTypeId,
                    String objectId)

Create a new object.

Parameters:

objectTypeId - the object type id

objectId - the object id

Returns:

the ModelObject or null if no persister for the given type can be found.

newObject

public ModelObject newObject(String objectTypeId)

Create a new object.

Parameters:

objectTypeId - the object type id

Returns:

the ModelObject or null if not found

saveObject

public boolean saveObject(ModelObject object)
                   throws ModelObjectPersisterException

Saves the object to its persister.

Parameters:

object - the ModelObject to save

Throws:

ModelObjectPersisterException

saveObjects

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

Saves a list of objects to their respective persisters. Objects with matching persisters are saved in a single saveObjects() call to reduce individual API calls.

Parameters:

objects - the List of ModelObject's to save

Throws:

ModelObjectPersisterException

removeObject

public boolean removeObject(ModelObject object)

Removes the object.

Parameters:

object - the ModelObject to remove

Returns:

true if successful, false otherwise

removeObject

public boolean removeObject(String objectTypeId,
                   String objectId)

Removes the object.

Parameters:

objectTypeId - the object type id

objectId - the object id

Returns:

true if successful, false otherwise

hasObject

public boolean hasObject(ModelObject object)

Returns true if the object is present in a persister

Parameters:

object - the ModelObject to test for

Returns:

true if found, false otherwise

hasObject

public boolean hasObject(String objectTypeId,
                String objectId)

Returns true if the object is present in a persister

Parameters:

objectTypeId - the object type id

objectId - the object id

Returns:

true if found, false otherwise

getAllObjects

public Map<String,ModelObject> getAllObjects(String objectTypeId)

Retrieves all objects of a given type id.

Parameters:

objectTypeId - Type ID

Returns:

a map of model objects (keyed by object id)

getAllObjects

public Map<String,ModelObject> getAllObjects(String objectTypeId,
                                    String filter)

Retrieves all objects of a given type id with the given object ID filter

Parameters:

objectTypeId - the object type id

Returns:

a map of model objects (keyed by object id)

invalidateCache

public void invalidateCache()

Invalidates the cache for all persisters in this persistence context