tools.gsf.navigation.siteplan

Class SitePlanNavService<N extends AssetNode<N> & ConfigurableNode<N>>

java.lang.Object

tools.gsf.navigation.siteplan.SitePlanNavService<N>

All Implemented Interfaces:

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

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

Simple navigation service implementation that loads objects from the Site Plan. Reads the full site plan tree in one query. It does not filter assets by site. Nodes are instantiated via a dedicated method where you can load any data that is required; you get to (define and) use your own AssetNode implementation. This NavService implementation REQUIRES that the SitePlan models your navigational structures after the following design: SitePlan root node (SiteNavigation asset) | ----------- Nav Structure "A" Placeholder (Page asset) | | | |----------- Webpage A.1 (Page asset) | | | | | |----------- Webpage A.1.1 (Page asset) | | |----------- (...) (Page assets) | | | |----------- Webpage A.2 (Page asset) | | | | | |----------- (...) (Page assets) | | | |----------- Webpage A.3 (Page asset) | | | | | |----------- (...) (Page assets) | ----------- Nav Structure "B" Placeholder (Page asset) | | | |----------- Webpage B.1 (Page asset) | | | | | |----------- (...) (Page assets) | | | |----------- Webpage B.2 (Page asset) | | | | | |----------- (...) (Page assets) | | | |----------- Webpage A.3 (Page asset) | | | |----------- (...) (Page assets) | ----------- (...) (Other nav structures) ... where: - SiteNavigation nodes will always be excluded from a Webpage node's definitive breadcrumb. - SiteNavigation nodes are not part of any nav structure. - Nav Structure Placeholder nodes will always be excluded from a Webpage node's definitive breadcrumb. - Nav Structure Placeholder are not part of a nav structure, they are just the entry point to it.

Since:

2016-07-06

Author:

Tony Field

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SitePlanNavService.BreadcrumbCandidate<N extends AssetNode<N>>

Constructor Summary

Constructors

Constructor and Description
SitePlanNavService(COM.FutureTense.Interfaces.ICS ics, TemplateAssetAccess dao)
SitePlanNavService(COM.FutureTense.Interfaces.ICS ics, TemplateAssetAccess dao, String theSitename)

Method Summary

Modifier and Type	Method and Description
protected List<N>	chooseBreadcrumb(Collection<SitePlanNavService.BreadcrumbCandidate<N>> candidates) Determines a node's "preferred" breadcrumb from a list of "candidates".
protected abstract N	createAssetNode(com.fatwire.assetapi.data.AssetId assetId) For a given (Page) AssetId, creates an object whose type matches this method's return type (Generic), which will be added to the nav structure produced by this NavService implementation.
List<N>	getBreadcrumb(com.fatwire.assetapi.data.AssetId id) Return the preferred breadcrumb path from the root of the site to the object specified.
protected List<N>	getBreadcrumbForNode(N node) Get the breadcrumb corresponding to the specified node.
List<N>	getNav(com.fatwire.assetapi.data.AssetId sitePlan) Returns the nodes corresponding to the nav structure specified.
protected String	getSitename()
protected TemplateAssetAccess	getTemplateAssetAccess()

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,
                          TemplateAssetAccess dao)

SitePlanNavService

public SitePlanNavService(COM.FutureTense.Interfaces.ICS ics,
                          TemplateAssetAccess dao,
                          String theSitename)

Method Detail

createAssetNode

protected abstract N createAssetNode(com.fatwire.assetapi.data.AssetId assetId)

For a given (Page) AssetId, creates an object whose type matches this method's return type (Generic), which will be added to the nav structure produced by this NavService implementation.

Parameters:

assetId - The ID of the asset you want to create an AssetNode instance for

Returns:

An object whose type matches this method's return type (Generic type N)

getTemplateAssetAccess

protected TemplateAssetAccess getTemplateAssetAccess()

getSitename

protected String getSitename()

getNav

public List<N> 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<N extends AssetNode<N> & ConfigurableNode<N>,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.

getBreadcrumb

public List<N> 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<N extends AssetNode<N> & ConfigurableNode<N>,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<N> getBreadcrumbForNode(N 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<N> chooseBreadcrumb(Collection<SitePlanNavService.BreadcrumbCandidate<N>> candidates)

Determines a node's "preferred" breadcrumb from a list of "candidates". This default implementation simply returns the first one returned by the specified collection's iterator. However, you may override this method in order to implement your own ad-hoc logic for determining the preferred breadcrumb. The candidates passed into this method have already parsed the raw breadcrumb so to split it up in the due SiteNavigation node, Nav Structure Placeholder node and the clean breadcrumb path.

Parameters:

candidates - The candidates you get to choose the preferred breadcrumb from.

Returns:

The preferred breadcrumb (list of nodes).