org.hippoecm.hst.configuration.sitemap
Interface HstSiteMap

All Known Implementing Classes:

HstSiteMapService

public interface HstSiteMap

A HstSiteMap contains a list of (root) HstSiteMapItem objects which themselves might contain additional HstSiteMapItem children and so on. As a HstSiteMapItem might have an id, which needs to be unique within the HstSiteMap, through which a direct lookup of such a HstSiteMapItem is also possible

NOTE: As HstComponent instances can access HstSiteMap instances but should not be able to modify them, implementations must make sure that through the api a HstSiteMap instance cannot be changed. Returned List and Map should be therefor unmodifiable.

Method Summary

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.

Method Detail

getSite

HstSite getSite()

Return the HstSite this HstSiteMap belongs to.

Returns:

the site this HstSiteMap belongs to

getSiteMapItems

List<HstSiteMapItem> getSiteMapItems()

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

Returns:

a List of all root SiteMapItem's

getSiteMapItem

HstSiteMapItem getSiteMapItem(String value)

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

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

HstSiteMapItem getSiteMapItemById(String id)

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

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

HstSiteMapItem getSiteMapItemByRefId(String refId)

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

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.