com.neurosys.module.service

Class CustomAutoNav<T extends IHierarchialReference>

java.lang.Object

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

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

All Implemented Interfaces:

IMenuAutoNav, IMenuGenerator, IMenuPathMapper

public class CustomAutoNav<T extends IHierarchialReference>
extends HierarchyTypeAutoNav<T>

A HierarchyTypeAutoNav for ContentDescriptor

Accept any Query that produces a result set that Looks like the following, where NAME uniquely identifies the Tuple:
TUPLE1: <Name1>,<Display Name 1>,<Parent Category Id/Name 1>
TUPLE2: <Name2>,<Display Name 2>,<Parent Category Id/Name 2>
TUPLE3: <Name3>,<Display Name 3>,<Parent Category Id/Name 3>
etc..
..and will convert it to IHierarchialReference objects and further put it as a Navigatable Tree.
Note: Menu MenuItem.names are case insensitive while comparing.

Author:

Arjun Dhar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomAutoNav.CustomHierarchicalReference Note: Menu MenuItem.names are case insensitive while comparing.
static class	CustomAutoNav.CustomMenuItem

Field Summary

Fields

Modifier and Type	Field and Description
Comparator<T>	DFAULT_AVAILABLE_SORT

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

filterNodesWithNames, filterPredicate

Constructor Summary

Constructors

Constructor and Description
CustomAutoNav()

Method Summary

Modifier and Type	Method and Description
protected MenuItem	addNode(MenuItem parent, T node, List<MenuItem> children) Add Leaf nodes
protected List	convert(List<T> flatList) Convert List of IHierarchialReference to a tree of List and IHierarchialReference type.
MenuItem	getGeneratedMenuItem(Object... params) Generate a Menu based on context, logic and some optional/additional params
org.apache.commons.collections.Transformer	getIsNavigableTransformer() A simple transformer that should return a boolean true/false if the item should be MenuItem.isNavigable() or not.
org.apache.commons.collections.Transformer	getPagePathLookup() Allows for an algorithm to determine the path of the product page The Transformer is expected to take in CustomAutoNav.CustomHierarchicalReference type as input and give the path as String
org.apache.commons.collections.Transformer	getQueryService() A service that can be passed context params and will return a Result Set in the format, where NAME uniquely identifies the Tuplet: TUPLE1 as Object[3]: <Name1>,<Display Name 1>,<Parent Category Name 1>
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(T itemReference) Custom algorithm to figure the destination from the Item reference of Type IHierarchialReference
Comparator<T>	getSort() Allow Sorting of children (nodes of type CustomAutoNav.CustomHierarchicalReference)
protected boolean	isNodeNavigable(T itemReference)
void	setIsNavigableTransformer(org.apache.commons.collections.Transformer isNavigableTransformer) A simple transformer that should return a boolean true/false if the item should be MenuItem.isNavigable() or not.
void	setPagePathLookup(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 CustomAutoNav.CustomHierarchicalReference type as input and give the path as String
void	setQueryService(org.apache.commons.collections.Transformer queryService) A service that can be passed context params and will return a Result Set in the format, where NAME uniquely identifies the Tuplet: TUPLE1 as Object[3]: <Name1>,<Display Name 1>,<Parent Category Name 1>
void	setSort(Comparator<T> sort) Allow Sorting of children (nodes of type CustomAutoNav.CustomHierarchicalReference)

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

Field Detail

DFAULT_AVAILABLE_SORT

public final Comparator<T extends IHierarchialReference> DFAULT_AVAILABLE_SORT

Constructor Detail

CustomAutoNav

public CustomAutoNav()

Method Detail

addNode

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

Description copied from class: HierarchyTypeAutoNav

Add Leaf nodes

Overrides:

addNode in class HierarchyTypeAutoNav<T extends IHierarchialReference>

Parameters:

parent - as MenuItem as the node to add children under

node - as type IHierarchialReference

children - as List of MenuItem

getRefId

protected String getRefId(T itemReference)

Custom algorithm to figure the destination from the Item reference of Type IHierarchialReference

Specified by:

getRefId in class HierarchyTypeAutoNav<T extends IHierarchialReference>

Returns:

String

isNodeNavigable

protected boolean isNodeNavigable(T itemReference)

Specified by:

isNodeNavigable in class HierarchyTypeAutoNav<T extends IHierarchialReference>

See Also:

MenuItem.isNavigable()

convert

protected List convert(List<T> flatList)

Convert List of IHierarchialReference to a tree of List and IHierarchialReference type.

Parameters:

flatList - as List of IHierarchialReference of type

Returns:

Hierarchy as List. Category nodes are lists again with parent as first and other nodes are IHierarchialReference of type

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<T extends IHierarchialReference>

Parameters:

params - here is just additional context params, the main data is expected from the queryService

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

getPagePathLookup

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

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

setPagePathLookup

public void setPagePathLookup(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 CustomAutoNav.CustomHierarchicalReference type as input and give the path as String

getIsNavigableTransformer

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

A simple transformer that should return a boolean true/false if the item should be MenuItem.isNavigable() or not.

Default value:

true

setIsNavigableTransformer

public void setIsNavigableTransformer(org.apache.commons.collections.Transformer isNavigableTransformer)

A simple transformer that should return a boolean true/false if the item should be MenuItem.isNavigable() or not.

Default value:

true

getQueryService

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

A service that can be passed context params and will return a Result Set in the format, where NAME uniquely identifies the Tuplet:
TUPLE1 as Object[3]: <Name1>,<Display Name 1>,<Parent Category Name 1>

setQueryService

public void setQueryService(org.apache.commons.collections.Transformer queryService)

A service that can be passed context params and will return a Result Set in the format, where NAME uniquely identifies the Tuplet:
TUPLE1 as Object[3]: <Name1>,<Display Name 1>,<Parent Category Name 1>

getSort

public Comparator<T> getSort()

Allow Sorting of children (nodes of type CustomAutoNav.CustomHierarchicalReference)

setSort

public void setSort(Comparator<T> sort)

Allow Sorting of children (nodes of type CustomAutoNav.CustomHierarchicalReference)