com.neurosys.menu.model

Class AutoGenMenuItem

java.lang.Object

com.neurosys.menu.model.MenuItem

com.neurosys.menu.model.AutoGenMenuItem

All Implemented Interfaces:

AbsrtactHierarchialItem, Serializable, Comparable

public class AutoGenMenuItem
extends MenuItem

A MenuItem that will replace itself with a List of auto generated MenuItems. The generated List will be added to the MenuItem root mentioned in the configuration.

Call the this#scanAndReplace() method to trigger the operation.

Author:

Arjun Dhar

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AutoGenMenuItem()

Method Summary

Modifier and Type	Method and Description
MenuItem	getContainer() Name of the MenuItem which is the container of this.
IMenuGenerator	getGenerator() The instance of the generator that will produce the replacement actual MenuItems
IMenuPathMapper	getMapper()
Map<String,MenuItem>	getRefMenuMapping()
void	refresh() Once Auto generated in scanAndReplace() the proxy/dummy reference of this is removed from the main menu.
protected boolean	replaceable(MenuItem existingItem, MenuItem replacingItem) Checks on a criteria that one MenuItem is replaceable by another.
void	scanAndReplace() Scan for this item in the container and replace it with the auto generated version. Use first time, like init or start up conditions.
void	scanAndReplaceUpdate() Deprecated. : Could only replace menu items if the hierarchical structure was not changed
protected void	scanAndReplaceUpdate(MenuItem generatedMenu, MenuItem existing) Deprecated. : Could only replace menu items if the hierarchical structure was not changed
void	setContainer(MenuItem container) Name of the MenuItem which is the container of this.
void	setGenerator(IMenuGenerator generator) The instance of the generator that will produce the replacement actual MenuItems
void	setMapper(IMenuPathMapper mapper)
void	setRefMenuMapping(Map<String,MenuItem> refMenuMapping) pageMenuMap (reference to Menu) mapping needs to be also auto generated if the menu is auto-gen.

Methods inherited from class com.neurosys.menu.model.MenuItem

compareTo, equals, getChildren, getLevel, getName, getParent, getRefId, hashCode, isNavigable, setChildren, setLevel, setName, setNavigable, setParent, setRefId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AutoGenMenuItem

public AutoGenMenuItem()

Method Detail

scanAndReplace

@OnApplicationStartup(state=INIT_AT_START)
public void scanAndReplace()

Scan for this item in the container and replace it with the auto generated version.
Use first time, like init or start up conditions. TODO: Add unit Test case for when container.getChildren() is Empty

refresh

public void refresh()

Once Auto generated in scanAndReplace() the proxy/dummy reference of this is removed from the main menu. However the children that are added are real. This method will replace the ones added by this AutoGenMenuItem TODO: Add unit test case + unit Test case for when container.getChildren() is Empty

scanAndReplaceUpdate

@Deprecated
public void scanAndReplaceUpdate()

Deprecated. : Could only replace menu items if the hierarchical structure was not changed

Once Auto generated in scanAndReplace() the proxy/dummy reference of this is removed from the main menu. However the children that are added are real. This method, scans for matching children nodes and replaces them with newly generated child nodes. it matches the one level below container only (since the auto-gen menus would be added one level below the set container)

Use to update child nodes.

scanAndReplaceUpdate

@Deprecated
protected final void scanAndReplaceUpdate(MenuItem generatedMenu,
                                                      MenuItem existing)

Deprecated. : Could only replace menu items if the hierarchical structure was not changed

replaceable

protected boolean replaceable(MenuItem existingItem,
                              MenuItem replacingItem)

Checks on a criteria that one MenuItem is replaceable by another.
Params are expected to be not null.
When using more specific types of MenuItem one can override for custom logic.

Returns:

getContainer

public MenuItem getContainer()

Name of the MenuItem which is the container of this. Scan and replace the occurrence of this instance.

setContainer

public void setContainer(MenuItem container)

Name of the MenuItem which is the container of this. Scan and replace the occurrence of this instance.

getGenerator

public IMenuGenerator getGenerator()

The instance of the generator that will produce the replacement actual MenuItems

setGenerator

public void setGenerator(IMenuGenerator generator)

The instance of the generator that will produce the replacement actual MenuItems

getRefMenuMapping

public Map<String,MenuItem> getRefMenuMapping()

setRefMenuMapping

public void setRefMenuMapping(Map<String,MenuItem> refMenuMapping)

pageMenuMap (reference to Menu) mapping needs to be also auto generated if the menu is auto-gen.
Note: this map maybe shared with other AutoGenMenuItem

Can be null:

true (if null will be ignored)

getMapper

public IMenuPathMapper getMapper()

setMapper

public void setMapper(IMenuPathMapper mapper)