org.exoplatform.services.cms.link

Interface NodeFinder

public interface NodeFinder

Finds a node with a given path. If the node path contains sub-paths to exo:symlink nodes, the real link node will be found.

Level API:

Experimental

Method Summary

Methods

Modifier and Type	Method and Description
javax.jcr.Item	getItem(javax.jcr.Session session, String absPath) Gets an item at the specified absolute path.
javax.jcr.Item	getItem(javax.jcr.Session session, String absPath, boolean giveTarget) Gets an item at the specified absolute path.
javax.jcr.Item	getItem(String workspace, String absPath) Gets an item at the specified absolute path.
javax.jcr.Item	getItem(String workspace, String absPath, boolean giveTarget) Gets an item at the specified absolute path.
javax.jcr.Item	getItemGiveTargetSys(String workspace, String absPath, boolean giveTarget, boolean system) Gets an item at the specified absolute path.
javax.jcr.Item	getItemSys(String workspace, String absPath, boolean system) Gets an item at the specified absolute path.
javax.jcr.Item	getItemTarget(javax.jcr.Session session, String absPath, boolean giveTarget, boolean system) Gets an item at the specified absolute path.
javax.jcr.Node	getNode(javax.jcr.Node ancestorNode, String relativePath) Gets a node at the relative path related to the ancestor node.
javax.jcr.Node	getNode(javax.jcr.Node ancestorNode, String relativePath, boolean giveTarget) Gets a node at the relative path related to the ancestor node.
boolean	itemExists(javax.jcr.Session session, String absPath) Checks if an item exists at the specified absolute path.

Method Detail

getNode

javax.jcr.Node getNode(javax.jcr.Node ancestorNode,
                     String relativePath)
                       throws javax.jcr.PathNotFoundException,
                              javax.jcr.RepositoryException

Gets a node at the relative path related to the ancestor node.

Parameters:

ancestorNode - The ancestor node.

relativePath - The relative path.

Throws:

javax.jcr.PathNotFoundException - if no node exists at the specified path.

javax.jcr.RepositoryException - if another error occurs.

getNode

javax.jcr.Node getNode(javax.jcr.Node ancestorNode,
                     String relativePath,
                     boolean giveTarget)
                       throws javax.jcr.PathNotFoundException,
                              javax.jcr.RepositoryException

Gets a node at the relative path related to the ancestor node.

Parameters:

ancestorNode - The ancestor node.

relativePath - The relative path.

giveTarget - If the node is link and giveTarget has been set to "true", the target node will be returned.

Throws:

javax.jcr.PathNotFoundException - if no node exists at the specified path.

javax.jcr.RepositoryException - if another error occurs.

getItem

javax.jcr.Item getItem(String workspace,
                     String absPath)
                       throws javax.jcr.PathNotFoundException,
                              javax.jcr.RepositoryException

Gets an item at the specified absolute path.

Parameters:

workspace - The workspace name.

absPath - The absolute path.

Throws:

javax.jcr.PathNotFoundException - if the specified path cannot be found.

javax.jcr.RepositoryException - if another error occurs.

getItemSys

javax.jcr.Item getItemSys(String workspace,
                        String absPath,
                        boolean system)
                          throws javax.jcr.PathNotFoundException,
                                 javax.jcr.RepositoryException

Gets an item at the specified absolute path.

Parameters:

workspace - The workspace name.

absPath - The absolute path.

system - If "true", the system session is used. If "false", the user session is used.

Throws:

javax.jcr.PathNotFoundException - if the specified path cannot be found.

javax.jcr.RepositoryException - if another error occurs.

getItem

javax.jcr.Item getItem(String workspace,
                     String absPath,
                     boolean giveTarget)
                       throws javax.jcr.PathNotFoundException,
                              javax.jcr.RepositoryException

Gets an item at the specified absolute path.

Parameters:

workspace - The workspace name.

absPath - The absolute path.

giveTarget - If the item is link and giveTarget has been set to "true", the target node will be returned.

Throws:

javax.jcr.PathNotFoundException - if the specified path cannot be found.

javax.jcr.RepositoryException - if another error occurs.

getItemGiveTargetSys

javax.jcr.Item getItemGiveTargetSys(String workspace,
                                  String absPath,
                                  boolean giveTarget,
                                  boolean system)
                                    throws javax.jcr.PathNotFoundException,
                                           javax.jcr.RepositoryException

Gets an item at the specified absolute path.

Parameters:

workspace - The workspace name.

absPath - The absolute path.

giveTarget - If the item is link and giveTarget has been set to "true", the target node will be returned.

system - If "true", the system session is used. If "false", the user session is used.

Throws:

javax.jcr.PathNotFoundException - if the specified path cannot be found.

javax.jcr.RepositoryException - if another error occurs.

getItem

javax.jcr.Item getItem(javax.jcr.Session session,
                     String absPath)
                       throws javax.jcr.PathNotFoundException,
                              javax.jcr.RepositoryException

Gets an item at the specified absolute path.

Parameters:

session - The session that is used to get the item.

absPath - The absolute path.

Throws:

javax.jcr.PathNotFoundException - if the specified path cannot be found.

javax.jcr.RepositoryException - if another error occurs.

getItem

javax.jcr.Item getItem(javax.jcr.Session session,
                     String absPath,
                     boolean giveTarget)
                       throws javax.jcr.PathNotFoundException,
                              javax.jcr.RepositoryException

Gets an item at the specified absolute path.

Parameters:

session - The session is used to get the item.

absPath - The absolute path.

giveTarget - If the item is link and giveTarget has been set to "true", the target node will be returned.

Throws:

javax.jcr.PathNotFoundException - if the specified path cannot be found.

javax.jcr.RepositoryException - if another error occurs.

getItemTarget

javax.jcr.Item getItemTarget(javax.jcr.Session session,
                           String absPath,
                           boolean giveTarget,
                           boolean system)
                             throws javax.jcr.PathNotFoundException,
                                    javax.jcr.RepositoryException

Gets an item at the specified absolute path.

Parameters:

session - The session which is used to get the item.

absPath - The absolute path.

giveTarget - If the item is link and giveTarget has been set to "true", the target node will be returned.

system - If "true", the system session is used. If "false", the user session is used.

Throws:

javax.jcr.PathNotFoundException - if the specified path cannot be found.

javax.jcr.RepositoryException - if another error occurs.

itemExists

boolean itemExists(javax.jcr.Session session,
                 String absPath)
                   throws javax.jcr.RepositoryException

Checks if an item exists at the specified absolute path.

Parameters:

session - The session that is used to get the item.

absPath - The absolute path.

Returns:

"True" if the item exists at the absolute path. "False" if the item does not exist or the specified absolute path is malformed.

Throws:

javax.jcr.RepositoryException - if an error occurs.