com.fatwire.gst.foundation.navigation.support
Class AbstractNavigationService

java.lang.Object
  com.fatwire.gst.foundation.navigation.support.AbstractNavigationService

All Implemented Interfaces:

NavigationService

Direct Known Subclasses:

SimpleNavigationHelper, WraNavigationService

public abstract class AbstractNavigationService
extends Object
implements NavigationService

Field Summary

protected TemplateAssetAccess	assetTemplate
protected COM.FutureTense.Interfaces.ICS	ics
protected String	linkLabelAttribute
protected String	pathAttribute

Constructor Summary

protected	AbstractNavigationService(COM.FutureTense.Interfaces.ICS ics)
protected	AbstractNavigationService(COM.FutureTense.Interfaces.ICS ics, TemplateAssetAccess assetTemplate)
protected	AbstractNavigationService(COM.FutureTense.Interfaces.ICS ics, TemplateAssetAccess assetTemplate, String linkLabelAttribute, String pathAttribute) Constructor that sets the linkLabel and path attributes.

Method Summary

String	getLinkLabelAttribute()
protected abstract NavigationNode	getNode(Row row, int level, int depth, String linkAttribute)
NavigationNode	getNodeByName(String pagename, int depth)
NavigationNode	getNodeByName(String pagename, int depth, String linkAttribute) Retrieves the NavigationNodes for the Page with the name pagename and in the current site.
NavigationNode	getNodeByName(String site, String pagename, int depth)
NavigationNode	getNodeByName(String site, String pagename, int depth, String linkAttribute)
NavigationNode	getNodeByQuery(com.fatwire.assetapi.query.Query query, int depth, String linkAttribute)
protected abstract Collection<NavigationNode>	getNodeChildren(long nodeId, int level, int depth, String linkAttribute) List all the child NavigationNode at this SitePlanTree nodeId.
String	getPathAttribute()
Collection<NavigationNode>	getRootNodesForSite(int depth)
Collection<NavigationNode>	getRootNodesForSite(String site)
Collection<NavigationNode>	getRootNodesForSite(String site, int depth)
Collection<NavigationNode>	getRootNodesForSite(String site, int depth, String linkAttribute)
void	setLinkLabelAttribute(String linkLabelAttribute)
void	setPathAttribute(String pathAttribute)

Methods inherited from class java.lang.Object

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

Field Detail

ics

protected final COM.FutureTense.Interfaces.ICS ics

assetTemplate

protected final TemplateAssetAccess assetTemplate

linkLabelAttribute

protected String linkLabelAttribute

pathAttribute

protected String pathAttribute

Constructor Detail

AbstractNavigationService

protected AbstractNavigationService(COM.FutureTense.Interfaces.ICS ics)

AbstractNavigationService

protected AbstractNavigationService(COM.FutureTense.Interfaces.ICS ics,
                                    TemplateAssetAccess assetTemplate)

AbstractNavigationService

protected AbstractNavigationService(COM.FutureTense.Interfaces.ICS ics,
                                    TemplateAssetAccess assetTemplate,
                                    String linkLabelAttribute,
                                    String pathAttribute)

Constructor that sets the linkLabel and path attributes.

Parameters:

ics -

assetTemplate -

linkLabelAttribute -

pathAttribute -

Method Detail

getRootNodesForSite

public Collection<NavigationNode> getRootNodesForSite(String site)

Parameters:

site -

Returns:

the root SitePlanTree nodes for this site

getRootNodesForSite

public Collection<NavigationNode> getRootNodesForSite(int depth)

Specified by:

getRootNodesForSite in interface NavigationService

Parameters:

depth - the maximum number of levels to retrieve

Returns:

the NavigationNodes for the page by this name.

getRootNodesForSite

public Collection<NavigationNode> getRootNodesForSite(String site,
                                                      int depth)

Specified by:

getRootNodesForSite in interface NavigationService

depth - the maximum number of levels to retrieve

Returns:

the NavigationNodes for the page by this name.

getNodeByName

public NavigationNode getNodeByName(String site,
                                    String pagename,
                                    int depth)

Specified by:

getNodeByName in interface NavigationService

pagename - the name of the Page asset

depth - the maximum number of levels to retrieve

Returns:

the NavigationNode for the page by this name.

getNodeByName

public NavigationNode getNodeByName(String pagename,
                                    int depth,
                                    String linkAttribute)

Description copied from interface: NavigationService

Retrieves the NavigationNodes for the Page with the name pagename and in the current site.

Specified by:

getNodeByName in interface NavigationService

Parameters:

pagename - the name of the Page asset

depth - the maximum number of levels to retrieve

Returns:

the NavigationNode for the page by this name.

getNodeByName

public NavigationNode getNodeByName(String pagename,
                                    int depth)

Specified by:

getNodeByName in interface NavigationService

Parameters:

pagename - the name of the Page asset

Returns:

the NavigationNode for the page by this name.

getRootNodesForSite

public Collection<NavigationNode> getRootNodesForSite(String site,
                                                      int depth,
                                                      String linkAttribute)

Specified by:

getRootNodesForSite in interface NavigationService

Parameters:

site -

depth -

linkAttribute -

Returns:

getNodeByName

public NavigationNode getNodeByName(String site,
                                    String pagename,
                                    int depth,
                                    String linkAttribute)

Specified by:

getNodeByName in interface NavigationService

pagename - the name of the Page asset

depth - the maximum number of levels to retrieve

Returns:

the NavigationNode for the page by this name.

getNodeByQuery

public NavigationNode getNodeByQuery(com.fatwire.assetapi.query.Query query,
                                     int depth,
                                     String linkAttribute)

Specified by:

getNodeByQuery in interface NavigationService

Parameters:

query - the asset query, needs to return Page assets

depth - the maximum number of levels to retrieve

Returns:

the NavigationNode for the page by this name.

getNodeChildren

protected abstract Collection<NavigationNode> getNodeChildren(long nodeId,
                                                              int level,
                                                              int depth,
                                                              String linkAttribute)

List all the child NavigationNode at this SitePlanTree nodeId.

Parameters:

nodeId - the nodeId from the SitePlanTree

level - the tree level depth

depth - the maximum depth

linkAttribute - the attribute to use for the link text

Returns:

getNode

protected abstract NavigationNode getNode(Row row,
                                          int level,
                                          int depth,
                                          String linkAttribute)

Parameters:

row - the resultlist containing nid/oid/otype

level - the current level

depth - the maximum depth

linkAttribute - the attribute for the link text.

Returns:

the NavigationNode

getLinkLabelAttribute

public String getLinkLabelAttribute()

Returns:

the linkLabelAttribute

setLinkLabelAttribute

public void setLinkLabelAttribute(String linkLabelAttribute)

Parameters:

linkLabelAttribute -

getPathAttribute

public String getPathAttribute()

Returns:

the pathAttribute

setPathAttribute

public void setPathAttribute(String pathAttribute)

Parameters:

pathAttribute -