org.alfresco.repo.node.db
Interface NodeDaoService

All Known Implementing Classes:

HibernateNodeDaoServiceImpl

public interface NodeDaoService

Service layer accessing persistent node entities directly

Nested Class Summary

static interface	NodeDaoService.ChildAssocRefQueryCallback Interface used to iterate over results from child association queries
static interface	NodeDaoService.NodePropertyHandler Iterface to handle callbacks when iterating over properties
static interface	NodeDaoService.NodeRefQueryCallback Interface used to iterate over pure node results

Method Summary

void	addNodeAspects(java.lang.Long nodeId, java.util.Set aspectQNames)
void	addNodeProperties(java.lang.Long nodeId, java.util.Map properties)
void	addNodeProperty(java.lang.Long nodeId, QName qname, java.io.Serializable value)
org.alfresco.util.Pair	createStore(StoreRef storeRef) Creates a unique store for the given protocol and identifier combination.
void	deleteChildAssoc(java.lang.Long childAssocId)
boolean	deleteChildAssoc(java.lang.Long parentNodeId, java.lang.Long childNodeId, QName assocTypeQName, QName qname) Deletes an explicit child association.
void	deleteNode(java.lang.Long nodeId) Deletes the node and all entities
void	deleteNodeAssoc(java.lang.Long assocId)
void	flush() Flush the data changes to the persistence layer.
org.alfresco.util.Pair	getChildAssoc(java.lang.Long parentNodeId, java.lang.Long childNodeId, QName assocTypeQName, QName qname)
org.alfresco.util.Pair	getChildAssoc(java.lang.Long parentNodeId, QName assocTypeQName, java.lang.String childName)
void	getChildAssocs(java.lang.Long parentNodeId, NodeDaoService.ChildAssocRefQueryCallback resultsCallback, boolean recurse) Get a collection of all child association references for a given parent node.
void	getChildAssocs(java.lang.Long parentNodeId, QName assocQName, NodeDaoService.ChildAssocRefQueryCallback resultsCallback) Get a collection of all child association references for a given parent node.
void	getChildAssocsByChildTypes(java.lang.Long parentNodeId, java.util.Set childNodeTypeQNames, NodeDaoService.ChildAssocRefQueryCallback resultsCallback)
void	getChildAssocsByTypeQNameAndQName(java.lang.Long parentNodeId, QName assocTypeQName, QName assocQName, NodeDaoService.ChildAssocRefQueryCallback resultsCallback)
void	getChildAssocsByTypeQNames(java.lang.Long parentNodeId, java.util.List assocTypeQNames, NodeDaoService.ChildAssocRefQueryCallback resultsCallback)
java.lang.Long	getNodeAccessControlList(java.lang.Long nodeId)
java.util.Set	getNodeAspects(java.lang.Long nodeId)
org.alfresco.util.Pair	getNodeAssoc(java.lang.Long sourceNodeId, java.lang.Long targetNodeId, QName assocTypeQName)
java.util.Collection	getNodeAssocsToAndFrom(java.lang.Long nodeId)
org.alfresco.util.Pair	getNodePair(java.lang.Long nodeId)
org.alfresco.util.Pair	getNodePair(NodeRef nodeRef)
java.util.Map	getNodeProperties(java.lang.Long nodeId)
java.io.Serializable	getNodeProperty(java.lang.Long nodeId, QName propertyQName)
NodeRef.Status	getNodeRefStatus(NodeRef nodeRef)
void	getNodesWithAspect(QName aspectQName, java.lang.Long minNodeId, int count, NodeDaoService.NodeRefQueryCallback resultsCallback)
void	getNodesWithChildrenInDifferentStores(java.lang.Long minNodeId, int count, NodeDaoService.NodeRefQueryCallback resultsCallback)
QName	getNodeType(java.lang.Long nodeId)
java.util.Collection	getParentAssocs(java.lang.Long childNodeId) Get all parent associations for the node.
void	getPrimaryChildAssocs(java.lang.Long parentNodeId, NodeDaoService.ChildAssocRefQueryCallback resultsCallback)
void	getPrimaryChildAssocsNotInSameStore(java.lang.Long parentNodeId, NodeDaoService.ChildAssocRefQueryCallback resultsCallback)
org.alfresco.util.Pair	getPrimaryParentAssoc(java.lang.Long childNodeId) Finds the association between the node's primary parent and the node itself
void	getPropertyValuesByActualType(DataTypeDefinition actualDataTypeDefinition, NodeDaoService.NodePropertyHandler handler) Iterate over all property values for the given type definition.
void	getPropertyValuesByPropertyAndValue(StoreRef storeRef, QName propertyQName, java.lang.String value, NodeDaoService.NodePropertyHandler handler) Iterate over all nodes that have a given property type with a given string value.
org.alfresco.util.Pair	getRootNode(StoreRef storeRef)
java.util.Collection	getSourceNodeAssocs(java.lang.Long targetNodeId)
java.util.List	getStoreRefs() Fetch a list of all stores in the repository
java.util.Collection	getTargetNodeAssocs(java.lang.Long sourceNodeId)
int	getTransactionCount()
Transaction	getTxnById(long txnId)
java.util.List	getTxnChanges(long txnId)
java.util.List	getTxnChangesForStore(StoreRef storeRef, long txnId)
int	getTxnDeleteCount(long txnId)
java.util.List	getTxnsByCommitTimeAscending(long fromTimeInclusive, long toTimeExclusive, int count, java.util.List excludeTxnIds, boolean remoteOnly) Get all transactions in a given time range.
java.util.List	getTxnsByCommitTimeDescending(long fromTimeInclusive, long toTimeExclusive, int count, java.util.List excludeTxnIds, boolean remoteOnly) Get all transactions in a given time range.
java.util.List	getTxnsByMinCommitTime(java.util.List includeTxnIds) Get the lowest commit time for a set of transactions
int	getTxnUpdateCount(long txnId)
boolean	hasNodeAspect(java.lang.Long nodeId, QName aspectQName)
boolean	isDirty() Are there any pending changes which must be synchronized with the store?
org.alfresco.util.Pair	moveNodeToStore(java.lang.Long nodeId, StoreRef storeRef)
org.alfresco.util.Pair	newChildAssoc(java.lang.Long parentNodeId, java.lang.Long childNodeId, boolean isPrimary, QName assocTypeQName, QName qname)
org.alfresco.util.Pair	newNode(StoreRef storeRef, java.lang.String uuid, QName nodeTypeQName)
org.alfresco.util.Pair	newNodeAssoc(java.lang.Long sourceNodeId, java.lang.Long targetNodeId, QName assocTypeQName)
void	removeNodeAspects(java.lang.Long nodeId, java.util.Set aspectQNames)
void	removeNodeProperties(java.lang.Long nodeId, java.util.Set propertyQNames)
void	setChildNameUnique(java.lang.Long assocId, java.lang.String childName) Change the name of the child node.
void	setNodeAccessControlList(java.lang.Long nodeId, java.lang.Long aclId)
void	setNodeProperties(java.lang.Long nodeId, java.util.Map properties)
void	setNodeStatus(java.lang.Long nodeId)
org.alfresco.util.Pair	updateChildAssoc(java.lang.Long childAssocId, java.lang.Long parentNodeId, java.lang.Long childNodeId, QName assocTypeQName, QName qname, int index)
void	updateNode(java.lang.Long nodeId, StoreRef storeRef, java.lang.String uuid, QName nodeTypeQName)

Method Detail

isDirty

boolean isDirty()

Are there any pending changes which must be synchronized with the store?

Returns:

true => changes are pending

flush

void flush()

Flush the data changes to the persistence layer.

getStoreRefs

java.util.List getStoreRefs()

Fetch a list of all stores in the repository

Returns:

Returns a list of stores

getRootNode

org.alfresco.util.Pair getRootNode(StoreRef storeRef)

createStore

org.alfresco.util.Pair createStore(StoreRef storeRef)

Creates a unique store for the given protocol and identifier combination. The root node is created with the "root" aspect.

Returns:

Returns the root node, which is added automatically.

Throws:

StoreExistsException - if the store already exists

getNodeRefStatus

NodeRef.Status getNodeRefStatus(NodeRef nodeRef)

newNode

org.alfresco.util.Pair newNode(StoreRef storeRef,
                               java.lang.String uuid,
                               QName nodeTypeQName)
                               throws InvalidTypeException

Parameters:

storeRef - the store to which the node must belong

uuid - the node store-unique identifier

nodeTypeQName - the type of the node

Returns:

Returns a new node Id of the given type and attached to the store

Throws:

InvalidTypeException - if the node type is invalid or if the node type is not a valid real node

moveNodeToStore

org.alfresco.util.Pair moveNodeToStore(java.lang.Long nodeId,
                                       StoreRef storeRef)

getNodePair

org.alfresco.util.Pair getNodePair(NodeRef nodeRef)

Parameters:

nodeRef - the node reference

Returns:

Returns the node entity ID

getNodePair

org.alfresco.util.Pair getNodePair(java.lang.Long nodeId)

getNodeType

QName getNodeType(java.lang.Long nodeId)

setNodeStatus

void setNodeStatus(java.lang.Long nodeId)

getNodeAccessControlList

java.lang.Long getNodeAccessControlList(java.lang.Long nodeId)

setNodeAccessControlList

void setNodeAccessControlList(java.lang.Long nodeId,
                              java.lang.Long aclId)

updateNode

void updateNode(java.lang.Long nodeId,
                StoreRef storeRef,
                java.lang.String uuid,
                QName nodeTypeQName)

Parameters:

storeRef - the new store or null to keep the existing one

uuid - the new UUID for the node or null to keep it the same

nodeTypeQName - the new type QName for the node or null to keep the existing one

getNodeProperty

java.io.Serializable getNodeProperty(java.lang.Long nodeId,
                                     QName propertyQName)

getNodeProperties

java.util.Map getNodeProperties(java.lang.Long nodeId)

addNodeProperty

void addNodeProperty(java.lang.Long nodeId,
                     QName qname,
                     java.io.Serializable value)

addNodeProperties

void addNodeProperties(java.lang.Long nodeId,
                       java.util.Map properties)

removeNodeProperties

void removeNodeProperties(java.lang.Long nodeId,
                          java.util.Set propertyQNames)

setNodeProperties

void setNodeProperties(java.lang.Long nodeId,
                       java.util.Map properties)

getNodeAspects

java.util.Set getNodeAspects(java.lang.Long nodeId)

addNodeAspects

void addNodeAspects(java.lang.Long nodeId,
                    java.util.Set aspectQNames)

removeNodeAspects

void removeNodeAspects(java.lang.Long nodeId,
                       java.util.Set aspectQNames)

hasNodeAspect

boolean hasNodeAspect(java.lang.Long nodeId,
                      QName aspectQName)

deleteNode

void deleteNode(java.lang.Long nodeId)

Deletes the node and all entities

newChildAssoc

org.alfresco.util.Pair newChildAssoc(java.lang.Long parentNodeId,
                                     java.lang.Long childNodeId,
                                     boolean isPrimary,
                                     QName assocTypeQName,
                                     QName qname)

Returns:

Returns the persisted and filled association's ID

See Also:

ChildAssoc

setChildNameUnique

void setChildNameUnique(java.lang.Long assocId,
                        java.lang.String childName)

Change the name of the child node.

Parameters:

childId - the child association to change

childName - the name to put on the association

updateChildAssoc

org.alfresco.util.Pair updateChildAssoc(java.lang.Long childAssocId,
                                        java.lang.Long parentNodeId,
                                        java.lang.Long childNodeId,
                                        QName assocTypeQName,
                                        QName qname,
                                        int index)

Parameters:

index - the association index. -1 to keep the existing value

getChildAssocs

void getChildAssocs(java.lang.Long parentNodeId,
                    NodeDaoService.ChildAssocRefQueryCallback resultsCallback,
                    boolean recurse)

Get a collection of all child association references for a given parent node.

WARNING: Be sure selective when doing this call recursively.

Parameters:

parentNodeId - the parent node

resultsCallback - the callback that will be called with the results

recurse - if true then iterate over the entire tree of nodes. Resursion is done top-down i.e. the first level children are all enumerated first, followed by all second level children and so on.

getChildAssocs

void getChildAssocs(java.lang.Long parentNodeId,
                    QName assocQName,
                    NodeDaoService.ChildAssocRefQueryCallback resultsCallback)

Get a collection of all child association references for a given parent node.

Parameters:

parentNodeId - the parent node

resultsCallback - the callback that will be called with the results

getChildAssocsByTypeQNames

void getChildAssocsByTypeQNames(java.lang.Long parentNodeId,
                                java.util.List assocTypeQNames,
                                NodeDaoService.ChildAssocRefQueryCallback resultsCallback)

getChildAssocsByTypeQNameAndQName

void getChildAssocsByTypeQNameAndQName(java.lang.Long parentNodeId,
                                       QName assocTypeQName,
                                       QName assocQName,
                                       NodeDaoService.ChildAssocRefQueryCallback resultsCallback)

getChildAssocsByChildTypes

void getChildAssocsByChildTypes(java.lang.Long parentNodeId,
                                java.util.Set childNodeTypeQNames,
                                NodeDaoService.ChildAssocRefQueryCallback resultsCallback)

getPrimaryChildAssocs

void getPrimaryChildAssocs(java.lang.Long parentNodeId,
                           NodeDaoService.ChildAssocRefQueryCallback resultsCallback)

getPrimaryChildAssocsNotInSameStore

void getPrimaryChildAssocsNotInSameStore(java.lang.Long parentNodeId,
                                         NodeDaoService.ChildAssocRefQueryCallback resultsCallback)

getNodesWithChildrenInDifferentStores

void getNodesWithChildrenInDifferentStores(java.lang.Long minNodeId,
                                           int count,
                                           NodeDaoService.NodeRefQueryCallback resultsCallback)

getNodesWithAspect

void getNodesWithAspect(QName aspectQName,
                        java.lang.Long minNodeId,
                        int count,
                        NodeDaoService.NodeRefQueryCallback resultsCallback)

getChildAssoc

org.alfresco.util.Pair getChildAssoc(java.lang.Long parentNodeId,
                                     QName assocTypeQName,
                                     java.lang.String childName)

Returns:

Returns an association matching the given parent, type and child name - or null if not found

getChildAssoc

org.alfresco.util.Pair getChildAssoc(java.lang.Long parentNodeId,
                                     java.lang.Long childNodeId,
                                     QName assocTypeQName,
                                     QName qname)

Returns:

Returns a matching association or null if one was not found

See Also:

ChildAssoc

deleteChildAssoc

boolean deleteChildAssoc(java.lang.Long parentNodeId,
                         java.lang.Long childNodeId,
                         QName assocTypeQName,
                         QName qname)

Deletes an explicit child association.

Returns:

Returns true if the association was deleted, otherwise false

deleteChildAssoc

void deleteChildAssoc(java.lang.Long childAssocId)

Parameters:

assoc - the child association to remove

getPrimaryParentAssoc

org.alfresco.util.Pair getPrimaryParentAssoc(java.lang.Long childNodeId)

Finds the association between the node's primary parent and the node itself

getParentAssocs

java.util.Collection getParentAssocs(java.lang.Long childNodeId)

Get all parent associations for the node. This methods includes a cache safety check.

Parameters:

childNode - the child node

Returns:

Returns all parent associations for the node.

newNodeAssoc

org.alfresco.util.Pair newNodeAssoc(java.lang.Long sourceNodeId,
                                    java.lang.Long targetNodeId,
                                    QName assocTypeQName)

Returns:

Returns the persisted and filled association

See Also:

NodeAssoc

getNodeAssocsToAndFrom

java.util.Collection getNodeAssocsToAndFrom(java.lang.Long nodeId)

Returns:

Returns a list of all node associations associated with the given node

getNodeAssoc

org.alfresco.util.Pair getNodeAssoc(java.lang.Long sourceNodeId,
                                    java.lang.Long targetNodeId,
                                    QName assocTypeQName)

Returns:

Returns the node association or null if not found

getTargetNodeAssocs

java.util.Collection getTargetNodeAssocs(java.lang.Long sourceNodeId)

Returns:

Returns all the node associations where the node is the source

getSourceNodeAssocs

java.util.Collection getSourceNodeAssocs(java.lang.Long targetNodeId)

Returns:

Returns all the node associations where the node is the target

deleteNodeAssoc

void deleteNodeAssoc(java.lang.Long assocId)

Parameters:

assoc - the node association to remove

getPropertyValuesByPropertyAndValue

void getPropertyValuesByPropertyAndValue(StoreRef storeRef,
                                         QName propertyQName,
                                         java.lang.String value,
                                         NodeDaoService.NodePropertyHandler handler)

Iterate over all nodes that have a given property type with a given string value.

Parameters:

storeRef - the store to search in

propertyQName - the qualified name of the property

value - the string value to match

handler - the callback to use while iterating over the URLs

getPropertyValuesByActualType

void getPropertyValuesByActualType(DataTypeDefinition actualDataTypeDefinition,
                                   NodeDaoService.NodePropertyHandler handler)

Iterate over all property values for the given type definition. This will also dig out values that were persisted as type d:any.

Parameters:

actualDataTypeDefinition - the persisted type to retrieve

handler - the callback to use while iterating over the URLs

getTxnById

Transaction getTxnById(long txnId)

getTxnsByCommitTimeAscending

java.util.List getTxnsByCommitTimeAscending(long fromTimeInclusive,
                                            long toTimeExclusive,
                                            int count,
                                            java.util.List excludeTxnIds,
                                            boolean remoteOnly)

Get all transactions in a given time range. Since time-based retrieval doesn't guarantee uniqueness for any given millisecond, a list of optional exclusions may be provided.

Parameters:

excludeTxnIds - a list of txn IDs to ignore. null is allowed.

remoteOnly - true if locally-written transactions must be ignored

getTxnsByCommitTimeDescending

java.util.List getTxnsByCommitTimeDescending(long fromTimeInclusive,
                                             long toTimeExclusive,
                                             int count,
                                             java.util.List excludeTxnIds,
                                             boolean remoteOnly)

Get all transactions in a given time range. Since time-based retrieval doesn't guarantee uniqueness for any given millisecond, a list of optional exclusions may be provided.

Parameters:

excludeTxnIds - a list of txn IDs to ignore. null is allowed.

remoteOnly - true if locally-written transactions must be ignored

getTxnsByMinCommitTime

java.util.List getTxnsByMinCommitTime(java.util.List includeTxnIds)

Get the lowest commit time for a set of transactions

Parameters:

includeTxnIds - a list of transaction IDs to search for

Returns:

Returns the transactions by commit time for the given IDs

getTxnUpdateCount

int getTxnUpdateCount(long txnId)

getTxnDeleteCount

int getTxnDeleteCount(long txnId)

getTransactionCount

int getTransactionCount()

getTxnChangesForStore

java.util.List getTxnChangesForStore(StoreRef storeRef,
                                     long txnId)

getTxnChanges

java.util.List getTxnChanges(long txnId)