com.neurosys.menu.service

Class MenuHelper

java.lang.Object

com.neurosys.menu.service.MenuHelper

public class MenuHelper
extends Object

Helper Methods that allow for convenient MenuItem & MenuItemState traversal. Can extends this.

Author:

Arjun Dhar

Constructor Summary

Constructors

Constructor and Description
MenuHelper()

Method Summary

Modifier and Type	Method and Description
static MenuItemState	cloneMenuItemToState(MenuItem item, Integer levels) generate State tree from an MenuItem upto levels.
<T extends AbsrtactHierarchialItem> int	getDepth(T item, boolean shortCircuit) Get depth of tree.
<T extends AbsrtactHierarchialItem> T	getFirstFertileChild(T item) Convenience method to get the first child element (that has children) for a given list of children in the item
MenuItem	getLogicalFocussedPage(String currentPageUrlPath, Map<String,MenuItem> pageMenuMap, String defaultPageName, boolean cacheByRefIdIfNotFound) Gets the logical path name from the page parameters; if not its extracts it from the end of the path.
static MenuItem	getMenuByRef(String refId, Map<String,MenuItem> pageMenuMap) Search for a MenuItem by references from a map
static MenuItem	getMenuByRef(String refId, MenuItem rootMenuItem) Search for a MenuItem by references from the root MenuItem
<T extends AbsrtactHierarchialItem> List<T>	getSelectedItemHierarchy(T focussedItem, T item) Check if selectedItem is in item's hierarchy.
String	scanOutAppSpecificReference(String currentPageUrlPath) Special function to sniff out raw Wicket class URLs as the intended target; else it returns null

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuHelper

public MenuHelper()

Method Detail

cloneMenuItemToState

public static MenuItemState cloneMenuItemToState(MenuItem item,
                                                 Integer levels)

generate State tree from an MenuItem upto levels. If levels is null, then all levels to child node are followed.

Parameters:

item - as MenuItem

int - @nullable true

Returns:

as MenuItemState

getMenuByRef

public static MenuItem getMenuByRef(String refId,
                                    MenuItem rootMenuItem)

Search for a MenuItem by references from the root MenuItem

Parameters:

refId -

rootMenuItem -

Returns:

getMenuByRef

public static MenuItem getMenuByRef(String refId,
                                    Map<String,MenuItem> pageMenuMap)

Search for a MenuItem by references from a map

Parameters:

refId -

rootMenuItem -

Returns:

scanOutAppSpecificReference

public String scanOutAppSpecificReference(String currentPageUrlPath)

Special function to sniff out raw Wicket class URLs as the intended target; else it returns null

Parameters:

currentPageUrlPath -

Returns:

@nullable true

getLogicalFocussedPage

public MenuItem getLogicalFocussedPage(String currentPageUrlPath,
                                       Map<String,MenuItem> pageMenuMap,
                                       String defaultPageName,
                                       boolean cacheByRefIdIfNotFound)

Gets the logical path name from the page parameters; if not its extracts it from the end of the path.

Parameters:

currentPageUrlPath - as String (current page path URL)

pageMenuMap - as Map of String to MenuItem

defaultPageName - as String (TODO: Remove this shit once we have clarity !)

cacheByRefIdIfNotFound - On true: If the MenuItem is not found, before checking defaultPage then it will cache it in the pageMenuMap for future reference (TODO: Remove this shit once we have clarity !)

Returns:

MenuItem, which Menu item the page corresponds to TODO: Add Unit Test

getFirstFertileChild

public <T extends AbsrtactHierarchialItem> T getFirstFertileChild(T item)

Convenience method to get the first child element (that has children) for a given list of children in the item

Type Parameters:

T -

Parameters:

item -

shortCircuit -

Returns:

@nullable true

getDepth

public <T extends AbsrtactHierarchialItem> int getDepth(T item,
                                                        boolean shortCircuit)

Get depth of tree.
For instance return 0 means base/parent level only.
1 means 2 levels (parent (0), child (1)). So and so forth...

Type Parameters:

T - as AbsrtactHierarchialItem

Parameters:

item - as T type that has children items

shortCircuit; - if true will follow the path of first depth and return with its depth.

Returns:

int as depth of tree

getSelectedItemHierarchy

public <T extends AbsrtactHierarchialItem> List<T> getSelectedItemHierarchy(T focussedItem,
                                                                            T item)

Check if selectedItem is in item's hierarchy. If present will return all the Nodes in order from top to down else will return null if not found. The returned path includes the item itself (first element).

Parameters:

focussedItem - as extends AbsrtactHierarchialItem

item - as extends AbsrtactHierarchialItem

Returns:

List of extends AbsrtactHierarchialItem