HierarchyNode (eXo Outlook :: Extension Services 1.0.0 API)

java.lang.Object
- org.exoplatform.outlook.jcr.HierarchyNode

Direct Known Subclasses:

File, Folder
```
public abstract class HierarchyNode
extends Object
```
JCR folder warapper for UI. Created by The eXo Platform SAS

Version:

$Id: HierarchyNode.java 00000 Jun 14, 2016 pnedonosko $

Author:

Peter Nedonosko

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`EMPTY` The Constant EMPTY.
`protected String`	`fullPath` The full path.
`protected int`	`hashCode` The hash code.
`protected Calendar`	`lastModified` The last modified.
`protected String`	`lastModifier` The last modifier.
`protected static org.exoplatform.services.log.Log`	`LOG` The Constant LOG.
`static String`	`MODIFIED_FORMAT` The Constant MODIFIED_FORMAT.
`protected String`	`name` The name.
`protected javax.jcr.Node`	`node` The node.
`protected String`	`parentPath` The parent path.
`protected String`	`path` The path.
`static String`	`PATH_SEPARATOR` The Constant PATH_SEPARATOR.
`protected String`	`pathLabel` The path label.
`static String`	`ROOT_PATH_LABEL` The Constant ROOT_PATH_LABEL.
`protected String`	`title` The title.
`protected String`	`url` The url.
`protected String`	`webdavUrl` The webdav url.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`HierarchyNode(Folder parent, javax.jcr.Node node)` Instantiates a new hierarchy node.
`protected`	`HierarchyNode(String parentPath, javax.jcr.Node node)` New hierarchy node instance.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static String`	`fullPath(String workspace, String path)` Full path.
`String`	`getFullPath()` Gets the full path.
`String`	`getLastModified()` Gets the last modified.
`String`	`getLastModifier()` Gets the last modifier.
`String`	`getName()` Gets the name.
`javax.jcr.Node`	`getNode()` Gets the node.
`String`	`getPath()` Gets the path.
`static String`	`getPath(String fullPath)` Gets the path.
`String`	`getPathLabel()` Gets the path label.
`String`	`getTitle()` Gets the title.
`String`	`getUrl()` Gets the url.
`String`	`getWebdavUrl()` Gets the webdav url.
`static String`	`getWorkspace(String fullPath)` Gets the workspace.
`int`	`hashCode()`
`static boolean`	`isFile(javax.jcr.Node node)` Checks if is file.
`abstract boolean`	`isFolder()` Checks if is folder.
`static boolean`	`isFolder(javax.jcr.Node node)` Checks if is folder.
`protected static String`	`nodeTitle(javax.jcr.Node node)` Node title.
`protected static String`	`pathLabel(String rootPath, javax.jcr.Node node)` Path label.
`void`	`setUrl(String url)` Sets the url.
`void`	`setWebdavUrl(String webdavUrl)` Sets the webdav url.
`protected abstract Locale`	`userLocale()` User locale.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MODIFIED_FORMAT
```
public static final String MODIFIED_FORMAT
```
    The Constant MODIFIED_FORMAT.
    
    See Also:
    
    Constant Field Values
  - PATH_SEPARATOR
```
public static final String PATH_SEPARATOR
```
    The Constant PATH_SEPARATOR.
  - ROOT_PATH_LABEL
```
public static final String ROOT_PATH_LABEL
```
    The Constant ROOT_PATH_LABEL.
  - EMPTY
```
protected static final String EMPTY
```
    The Constant EMPTY.
  - LOG
```
protected static final org.exoplatform.services.log.Log LOG
```
    The Constant LOG.
  - parentPath
```
protected final String parentPath
```
    The parent path.
  - path
```
protected final String path
```
    The path.
  - name
```
protected final String name
```
    The name.
  - fullPath
```
protected final String fullPath
```
    The full path.
  - title
```
protected final String title
```
    The title.
  - pathLabel
```
protected String pathLabel
```
    The path label.
  - lastModifier
```
protected final String lastModifier
```
    The last modifier.
  - lastModified
```
protected final Calendar lastModified
```
    The last modified.
  - node
```
protected final javax.jcr.Node node
```
    The node.
  - hashCode
```
protected final int hashCode
```
    The hash code.
  - url
```
protected String url
```
    The url.
  - webdavUrl
```
protected String webdavUrl
```
    The webdav url.
- Constructor Detail
  - HierarchyNode
```
protected HierarchyNode(String parentPath,
                        javax.jcr.Node node)
                 throws javax.jcr.RepositoryException,
                        BadParameterException
```
    New hierarchy node instance.
    
    Parameters:
    
    parentPath - String
    
    node - Node
    
    Throws:
    
    javax.jcr.RepositoryException - storage error
    
    BadParameterException - when parent path is null
  - HierarchyNode
```
protected HierarchyNode(Folder parent,
                        javax.jcr.Node node)
                 throws javax.jcr.RepositoryException,
                        OutlookException
```
    Instantiates a new hierarchy node.
    
    Parameters:
    
    parent - the parent
    
    node - the node
    
    Throws:
    
    javax.jcr.RepositoryException - the repository exception
    
    OutlookException - the outlook exception
- Method Detail
  - isFolder
```
public static boolean isFolder(javax.jcr.Node node)
                        throws javax.jcr.RepositoryException
```
    Checks if is folder.
    
    Parameters:
    
    node - the node
    
    Returns:
    
    true, if is folder
    
    Throws:
    
    javax.jcr.RepositoryException - the repository exception
  - isFile
```
public static boolean isFile(javax.jcr.Node node)
                      throws javax.jcr.RepositoryException
```
    Checks if is file.
    
    Parameters:
    
    node - the node
    
    Returns:
    
    true, if is file
    
    Throws:
    
    javax.jcr.RepositoryException - the repository exception
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getUrl
```
public String getUrl()
```
    Gets the url.
    
    Returns:
    
    the url
  - setUrl
```
public void setUrl(String url)
```
    Sets the url.
    
    Parameters:
    
    url - the url to set
  - getWebdavUrl
```
public String getWebdavUrl()
```
    Gets the webdav url.
    
    Returns:
    
    the webdavUrl
  - setWebdavUrl
```
public void setWebdavUrl(String webdavUrl)
```
    Sets the webdav url.
    
    Parameters:
    
    webdavUrl - the webdavUrl to set
  - getNode
```
public javax.jcr.Node getNode()
```
    Gets the node.
    
    Returns:
    
    the node
  - getFullPath
```
public String getFullPath()
```
    Gets the full path.
    
    Returns:
    
    the full path
  - getPath
```
public String getPath()
```
    Gets the path.
    
    Returns:
    
    the path
  - getName
```
public String getName()
```
    Gets the name.
    
    Returns:
    
    the name
  - getTitle
```
public String getTitle()
```
    Gets the title.
    
    Returns:
    
    the name
  - getPathLabel
```
public String getPathLabel()
```
    Gets the path label.
    
    Returns:
    
    the pathLabel
  - getLastModifier
```
public String getLastModifier()
```
    Gets the last modifier.
    
    Returns:
    
    the lastModifier
  - getLastModified
```
public String getLastModified()
```
    Gets the last modified.
    
    Returns:
    
    the lastModified
  - nodeTitle
```
protected static String nodeTitle(javax.jcr.Node node)
                           throws javax.jcr.RepositoryException
```
    Node title.
    
    Parameters:
    
    node - the node
    
    Returns:
    
    the string
    
    Throws:
    
    javax.jcr.RepositoryException - the repository exception
  - pathLabel
```
protected static String pathLabel(String rootPath,
                                  javax.jcr.Node node)
                           throws javax.jcr.RepositoryException
```
    Path label.
    
    Parameters:
    
    rootPath - the root path
    
    node - the node
    
    Returns:
    
    the string
    
    Throws:
    
    javax.jcr.RepositoryException - the repository exception
  - fullPath
```
public static String fullPath(String workspace,
                              String path)
```
    Full path.
    
    Parameters:
    
    workspace - the workspace
    
    path - the path
    
    Returns:
    
    the string
  - getPath
```
public static String getPath(String fullPath)
                      throws BadParameterException
```
    Gets the path.
    
    Parameters:
    
    fullPath - the full path
    
    Returns:
    
    the path
    
    Throws:
    
    BadParameterException - the bad parameter exception
  - getWorkspace
```
public static String getWorkspace(String fullPath)
                           throws BadParameterException
```
    Gets the workspace.
    
    Parameters:
    
    fullPath - the full path
    
    Returns:
    
    the workspace
    
    Throws:
    
    BadParameterException - the bad parameter exception
  - isFolder
```
public abstract boolean isFolder()
```
    Checks if is folder.
    
    Returns:
    
    true, if is folder
  - userLocale
```
protected abstract Locale userLocale()
```
    User locale.
    
    Returns:
    
    the locale

Class HierarchyNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODIFIED_FORMAT

PATH_SEPARATOR

ROOT_PATH_LABEL

EMPTY

LOG

parentPath

path

name

fullPath

title

pathLabel

lastModifier

lastModified

node

hashCode

url

webdavUrl

Constructor Detail

HierarchyNode

HierarchyNode

Method Detail

isFolder

isFile

hashCode

equals

getUrl

setUrl

getWebdavUrl

setWebdavUrl

getNode

getFullPath

getPath

getName

getTitle

getPathLabel

getLastModifier

getLastModified

nodeTitle

pathLabel

fullPath

getPath

getWorkspace

isFolder

userLocale