DocLibNodeLocator (Alfresco Repository zap-7.87-postgres11 API)

java.lang.Object
- org.alfresco.repo.nodelocator.AbstractNodeLocator
- - org.alfresco.repo.site.DocLibNodeLocator

All Implemented Interfaces:

NodeLocator
```
public class DocLibNodeLocator
extends AbstractNodeLocator
```
This NodeLocator identifies the site in which the source node resides and returns the Document Library container for that site. If no site can be found or the site does not have a Document Library then the Company Home is returned.

Since:

4.0

Author:

Nick Smith

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String NAME

Constructor Summary

Constructors
Constructor Description

DocLibNodeLocator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getName()`
`org.alfresco.service.cmr.repository.NodeRef`	`getNode(org.alfresco.service.cmr.repository.NodeRef source, java.util.Map<java.lang.String,java.io.Serializable> params)`	Finds the site in which the source `NodeRef` resides and returns the Document Library container for that site.
`void`	`setRepositoryHelper(Repository repositoryHelper)`
`void`	`setSiteService(SiteService siteService)`

Methods inherited from class org.alfresco.repo.nodelocator.AbstractNodeLocator
getParameterDefinitions, 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
- Constructor Detail
  - DocLibNodeLocator
```
public DocLibNodeLocator()
```
- Method Detail
  - getNode
```
public org.alfresco.service.cmr.repository.NodeRef getNode(org.alfresco.service.cmr.repository.NodeRef source,
                                                           java.util.Map<java.lang.String,java.io.Serializable> params)
```
    Finds the site in which the source NodeRef resides and returns the Document Library container for that site. If no site can be found or the site does not have a Document Library then the Company Home is returned.
    
    Parameters:
    
    source - the starting point for locating the site Document Library.
    
    params - Not used.
    
    Returns:
    
    the Document Library or the Company Home.
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in class AbstractNodeLocator
  - setSiteService
```
public void setSiteService(SiteService siteService)
```
    Parameters:
    
    siteService - the siteService to set
  - setRepositoryHelper
```
public void setRepositoryHelper(Repository repositoryHelper)
```
    Parameters:
    
    repositoryHelper - the repositoryHelper to set