org.hippoecm.hst.configuration.internal

Interface InternalHstSiteMapItem

All Superinterfaces:

CanonicalInfo, HstSiteMapItem

public interface InternalHstSiteMapItem
extends HstSiteMapItem, CanonicalInfo

Internal only api to represent HstSiteMapItem by joining with CanonicalInfo in sitemapitem matcher

Method Summary

Modifier and Type	Method and Description
List<InternalHstSiteMapItem>	getAnyChildSiteMapItems()
InternalHstSiteMapItem	getAnyPatternChild(String[] pathElements, int position, List<InternalHstSiteMapItem> anyChildSiteMapItems, List<InternalHstSiteMapItem> excludedSiteList) Internal only! Not an api.
List<InternalHstSiteMapItem>	getWildCardChildSiteMapItems()
InternalHstSiteMapItem	getWildCardPatternChild(String pathElementValue, List<InternalHstSiteMapItem> wildCardChildSiteMapItems, List<InternalHstSiteMapItem> excludedSiteList) Internal only! Not an api.
String	getWildCardPostfix()
String	getWildCardPrefix()
boolean	patternMatch(String pathElementValue, String prefix, String postfix) Internal only! Not an api.

Methods inherited from interface org.hippoecm.hst.configuration.sitemap.HstSiteMapItem

containsAny, containsWildCard, getApplicationId, getChild, getChildren, getComponentConfigurationId, getComponentConfigurationIdMappings, getErrorCode, getHstSiteMap, getHstSiteMapItemHandlers, getId, getLocale, getLocalParameter, getLocalParameters, getNamedPipeline, getPageTitle, getParameter, getParameters, getParentItem, getQualifiedId, getRefId, getRelativeContentPath, getResourceBundleIds, getResponseHeaders, getRoles, getScheme, getSchemeNotMatchingResponseCode, getSiteMapItemHandlerConfiguration, getSiteMapItemHandlerConfigurations, getStatusCode, getUsers, getValue, isAny, isAuthenticated, isCacheable, isContainerResource, isExcludedForLinkRewriting, isExplicitElement, isExplicitPath, isHiddenInChannelManager, isMarkedDeleted, isSchemeAgnostic, isWildCard

Methods inherited from interface org.hippoecm.hst.configuration.internal.CanonicalInfo

getCanonicalIdentifier, getCanonicalPath, isWorkspaceConfiguration

Method Detail

getWildCardPatternChild

InternalHstSiteMapItem getWildCardPatternChild(String pathElementValue,
                                               List<InternalHstSiteMapItem> wildCardChildSiteMapItems,
                                               List<InternalHstSiteMapItem> excludedSiteList)

Internal only! Not an api.

Parameters:

pathElementValue - any value splitted by slash in path like /path/to/element

wildCardChildSiteMapItems - List of HstSiteMapItem items that match with a wildcard pattern

excludedSiteList - sites to be excluded from traverse

Returns:

getAnyPatternChild

InternalHstSiteMapItem getAnyPatternChild(String[] pathElements,
                                          int position,
                                          List<InternalHstSiteMapItem> anyChildSiteMapItems,
                                          List<InternalHstSiteMapItem> excludedSiteList)

Internal only! Not an api.

Parameters:

pathElements - list of path elements to traverse

position - of the path element

anyChildSiteMapItems - List of HstSiteMapItem items that match with any pattern

excludedSiteList - sites to be excluded from traverse

Returns:

patternMatch

boolean patternMatch(String pathElementValue,
                     String prefix,
                     String postfix)

Internal only! Not an api. Tries to match a path element value with a prefix and a postfix.

Parameters:

pathElementValue - any value splitted by slash in path like /path/to/element

prefix - of the wildcard

postfix - of the wildcard

Returns:

returns true if the value of the path element matches with prefix and postfix

getWildCardPrefix

String getWildCardPrefix()

Returns:

prefix of the wildcard definition

getWildCardPostfix

String getWildCardPostfix()

Returns:

postfix of the wildcard definition

getWildCardChildSiteMapItems

List<InternalHstSiteMapItem> getWildCardChildSiteMapItems()

Returns:

List of HstSiteMapItem items that configured to be accessed by a wildcard

getAnyChildSiteMapItems

List<InternalHstSiteMapItem> getAnyChildSiteMapItems()

Returns:

List of HstSiteMapItem items that configured to be accessed by any