org.hippoecm.hst.core.linking
Interface LocationMapTree

All Known Implementing Classes:

LocationMapTreeImpl

public interface LocationMapTree

Expert: The LocationMapTree is the container for a tree of LocationMapTreeItem's that are used for internal linkrewriting. Typically it is created by aggregating all the relative content paths from all SiteMapItem's, and create a mapping from this. The match(String path, HstSite hstSite, boolean representsDocument) tries to return the best matching ResolvedLocationMapTreeItem possible for some absolute path. A path can only be rewritten if it belongs to the scope of the HstSite. If the path cannot be matched, null will be returned from the match.

Method Summary

LocationMapTreeItem

getTreeItem(String name)

Method Detail

getTreeItem

LocationMapTreeItem getTreeItem(String name)

Parameters:

name - the name of the locationMapTreeItem

Returns:

the locatioMapTreeItem with this name and null if none exists with this name