tools.gsf.navigation

Interface NavService<N extends Node,S,P>

All Known Implementing Classes:

LightweightSitePlanNavService, SitePlanNavService

public interface NavService<N extends Node,S,P>

Service that exposes hierarchical navigation structures in the form of Nodes. The service also allows an object present in or related to the navigation structures to access its breadcrumb. An object's breadcrumb is defined as the preferred path through the navigation structures from the root of the entire site to the specified object. In specifying "preferred" it therefore follows that an object that is present or related to more than one location in the navigation structures (and can therefore be reached by traversing the navs in more than one way) may only have one single breadcrumb path.

Since:

2016-06-28

Author:

Tony Field

Method Summary

Modifier and Type	Method and Description
List<N>	getBreadcrumb(P obj) Return the preferred breadcrumb path from the root of the site to the object specified.
List<N>	getNav(S id) Returns the nodes corresponding to the nav structure specified.

Method Detail

getNav

List<N> getNav(S id)

Returns the nodes corresponding to the nav structure specified.

Parameters:

id - an identifier that specifies which nav structure should be loaded.

Returns:

a list of the nodes at the root of the nav structure specified. Never null.

Throws:

IllegalArgumentException - if the structure specified is invalid.

getBreadcrumb

List<N> getBreadcrumb(P obj)

Return the preferred breadcrumb path from the root of the site to the object specified. An object's breadcrumb is defined as the preferred path through the navigation structures from the root of the entire site to the specified object. In specifying "preferred" it therefore follows that an object that is present or related to more than one location in the navigation structures (and can therefore be reached by traversing the navs in more than one way) may only have one single breadcrumb path.

Parameters:

obj - object participating in the navigation structure

Returns:

list of nodes, starting with the root node of the site and ending with the node corresponding to the specified object.

Throws:

IllegalArgumentException - if the specified object is not present or related to an object in the nav structures of this site.