tools.gsf.navigation

Class SitePlanNavService

java.lang.Object

tools.gsf.navigation.SitePlanNavService

All Implemented Interfaces:

NavService<AssetNode,com.fatwire.assetapi.data.AssetId,com.fatwire.assetapi.data.AssetId>

Direct Known Subclasses:

LightweightSitePlanNavService

public abstract class SitePlanNavService
extends Object
implements NavService<AssetNode,com.fatwire.assetapi.data.AssetId,com.fatwire.assetapi.data.AssetId>

Simple navigation service implementation that loads objects from the Site Plan. Supports populating node data via a dedicated method that can be overridden to load any data that is required, as long as it can be presented as a TemplateAsset. Reads the full site plan tree in one query, but only reads asset data for nodes that it is going to actually return.

Since:

2016-07-06

Author:

Tony Field

Constructor Summary

Constructors

Constructor and Description
SitePlanNavService(COM.FutureTense.Interfaces.ICS ics)

Method Summary

Modifier and Type	Method and Description
protected List<AssetNode>	chooseBreadcrumb(Collection<List<AssetNode>> options) Pick which breadcrumb to return if more than one path has been found.
List<AssetNode>	getBreadcrumb(com.fatwire.assetapi.data.AssetId id) Return the preferred breadcrumb path from the root of the site to the object specified.
protected List<AssetNode>	getBreadcrumbForNode(AssetNode node) Get the breadcrumb corresponding to the specified node.
List<AssetNode>	getNav(com.fatwire.assetapi.data.AssetId sitePlan) Returns the nodes corresponding to the nav structure specified.
protected abstract TemplateAsset	getNodeData(com.fatwire.assetapi.data.AssetId id) Method to retrieve data that will be loaded into a node.

Methods inherited from class java.lang.Object

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

Constructor Detail

SitePlanNavService

public SitePlanNavService(COM.FutureTense.Interfaces.ICS ics)

Method Detail

getNav

public List<AssetNode> getNav(com.fatwire.assetapi.data.AssetId sitePlan)

Description copied from interface: NavService

Returns the nodes corresponding to the nav structure specified.

Specified by:

getNav in interface NavService<AssetNode,com.fatwire.assetapi.data.AssetId,com.fatwire.assetapi.data.AssetId>

Parameters:

sitePlan - 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.

getNodeData

protected abstract TemplateAsset getNodeData(com.fatwire.assetapi.data.AssetId id)

Method to retrieve data that will be loaded into a node. Implementing classes should take care to be very efficient both for cpu time as well as memory usage.

Parameters:

id - asset ID to load

Returns:

asset data in the form of a TemplateAsset, never null

getBreadcrumb

public List<AssetNode> getBreadcrumb(com.fatwire.assetapi.data.AssetId id)

Description copied from interface: NavService

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.

Specified by:

getBreadcrumb in interface NavService<AssetNode,com.fatwire.assetapi.data.AssetId,com.fatwire.assetapi.data.AssetId>

Parameters:

id - 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.

getBreadcrumbForNode

protected List<AssetNode> getBreadcrumbForNode(AssetNode node)

Get the breadcrumb corresponding to the specified node. Default implementation simply uses the specified node's parents.

Parameters:

node - the node whose breadcrumb needs to be calculated

Returns:

the breadcrumb

chooseBreadcrumb

protected List<AssetNode> chooseBreadcrumb(Collection<List<AssetNode>> options)

Pick which breadcrumb to return if more than one path has been found. Default implementation simply returns the first one returned by the specified collection's iterator.

Parameters:

options - candidate breadcrumbs

Returns:

the breadcrumb to use.