planetj.dataengine
Class AbstractNavigationMap

java.lang.Object
  java.util.AbstractMap
      java.util.HashMap
          planetj.dataengine.AbstractNavigationMap

All Implemented Interfaces:

java.lang.Cloneable, INavigation, java.util.Map, java.io.Serializable

Direct Known Subclasses:

NavigationGroup, NavigationPage, NavigationRequest, NavigationSession

public abstract class AbstractNavigationMap

extends java.util.HashMap

implements INavigation

See Also:

Serialized Form

Field Summary

static java.lang.String

className Class name.

Fields inherited from interface planetj.dataengine.INavigation

CHILD_PREFIX, GROUP_ATTRIBUTES, GROUP_ID, INITIAL_GROUP_ID, INITIAL_PAGE_ID, INITIAL_REQUEST_ID, NAVIGATION_CHECKED, NAVIGATION_OBJECT_LIST_PREFIX, NEW_GROUP_ID, NEW_REQUEST_ID, NEW_SESSION_ID, PAGE_ATTRIBUTES, PAGE_ID, PARENT_PREFIX, PERSISTENT_ATTRIBUTES, PREVIOUS_ATTRIBUTES, PREVIOUS_GROUP_ID, PREVIOUS_PAGE_ID, PREVIOUS_REQUEST_ID, REQUEST_ID, RESET_GROUP_ID, RESET_NAVIGATION_IDS, RESET_NAVIGATION_IDS_COMPLETED, RESET_PAGE_ID, RESET_REQUEST_ID, RESET_SESSION_ID, SESSION_ID

Constructor Summary

AbstractNavigationMap(java.lang.String id)
NavigationSession constructor comment.

Method Summary

protected void	expireChildrenAbove(int id) Set whether or not this navigation page is expired.
protected abstract java.lang.String	getChildNavigationKeyPrefix() Get the prefix for navigation maps contained within this navigation map.
java.lang.String	getId() Get this navigation map's id.
java.lang.String	getKey() Get this navigation map's id.
java.lang.String	getLastChildId() Get the id of the last navigation map added to this navigation map.
protected abstract java.lang.String	getNavigationIdKey() Get the key used to look up this navigation maps id value.
protected AbstractNavigationMap	getNext() Gets the first navigation map created after this navigation map.
protected AbstractNavigationMap	getPrevious() Gets the navigation map created before this navigation map.
protected boolean	isExpired() Check if this navigation page is expired.
AbstractNavigationMap	put(AbstractNavigationMap navMap) Adds the given navigation map to this map.
NavigationAttributes	put(NavigationAttributes attributes) Adds the given navigation attributes map to this map.
protected void	setExpired(boolean expired) Set whether or not this navigation page is expired.
protected void	setId(java.lang.String id) Sets the given String as this navigation maps id.
protected void	setNext(AbstractNavigationMap next) Sets the navigation map created after this navigation map.
protected void	setPrevious(AbstractNavigationMap previous) Sets the navigation map created before this navigation map.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

className

public static final java.lang.String className

Class name.

Constructor Detail

AbstractNavigationMap

public AbstractNavigationMap(java.lang.String id)

NavigationSession constructor comment.

Method Detail

expireChildrenAbove

protected void expireChildrenAbove(int id)

Set whether or not this navigation page is expired.

getChildNavigationKeyPrefix

protected abstract java.lang.String getChildNavigationKeyPrefix()

Get the prefix for navigation maps contained within this navigation map.

getId

public java.lang.String getId()

Get this navigation map's id.

getKey

public java.lang.String getKey()

Get this navigation map's id.

getLastChildId

public java.lang.String getLastChildId()

Get the id of the last navigation map added to this navigation map. The highest id.

getNavigationIdKey

protected abstract java.lang.String getNavigationIdKey()

Get the key used to look up this navigation maps id value.

getNext

protected AbstractNavigationMap getNext()

Gets the first navigation map created after this navigation map.

getPrevious

protected AbstractNavigationMap getPrevious()

Gets the navigation map created before this navigation map.

isExpired

protected boolean isExpired()

Check if this navigation page is expired.

put

public AbstractNavigationMap put(AbstractNavigationMap navMap)

Adds the given navigation map to this map. The map's id is used as the key.

Parameters:

navMap - navigation map to add to this navigation map

put

public NavigationAttributes put(NavigationAttributes attributes)

Adds the given navigation attributes map to this map. The attributes' type is used as the key.

Parameters:

attributes - navigation attributes map to add to this navigation map

setExpired

protected void setExpired(boolean expired)

Set whether or not this navigation page is expired.

setId

protected void setId(java.lang.String id)

Sets the given String as this navigation maps id.

setNext

protected void setNext(AbstractNavigationMap next)

Sets the navigation map created after this navigation map.

setPrevious

protected void setPrevious(AbstractNavigationMap previous)

Sets the navigation map created before this navigation map.