com.neurosys.module.service

Class HierarchyTypeAutoNav<T extends IHierarchialReference>

java.lang.Object

com.neurosys.module.service.HierarchyTypeAutoNav<T>

All Implemented Interfaces:

IMenuAutoNav, IMenuGenerator, IMenuPathMapper

Direct Known Subclasses:

CatalogAutoNav, ContentAutoNav, CustomAutoNav

public abstract class HierarchyTypeAutoNav<T extends IHierarchialReference>
extends Object
implements IMenuAutoNav

This service automatically converts all IHierarchialReference hierarchy into MenuItem & AuthorizableMenuItems and insert/appends them to the menu & pageMenuMap (see navigation.xml) (Which page Item refers to which menu Item to determine current focused page/item).

See navigation.xml

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	filterNodesWithNames We may want to exclude certain nodes/types of nodes from the Loading process while creating the Nav Supply the unique names identifying the nodes.
protected org.apache.commons.collections.Predicate	filterPredicate The Predicate used to filter our Nodes in filterNodesWithNames

Constructor Summary

Constructors

Constructor and Description
HierarchyTypeAutoNav()

Method Summary

Modifier and Type	Method and Description
protected void	add(MenuItem parent, List hierarchy) Add hierarchy elements under the parent in recursive manner.
protected MenuItem	addNode(MenuItem parent, T node, List<MenuItem> children) Add Leaf nodes
protected void	assignRootLevel(MenuItem root) Assign a root level ;so that other generated MenuItem know whoch MenuItem.getLevel() they are.
List<String>	getFilterNodesWithNames() We may want to exclude certain nodes/types of nodes from the Loading process while creating the Nav Supply the unique names identifying the nodes.
MenuItem	getGeneratedMenuItem(Object... params) Generate a Menu based on context, logic and some optional/additional params
Map<String,MenuItem>	getGeneratedPageMenuMap(Object... params) TODO: This method is common with ModuleUIAutoNav
String	getId() A way to identify the navigator in the logs etc.
protected abstract String	getRefId(T node) An implementation of the reference to a node
protected abstract boolean	isNodeNavigable(T node)
void	setFilterNodesWithNames(List<String> filterNodesWithNames) We may want to exclude certain nodes/types of nodes from the Loading process while creating the Nav Supply the unique names identifying the nodes.
void	setId(String id) A way to identify the navigator in the logs etc.
String	toString()
protected void	transform(List hierarchy) Transform the loaded Hierarchy; filter etc.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neurosys.module.service.IMenuPathMapper

getReferenceToPathMapping

Field Detail

filterNodesWithNames

protected List<String> filterNodesWithNames

We may want to exclude certain nodes/types of nodes from the Loading process while creating the Nav
Supply the unique names identifying the nodes.

filterPredicate

protected org.apache.commons.collections.Predicate filterPredicate

The Predicate used to filter our Nodes in filterNodesWithNames

Constructor Detail

HierarchyTypeAutoNav

public HierarchyTypeAutoNav()

Method Detail

add

protected final void add(MenuItem parent,
                         List hierarchy)

Add hierarchy elements under the parent in recursive manner.

Parameters:

parent - as MenuItem as the node to add children under

hierarchy - as the sub-hierarchy as List of IHierarchialReference nodes

isNodeNavigable

protected abstract boolean isNodeNavigable(T node)

See Also:

MenuItem.isNavigable()

addNode

protected MenuItem addNode(MenuItem parent,
                           T node,
                           List<MenuItem> children)

Add Leaf nodes

Parameters:

parent - as MenuItem as the node to add children under

node - as type IHierarchialReference

children - as List of MenuItem

getRefId

protected abstract String getRefId(T node)

An implementation of the reference to a node

Parameters:

node -

Returns:

String

transform

protected void transform(List hierarchy)

Transform the loaded Hierarchy; filter etc.
By default uses filterNodesWithNames to remove exceptions nodes (Common Use case)

getGeneratedMenuItem

public MenuItem getGeneratedMenuItem(Object... params)

Description copied from interface: IMenuGenerator

Generate a Menu based on context, logic and some optional/additional params

Specified by:

getGeneratedMenuItem in interface IMenuGenerator

Parameters:

params - optional

Returns:

MenuItem

assignRootLevel

protected void assignRootLevel(MenuItem root)

Assign a root level ;so that other generated MenuItem know whoch MenuItem.getLevel() they are. If kept null; level is not maintained in the tree.

Parameters:

root -

Default value:

0

getGeneratedPageMenuMap

public Map<String,MenuItem> getGeneratedPageMenuMap(Object... params)

TODO: This method is common with ModuleUIAutoNav

Specified by:

getGeneratedPageMenuMap in interface IMenuPathMapper

Parameters:

params - as any params

Returns:

Map of String to MenuItem

getFilterNodesWithNames

public List<String> getFilterNodesWithNames()

We may want to exclude certain nodes/types of nodes from the Loading process while creating the Nav
Supply the unique names identifying the nodes.

setFilterNodesWithNames

public void setFilterNodesWithNames(List<String> filterNodesWithNames)

We may want to exclude certain nodes/types of nodes from the Loading process while creating the Nav
Supply the unique names identifying the nodes.

getId

public String getId()

A way to identify the navigator in the logs etc.

Can be null:

true

setId

public void setId(String id)

A way to identify the navigator in the logs etc.

Can be null:

true

toString

public String toString()

Overrides:

toString in class Object