org.exoplatform.services.jcr.dataflow.persistent

Interface WorkspaceStorageCache

All Superinterfaces:

ItemsPersistenceListener, MandatoryItemsPersistenceListener

public interface WorkspaceStorageCache
extends MandatoryItemsPersistenceListener

Created by The eXo Platform SAS
Defines storage cache contract

Version:

$Id: WorkspaceStorageCache.java 13869 2008-05-05 08:40:10Z pnedonosko $

Author:

Gennady Azarenkov

Level API:

Unsupported

Field Summary

Fields

Modifier and Type	Field and Description
static String	LIVE_TIME_PARAMETER_NAME
static String	MAX_SIZE_PARAMETER_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	addChildNodes(org.exoplatform.services.jcr.datamodel.NodeData parent, List<org.exoplatform.services.jcr.datamodel.NodeData> childNodes) Adds (update should not be the case!) list of child nodes.
void	addChildNodes(org.exoplatform.services.jcr.datamodel.NodeData parent, org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter pattern, List<org.exoplatform.services.jcr.datamodel.NodeData> childNodes) Adds (update should not be the case!) list of child nodes.
void	addChildNodesByPage(org.exoplatform.services.jcr.datamodel.NodeData parent, List<org.exoplatform.services.jcr.datamodel.NodeData> childs, int fromOrderNum) Adds page of child nodes.
void	addChildNodesCount(org.exoplatform.services.jcr.datamodel.NodeData parent, int count) Adds the total amount of children nodes.
void	addChildProperties(org.exoplatform.services.jcr.datamodel.NodeData parent, List<org.exoplatform.services.jcr.datamodel.PropertyData> childProperties) Adds (update should not be the case!) list of child properties.
void	addChildProperties(org.exoplatform.services.jcr.datamodel.NodeData parent, org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter pattern, List<org.exoplatform.services.jcr.datamodel.PropertyData> childProperties) Adds (update should not be the case!) list of child properties.
void	addChildPropertiesList(org.exoplatform.services.jcr.datamodel.NodeData parent, List<org.exoplatform.services.jcr.datamodel.PropertyData> childProperties) Adds (update should not be the case!) list of child properties with empty values.
void	addListener(WorkspaceStorageCacheListener listener) Adds a new listener
void	addReferencedProperties(String identifier, List<org.exoplatform.services.jcr.datamodel.PropertyData> refProperties) Add referenced properties.
void	beginTransaction() Start buffering process.
void	commitTransaction() Sort changes and commit data to the cache.
ItemData	get(String identifier) Get item by identifier.
ItemData	get(String parentIdentifier, org.exoplatform.services.jcr.datamodel.QPathEntry name, org.exoplatform.services.jcr.datamodel.ItemType itemType) Get item by parent identifier and name +index of define type.
List<org.exoplatform.services.jcr.datamodel.NodeData>	getChildNodes(org.exoplatform.services.jcr.datamodel.NodeData parent) Get child nodes.
List<org.exoplatform.services.jcr.datamodel.NodeData>	getChildNodes(org.exoplatform.services.jcr.datamodel.NodeData parent, org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter pattern) Get child nodes by pattern.
List<org.exoplatform.services.jcr.datamodel.NodeData>	getChildNodesByPage(org.exoplatform.services.jcr.datamodel.NodeData parent, int fromOrderNum) Get page of child nodes.
int	getChildNodesCount(org.exoplatform.services.jcr.datamodel.NodeData parent) Get child nodes count.
List<org.exoplatform.services.jcr.datamodel.PropertyData>	getChildProperties(org.exoplatform.services.jcr.datamodel.NodeData parent) Get node child properties.
List<org.exoplatform.services.jcr.datamodel.PropertyData>	getChildProperties(org.exoplatform.services.jcr.datamodel.NodeData parent, org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter pattern) Get node child properties by pattern.
List<org.exoplatform.services.jcr.datamodel.PropertyData>	getReferencedProperties(String identifier) Get referenced properties.
long	getSize() Cache size.
boolean	isChildNodesByPageSupported()
boolean	isEnabled()
boolean	isPatternSupported()
List<org.exoplatform.services.jcr.datamodel.PropertyData>	listChildProperties(org.exoplatform.services.jcr.datamodel.NodeData parentData) List node child properties. A difference from getChildProperties(org.exoplatform.services.jcr.datamodel.NodeData) it's that the method may return list of node properties (PropertyData) which contains no data (ValueData). Used for Node.hasProperties(), NodeIndexer.createDoc().
void	put(ItemData item) Adds (or updates if found) ItemData.
void	remove(ItemData item) Removes data and its children from cache.
void	remove(String identifier, ItemData item) Removes an item from the cache if and only if the current item for the provided identifier is equals to the provided item.
void	removeListener(WorkspaceStorageCacheListener listener) Removes a listener
void	rollbackTransaction() Forget about changes

Methods inherited from interface org.exoplatform.services.jcr.dataflow.persistent.ItemsPersistenceListener

isTXAware, onSaveItems

Field Detail

MAX_SIZE_PARAMETER_NAME

static final String MAX_SIZE_PARAMETER_NAME

See Also:

Constant Field Values

LIVE_TIME_PARAMETER_NAME

static final String LIVE_TIME_PARAMETER_NAME

See Also:

Constant Field Values

Method Detail

get

ItemData get(String parentIdentifier,
           org.exoplatform.services.jcr.datamodel.QPathEntry name,
           org.exoplatform.services.jcr.datamodel.ItemType itemType)

Get item by parent identifier and name +index of define type.

Parameters:

parentIdentifier - parent identifier

name - item name

itemType - item type

Returns:

itemData by parent Identifier and item name with index of define type or null in other case

get

ItemData get(String identifier)

Get item by identifier.

Parameters:

identifier - the Item Data identifier

Returns:

ItemData by Identifier or null if not found

getChildNodes

List<org.exoplatform.services.jcr.datamodel.NodeData> getChildNodes(org.exoplatform.services.jcr.datamodel.NodeData parent)

Get child nodes.

Parameters:

parent - the parent node data

Returns:

child nodes for parent if found; empty list if no items found; null if no items initialized

getChildNodesByPage

List<org.exoplatform.services.jcr.datamodel.NodeData> getChildNodesByPage(org.exoplatform.services.jcr.datamodel.NodeData parent,
                                                                        int fromOrderNum)

Get page of child nodes.

Parameters:

parent - the parent node data

fromOrderNum - the order number related to page of child nodes

Returns:

child nodes for parent if found; empty list if no items found; null if no items initialized

getChildNodes

List<org.exoplatform.services.jcr.datamodel.NodeData> getChildNodes(org.exoplatform.services.jcr.datamodel.NodeData parent,
                                                                  org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter pattern)

Get child nodes by pattern.

Parameters:

parent - the parent node data

pattern - the filter to use

Returns:

child nodes for parent if found; empty list if no items found; null if no items initialized

getChildNodesCount

int getChildNodesCount(org.exoplatform.services.jcr.datamodel.NodeData parent)

Get child nodes count.

Parameters:

parent - the parent node data

Returns:

child nodes count for parent if found; 0 if no items found; -1 if no items initialized

getChildProperties

List<org.exoplatform.services.jcr.datamodel.PropertyData> getChildProperties(org.exoplatform.services.jcr.datamodel.NodeData parent)

Get node child properties.

Parameters:

parent - the parent node data

Returns:

child properties for parent if found; empty list if no items found; null if no items initialized

getChildProperties

List<org.exoplatform.services.jcr.datamodel.PropertyData> getChildProperties(org.exoplatform.services.jcr.datamodel.NodeData parent,
                                                                           org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter pattern)

Get node child properties by pattern.

Parameters:

parent - the parent node data

pattern - the filter to use

Returns:

child properties for parent if found; empty list if no items found; null if no items initialized

listChildProperties

List<org.exoplatform.services.jcr.datamodel.PropertyData> listChildProperties(org.exoplatform.services.jcr.datamodel.NodeData parentData)

List node child properties.
A difference from getChildProperties(org.exoplatform.services.jcr.datamodel.NodeData) it's that the method may return list of node properties (PropertyData) which contains no data (ValueData).
Used for Node.hasProperties(), NodeIndexer.createDoc().

Parameters:

parentData - the parent node data

Returns:

child properties for parent if found; null if no items initialized

getReferencedProperties

List<org.exoplatform.services.jcr.datamodel.PropertyData> getReferencedProperties(String identifier)

Get referenced properties.

Parameters:

identifier - referenceable id

Returns:

list of REFERENCE properties

addReferencedProperties

void addReferencedProperties(String identifier,
                           List<org.exoplatform.services.jcr.datamodel.PropertyData> refProperties)

Add referenced properties.

Parameters:

identifier - referenceable id

refProperties - list of properties

put

void put(ItemData item)

Adds (or updates if found) ItemData.

Parameters:

item - the item data

addChildNodesCount

void addChildNodesCount(org.exoplatform.services.jcr.datamodel.NodeData parent,
                      int count)

Adds the total amount of children nodes.

Parameters:

parent - the parent node data

count - the total amount of nodes

addChildNodesByPage

void addChildNodesByPage(org.exoplatform.services.jcr.datamodel.NodeData parent,
                       List<org.exoplatform.services.jcr.datamodel.NodeData> childs,
                       int fromOrderNum)

Adds page of child nodes.

Parameters:

parent - the parent node data

childs - the list of child nodes

fromOrderNum - the order number related to page of child nodes

addChildNodes

void addChildNodes(org.exoplatform.services.jcr.datamodel.NodeData parent,
                 List<org.exoplatform.services.jcr.datamodel.NodeData> childNodes)

Adds (update should not be the case!) list of child nodes. The list can be empty. If list is null the operation is ignored.

Parameters:

parent - the parent node data

childNodes - the list of child nodes

addChildNodes

void addChildNodes(org.exoplatform.services.jcr.datamodel.NodeData parent,
                 org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter pattern,
                 List<org.exoplatform.services.jcr.datamodel.NodeData> childNodes)

Adds (update should not be the case!) list of child nodes. The list can be empty. If list is null the operation is ignored.

Parameters:

parent - the parent node data

pattern - the filter to use

childNodes - the list of children nodes

addChildProperties

void addChildProperties(org.exoplatform.services.jcr.datamodel.NodeData parent,
                      List<org.exoplatform.services.jcr.datamodel.PropertyData> childProperties)

Adds (update should not be the case!) list of child properties. The list can be empty. If list is null the operation is ignored.

Parameters:

parent - the parent node data

childProperties - the children properties

addChildProperties

void addChildProperties(org.exoplatform.services.jcr.datamodel.NodeData parent,
                      org.exoplatform.services.jcr.impl.core.itemfilters.QPathEntryFilter pattern,
                      List<org.exoplatform.services.jcr.datamodel.PropertyData> childProperties)

Adds (update should not be the case!) list of child properties. The list can be empty. If list is null the operation is ignored.

Parameters:

parent - the parent node data

pattern - the filter to use

childProperties - the children properties

addChildPropertiesList

void addChildPropertiesList(org.exoplatform.services.jcr.datamodel.NodeData parent,
                          List<org.exoplatform.services.jcr.datamodel.PropertyData> childProperties)

Adds (update should not be the case!) list of child properties with empty values. The list can be empty. If list is null the operation is ignored.

Parameters:

parent - the parent node data

childProperties - the list of child properties

remove

void remove(ItemData item)

Removes data and its children from cache.

Parameters:

item - the item data

remove

void remove(String identifier,
          ItemData item)

Removes an item from the cache if and only if the current item for the provided identifier is equals to the provided item.

Parameters:

item - the item data

identifier - the Item Data identifier

isEnabled

boolean isEnabled()

Returns:

enabled status flag, if true then cache is enabled

isPatternSupported

boolean isPatternSupported()

Returns:

isPatternSupported status flag, if true then cache can store pattern results

isChildNodesByPageSupported

boolean isChildNodesByPageSupported()

Returns:

isPatternSupported status flag, if true then cache can store child lists grouped by pages

getSize

long getSize()

Cache size.

Returns:

long value

beginTransaction

void beginTransaction()

Start buffering process.

commitTransaction

void commitTransaction()

Sort changes and commit data to the cache.

rollbackTransaction

void rollbackTransaction()

Forget about changes

addListener

void addListener(WorkspaceStorageCacheListener listener)
                 throws UnsupportedOperationException

Adds a new listener

Parameters:

listener - the listener to register

Throws:

UnsupportedOperationException - in case the listeners are not supported by the implementation

removeListener

void removeListener(WorkspaceStorageCacheListener listener)
                    throws UnsupportedOperationException

Removes a listener

Parameters:

listener - the listener to remove

Throws:

UnsupportedOperationException - in case the listeners are not supported by the implementation