com.neurosys.module.service

Class ModuleUIAutoNav

java.lang.Object

com.neurosys.module.service.ModuleUIAutoNav

All Implemented Interfaces:

IMenuAutoNav, IMenuGenerator, IMenuPathMapper

public class ModuleUIAutoNav
extends Object
implements IMenuAutoNav

This service automatically converts all context-available ModuleUI's into MenuItem & AuthorizableMenuItems and adds them to the main adminMenu (Menu DataStructure) & adminPageMenuMap (Which page Item refers to which menu Item to determine current focused page/item) into the context.

The adminMenu & adminPageMenuMap are analogous to the appMenu & pageMenuMap in navigation.xml; except those are for the main apps and are explicitly condifured. Here since we have the Module info, we can automatically generate all this via this class.

To change order of items looks @ sortMenuItems(MenuItem)

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	RELATED_MODULE

Constructor Summary

Constructors

Constructor and Description
ModuleUIAutoNav()

Method Summary

Modifier and Type	Method and Description
protected List<Module>	constructMenuHierarchy(Map<Module,List<ModuleUI>> moduleUiMap, Map<Module,MenuItem> moduleMenuMap) Weave the hierarchical relations between Module and MenuItems.
protected Map<Module,MenuItem>	constructModuleMenuMap(Map<Module,List<ModuleUI>> moduleUiMap)
protected Map<Module,List<ModuleUI>>	constructModuleUiMap(Map<String,ModuleUI> moduleUisMap)
protected MenuItem	createMenuItem(Module module) Allow to overrride to create any custom type of MenuItem if required.
protected MenuItem	createSubMenuForModule(Module module, Map<Module,List<ModuleUI>> moduleUiMap) For a given Module and its list of ModuleUI (see this#moduleUiMap), create atomic MenuItem instances.
protected MenuItem	getAdminNavigation(Map<Module,List<ModuleUI>> moduleUiMap, Map<Module,MenuItem> moduleMenuMap, List<Module> topLevelModules)
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 HierarchyTypeAutoNav
Map<String,String[]>	getReferenceToPathMapping(Object... params) A MenuItem.getRefId() points to the raw resource that the menu points to (like classpath name).
protected void	sortMenuItems(MenuItem rootItem) Will sort the entries in the MenuItem.

Methods inherited from class java.lang.Object

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

Field Detail

RELATED_MODULE

protected static final String RELATED_MODULE

See Also:

Constant Field Values

Constructor Detail

ModuleUIAutoNav

public ModuleUIAutoNav()

Method Detail

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

constructModuleUiMap

protected Map<Module,List<ModuleUI>> constructModuleUiMap(Map<String,ModuleUI> moduleUisMap)

constructModuleMenuMap

protected Map<Module,MenuItem> constructModuleMenuMap(Map<Module,List<ModuleUI>> moduleUiMap)

createMenuItem

protected MenuItem createMenuItem(Module module)

Allow to overrride to create any custom type of MenuItem if required.

Parameters:

module -

Returns:

MenuItem

createSubMenuForModule

protected MenuItem createSubMenuForModule(Module module,
                                          Map<Module,List<ModuleUI>> moduleUiMap)

For a given Module and its list of ModuleUI (see this#moduleUiMap), create atomic MenuItem instances.

Parameters:

module -

Returns:

@nullable true

constructMenuHierarchy

protected List<Module> constructMenuHierarchy(Map<Module,List<ModuleUI>> moduleUiMap,
                                              Map<Module,MenuItem> moduleMenuMap)

Weave the hierarchical relations between Module and MenuItems.
Checks Module.getModule() as parent relation.

sortMenuItems

protected void sortMenuItems(MenuItem rootItem)

Will sort the entries in the MenuItem. Note MenuItem implements Comparable

Parameters:

rootItem -

getAdminNavigation

protected MenuItem getAdminNavigation(Map<Module,List<ModuleUI>> moduleUiMap,
                                      Map<Module,MenuItem> moduleMenuMap,
                                      List<Module> topLevelModules)

getGeneratedPageMenuMap

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

TODO: This method is common with HierarchyTypeAutoNav

Specified by:

getGeneratedPageMenuMap in interface IMenuPathMapper

Parameters:

params - as any params

Returns:

Map of String to 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.

Specified by:

getReferenceToPathMapping in interface IMenuPathMapper

Returns:

Map of String to String array