Package org.hippoecm.frontend.util

Class DocumentReferenceUtils

java.lang.Object

org.hippoecm.frontend.util.DocumentReferenceUtils

public class DocumentReferenceUtils
extends Object

Utility class for document reference related operations.

Method Summary

Modifier and Type	Method	Description
static Set<String>	getComponentVariants(ComponentReference reference, String locale)	Returns the set of variants for the given ComponentReference.
static List<Node>	getReferencingXPageComponents(Node handle, String channelRootPath, boolean preview)	Returns the list of xpage component nodes by the given document handle and HstSite.
static List<Node>	getReferencingXPageComponents(Node handle, String channelRootPath, boolean preview, String projectId)	Returns the list of xpage component nodes by the given document handle and HstSite.
static List<Node>	getReferredDocuments(Node variant)	Returns the list of 1st level referred documents by the given document variant.
static List<Node>	getReferredDocuments(Node variant, ReferenceSearchFilter searchFilter)	Returns the list of 1st level referred documents by the given document variant.
static List<Node>	getReferringDocuments(Node handle, ReferenceSearchFilter searchFilter)	Returns the list of 1st level referring documents by the given document handle.
static List<SiteReference>	getSiteReferences(Node handle, String hostGroup, boolean preview)	Returns the list of SiteReferences for the given document handle.
static List<SiteReference>	getSiteReferences(Node handle, String hostGroup, boolean preview, String projectId)	Returns the list of SiteReferences for the given document handle.

Methods inherited from class java.lang.Object

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

Method Details

getReferencingXPageComponents

public static List<Node> getReferencingXPageComponents(Node handle,
 String channelRootPath,
 boolean preview)
                                                throws RepositoryException

Returns the list of xpage component nodes by the given document handle and HstSite.

Parameters:

handle - document handle

channelRootPath - the path of the channel root

preview - whether to find preview components

Returns:

list of xpage component nodes

Throws:

RepositoryException

getReferencingXPageComponents

public static List<Node> getReferencingXPageComponents(Node handle,
 String channelRootPath,
 boolean preview,
 String projectId)
                                                throws RepositoryException

Returns the list of xpage component nodes by the given document handle and HstSite.

Parameters:

handle - document handle

channelRootPath - the path of the channel root

preview - whether to find preview components

projectId - id of the project

Returns:

list of xpage component nodes

Throws:

RepositoryException

getReferringDocuments

public static List<Node> getReferringDocuments(Node handle,
 ReferenceSearchFilter searchFilter)
                                        throws RepositoryException

Returns the list of 1st level referring documents by the given document handle.

Parameters:

variant - document handle node

searchFilter - reference search filter

Returns:

list of referred document nodes

Throws:

RepositoryException

getReferredDocuments

public static List<Node> getReferredDocuments(Node variant)
                                       throws RepositoryException

Returns the list of 1st level referred documents by the given document variant.

Parameters:

variant - document variant node

Returns:

list of referred document nodes

Throws:

RepositoryException

getReferredDocuments

public static List<Node> getReferredDocuments(Node variant,
 ReferenceSearchFilter searchFilter)
                                       throws RepositoryException

Returns the list of 1st level referred documents by the given document variant.

Parameters:

variant - document variant node

searchFilter - reference search filter

Returns:

list of referred document nodes

Throws:

RepositoryException

getSiteReferences

public static List<SiteReference> getSiteReferences(Node handle,
 String hostGroup,
 boolean preview)
                                             throws RepositoryException

Returns the list of SiteReferences for the given document handle.

Parameters:

handle - document handle

hostGroup - host group of the caller

preview - whether to find preview references

Returns:

list of site references

Throws:

RepositoryException

getSiteReferences

public static List<SiteReference> getSiteReferences(Node handle,
 String hostGroup,
 boolean preview,
 String projectId)
                                             throws RepositoryException

Returns the list of SiteReferences for the given document handle.

Parameters:

handle - document handle

hostGroup - host group of the caller

preview - whether to get preview references

projectId - id of the project

Returns:

list of site references

Throws:

RepositoryException

getComponentVariants

public static Set<String> getComponentVariants(ComponentReference reference,
 String locale)

Returns the set of variants for the given ComponentReference.

Parameters:

reference - the component reference

locale - the locale

Returns:

set of component variants