planetj.dataengine
Class NavigationPage

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

All Implemented Interfaces:

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

public class NavigationPage

extends AbstractNavigationMap

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

NavigationPage(int id)
NavigationPage constructor comment.

NavigationPage(java.lang.String id)
NavigationPage constructor comment.

Method Summary

protected java.lang.String	getChildNavigationKeyPrefix() Get the prefix for navigation maps contained within this navigation map.
protected java.lang.String	getNavigationIdKey() Get the key used to look up this navigation maps id value.
static java.lang.String	getNavigationKey(int id)
static java.lang.String	getNavigationKey(java.lang.String id)
void	persist(HttpServletRequest request) Persists this navigation page's attributes from the previous request.
void	restore(HttpServletRequest request) Restore all of this navigation map's attributes into the request.

Methods inherited from class planetj.dataengine.AbstractNavigationMap

expireChildrenAbove, getId, getKey, getLastChildId, getNext, getPrevious, isExpired, put, put, setExpired, setId, setNext, setPrevious

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

NavigationPage

public NavigationPage(int id)

NavigationPage constructor comment.

NavigationPage

public NavigationPage(java.lang.String id)

NavigationPage constructor comment.

Method Detail

getChildNavigationKeyPrefix

protected java.lang.String getChildNavigationKeyPrefix()

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

Specified by:

getChildNavigationKeyPrefix in class AbstractNavigationMap

getNavigationIdKey

protected final java.lang.String getNavigationIdKey()

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

Specified by:

getNavigationIdKey in class AbstractNavigationMap

getNavigationKey

public static java.lang.String getNavigationKey(int id)

getNavigationKey

public static java.lang.String getNavigationKey(java.lang.String id)

persist

public void persist(HttpServletRequest request)

Persists this navigation page's attributes from the previous request.

Parameters:

request - the HttpServletRequest object that contains the request the client made of the servlet

restore

public void restore(HttpServletRequest request)

Restore all of this navigation map's attributes into the request. A navigation page's attributes are contained in navigation attribute maps. (see NavigationAttributes)

Parameters:

request - the HttpServletRequest object that contains the request the client made of the servlet