com.neurosys.products.service

Class CatalogAutoNav

java.lang.Object

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

com.neurosys.products.service.CatalogAutoNav

All Implemented Interfaces:

IMenuAutoNav, IMenuGenerator, IMenuPathMapper

public class CatalogAutoNav
extends HierarchyTypeAutoNav<ProductReference>

A HierarchyTypeAutoNav for ProductReference

Author:

Arjun Dhar TODO: Write unit Test

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogAutoNav.CatalogMenuItem

Field Summary

Fields inherited from class com.neurosys.module.service.HierarchyTypeAutoNav

filterNodesWithNames, filterPredicate

Constructor Summary

Constructors

Constructor and Description
CatalogAutoNav()

Method Summary

Modifier and Type	Method and Description
protected MenuItem	addNode(MenuItem parent, ProductReference node, List<MenuItem> children) Add Leaf nodes
MenuItem	getGeneratedMenuItem(Object... params) Generate a Menu based on context, logic and some optional/additional params
org.apache.commons.collections.Transformer	getProductPagePathLookup() Allows for an algorithm to determine the path of the product page The Transformer is expected to take in ProductReference as input and give the path as String
Map<String,String[]>	getReferenceToPathMapping(Object... params) A MenuItem.getRefId() points to the raw resource that the menu points to (like classpath name).
protected String	getRefId(ProductReference prodReference) Override this method and customize it to App Page specific path Default it will only return the product name suffixed to productPagePathLookup
protected boolean	isNodeNavigable(ProductReference prodReference)
void	setProductPagePathLookup(org.apache.commons.collections.Transformer productPagePathLookup) Allows for an algorithm to determine the path of the product page The Transformer is expected to take in ProductReference as input and give the path as String

Methods inherited from class com.neurosys.module.service.HierarchyTypeAutoNav

add, assignRootLevel, getFilterNodesWithNames, getGeneratedPageMenuMap, getId, setFilterNodesWithNames, setId, toString, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogAutoNav

public CatalogAutoNav()

Method Detail

addNode

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

Description copied from class: HierarchyTypeAutoNav

Add Leaf nodes

Overrides:

addNode in class HierarchyTypeAutoNav<ProductReference>

Parameters:

parent - as MenuItem as the node to add children under

node - as type IHierarchialReference

children - as List of MenuItem

getRefId

protected String getRefId(ProductReference prodReference)

Override this method and customize it to App Page specific path
Default it will only return the product name suffixed to productPagePathLookup

Specified by:

getRefId in class HierarchyTypeAutoNav<ProductReference>

Returns:

String

isNodeNavigable

protected boolean isNodeNavigable(ProductReference prodReference)

Specified by:

isNodeNavigable in class HierarchyTypeAutoNav<ProductReference>

See Also:

MenuItem.isNavigable()

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

Overrides:

getGeneratedMenuItem in class HierarchyTypeAutoNav<ProductReference>

Parameters:

params - optional

Returns:

MenuItem

getReferenceToPathMapping

public Map<String,String[]> getReferenceToPathMapping(Object... params)

Description copied from interface: IMenuPathMapper

A MenuItem.getRefId() points to the raw resource that the menu points to (like classpath name). To generate the Page Menu Map when the refId is not same as app path we require the additional mapping(s). Note, a reference can have multiple path aliases.

Returns:

Map of String to String array

getProductPagePathLookup

public org.apache.commons.collections.Transformer getProductPagePathLookup()

Allows for an algorithm to determine the path of the product page
The Transformer is expected to take in ProductReference as input and give the path as String

See Also:

ProductPagePathTransformer

setProductPagePathLookup

public void setProductPagePathLookup(org.apache.commons.collections.Transformer productPagePathLookup)

Allows for an algorithm to determine the path of the product page
The Transformer is expected to take in ProductReference as input and give the path as String

See Also:

ProductPagePathTransformer