org.alfresco.repo.nodelocator
Class XPathNodeLocator

java.lang.Object
  extended by org.alfresco.repo.nodelocator.AbstractNodeLocator
      extended by org.alfresco.repo.nodelocator.XPathNodeLocator
All Implemented Interfaces:
NodeLocator

public class XPathNodeLocator
extends AbstractNodeLocator

This NodeLocator identifies a node from an XPath provided via the xpath parameter.

Since:
4.0

Field Summary
static java.lang.String NAME
           
static java.lang.String QUERY_KEY
           
static java.lang.String STORE_ID_KEY
           
static java.lang.String STORE_TYPE_KEY
           
 
Constructor Summary
XPathNodeLocator()
           
 
Method Summary
 java.lang.String getName()
          
 org.alfresco.service.cmr.repository.NodeRef getNode(org.alfresco.service.cmr.repository.NodeRef source, java.util.Map params)
          Finds a NodeRef given a starting NodeRef and a Map of parameters.
 java.util.List getParameterDefinitions()
          A list containing the parmameter defintions for this NodeLocator.
 void setDefaultStore(java.lang.String defaultStoreStr)
           
 void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
           
 
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 java.lang.String NAME
See Also:
Constant Field Values

QUERY_KEY

public static final java.lang.String QUERY_KEY
See Also:
Constant Field Values

STORE_TYPE_KEY

public static final java.lang.String STORE_TYPE_KEY
See Also:
Constant Field Values

STORE_ID_KEY

public static final java.lang.String STORE_ID_KEY
See Also:
Constant Field Values
Constructor Detail

XPathNodeLocator

public XPathNodeLocator()
Method Detail

getNode

public org.alfresco.service.cmr.repository.NodeRef getNode(org.alfresco.service.cmr.repository.NodeRef source,
                                                           java.util.Map params)
Finds a NodeRef given a starting NodeRef and a Map of parameters. Returns null if the specified node could not be found.

params - an arbitrary Map of parameters.Can be null.
Returns:
the node to be found or null.

getParameterDefinitions

public java.util.List 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 java.lang.String getName()

Specified by:
getName in class AbstractNodeLocator

setSearchService

public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
Parameters:
searchService - the searchService to set

setDefaultStore

public void setDefaultStore(java.lang.String defaultStoreStr)
Parameters:
defaultStore - the defaultStore to set


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.