org.hippoecm.hst.configuration.sitemap
Class HstSiteMapService

java.lang.Object
  org.hippoecm.hst.configuration.sitemap.HstSiteMapService

All Implemented Interfaces:

HstSiteMap

public class HstSiteMapService
extends Object
implements HstSiteMap

Constructor Summary

HstSiteMapService(HstSite hstSite, HstNode siteMapNode, Mount mount, HstSiteMapItemHandlersConfiguration siteMapItemHandlersConfiguration)

Method Summary

Service[]	getChildServices()
HstSite	getSite() Return the HstSite this HstSiteMap belongs to.
HstSiteMapItem	getSiteMapItem(String value) Return the child HstSiteMapItem that has the corresponding value (HstSiteMapItem.getValue() ) and null otherwise
HstSiteMapItem	getSiteMapItemById(String id) Return the child HstSiteMapItem that has the corresponding id (HstSiteMapItem.getId() ) and null otherwise
HstSiteMapItem	getSiteMapItemByRefId(String refId) Return the child HstSiteMapItem that has the corresponding refId (HstSiteMapItem.getRefId() ) and null otherwise
List<HstSiteMapItem>	getSiteMapItems() The list of SiteMapItem's that are root items.

Methods inherited from class java.lang.Object

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

Constructor Detail

HstSiteMapService

public HstSiteMapService(HstSite hstSite,
                         HstNode siteMapNode,
                         Mount mount,
                         HstSiteMapItemHandlersConfiguration siteMapItemHandlersConfiguration)
                  throws ServiceException

Throws:

ServiceException

Method Detail

getChildServices

public Service[] getChildServices()

getSiteMapItem

public HstSiteMapItem getSiteMapItem(String value)

Description copied from interface: HstSiteMap

Return the child HstSiteMapItem that has the corresponding value (HstSiteMapItem.getValue() ) and null otherwise

Specified by:

getSiteMapItem in interface HstSiteMap

Parameters:

value - the value of the child HstSiteMapItem as it would be return by HstSiteMapItem.getValue()

Returns:

Returns the HstSiteMapItem object corresponding to the unique value and null if no HstSiteMapItem exists with this value in this HstSiteMapItem object.

getSiteMapItemById

public HstSiteMapItem getSiteMapItemById(String id)

Description copied from interface: HstSiteMap

Return the child HstSiteMapItem that has the corresponding id (HstSiteMapItem.getId() ) and null otherwise

Specified by:

getSiteMapItemById in interface HstSiteMap

Parameters:

id - the id of the child HstSiteMapItem as it would be return by HstSiteMapItem.getId()

Returns:

Returns the HstSiteMapItem object corresponding to the unique id and null if no HstSiteMapItem exists with this refId in this HstSiteMapItem object.

getSiteMapItemByRefId

public HstSiteMapItem getSiteMapItemByRefId(String refId)

Description copied from interface: HstSiteMap

Return the child HstSiteMapItem that has the corresponding refId (HstSiteMapItem.getRefId() ) and null otherwise

Specified by:

getSiteMapItemByRefId in interface HstSiteMap

Parameters:

refId - the refId of the child HstSiteMapItem as it would be return by HstSiteMapItem.getRefId()

Returns:

Returns the HstSiteMapItem object corresponding to the unique refId and null if no HstSiteMapItem exists with this refId in this HstSiteMapItem object.

getSiteMapItems

public List<HstSiteMapItem> getSiteMapItems()

Description copied from interface: HstSiteMap

The list of SiteMapItem's that are root items. They represent the first paths of the urls. Implementations should return an unmodifiable list, for example Collections.UnmodifiableList to avoid client code changing configuration

Specified by:

getSiteMapItems in interface HstSiteMap

Returns:

a List of all root SiteMapItem's

getSite

public HstSite getSite()

Description copied from interface: HstSiteMap

Return the HstSite this HstSiteMap belongs to.

Specified by:

getSite in interface HstSiteMap

Returns:

the site this HstSiteMap belongs to