Package org.alfresco.repo.nodelocator

Class AncestorNodeLocator

java.lang.Object

org.alfresco.repo.nodelocator.AbstractNodeLocator

org.alfresco.repo.nodelocator.AncestorNodeLocator

All Implemented Interfaces:

NodeLocator

public class AncestorNodeLocator
extends AbstractNodeLocator

This NodeLocator identifies an ancestor of the source node.

The node returned can be of a specific type and/or have a specific aspect applied.

If no parameters are passed the immediate primary parent is returned.

Since:

4.0

Author:

Nick Smith

Field Summary

Fields

Modifier and Type	Field	Description
static String	ASPECT_KEY
static String	NAME
static String	TYPE_KEY

Constructor Summary

Constructors

Constructor	Description
AncestorNodeLocator()

Method Summary

Modifier and Type	Method	Description
String	getName()
NodeRef	getNode(NodeRef source, Map<String,Serializable> params)	Finds a NodeRef given a starting NodeRef and a Map of parameters.
List<ParameterDefinition>	getParameterDefinitions()	A list containing the parmameter defintions for this NodeLocator.
void	setNamespaceService(NamespaceService namespaceService)
void	setNodeService(NodeService nodeService)

Methods inherited from class org.alfresco.repo.nodelocator.AbstractNodeLocator

setNodeLocatorService

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

TYPE_KEY

public static final String TYPE_KEY

See Also:

Constant Field Values

ASPECT_KEY

public static final String ASPECT_KEY

See Also:

Constant Field Values

Constructor Detail

AncestorNodeLocator

public AncestorNodeLocator()

Method Detail

getNode

public NodeRef getNode(NodeRef source,
                       Map<String,Serializable> params)

Finds a NodeRef given a starting NodeRef and a Map of parameters. Returns null if the specified node could not be found.

Parameters:

source - the starting point for locating a new node. The source node. Can be null.

params - an arbitrary Map of parameters.Can be null.

Returns:

the node to be found or null.

getParameterDefinitions

public List<ParameterDefinition> getParameterDefinitions()

A list containing the parmameter defintions for this NodeLocator.

Specified by:

getParameterDefinitions in interface NodeLocator

Overrides:

getParameterDefinitions in class AbstractNodeLocator

Returns:

a list of parameter definitions

getName

public String getName()

Specified by:

getName in class AbstractNodeLocator

setNodeService

public void setNodeService(NodeService nodeService)

Parameters:

nodeService - the nodeService to set

setNamespaceService

public void setNamespaceService(NamespaceService namespaceService)

Parameters:

namespaceService - the namespaceService to set