Overview  Package   Class  Use  Deprecated  Index
Home >> All >> info >> crossbar >> [ state overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

info.crossbar.state
Class Sitemap  

java.lang.Object
  CachedRowSet
      info.crossbar.state.CrossbarBaseBean
          info.crossbar.state.Sitemap

All Implemented Interfaces:

javax.servlet.jsp.jstl.sql.Result

---

public class Sitemap

extends CrossbarBaseBean

Sitemap class for use by Crossbar

Version:

View source, revision history $Revision: 1.2 $ $Date: 2003/06/04 04:55:32 $

DESCRIPTION: Delineates a web site's structure for rendering by a navigation menu tag.

---

Field Summary
private static java.util.HashMap	categories           A look-up dictionary of menu categories
private static java.util.logging.Logger	log           Set up logging.
private static java.util.HashMap	menuItems           A look-up dictionary of menu items (pages and locations)
private  java.lang.String	menuName           By default, construct a menu defined by the "navigation" name in the sitemap.xml file.
private static java.util.HashMap	menus           A look-up dictionary of menus.
private  javax.servlet.http.HttpServletRequest	request           By default, the HttpServletRequest will be null and the user will not be allowed to see any menu items meant for users in a specific role.

 

Fields inherited from class info.crossbar.state.CrossbarBaseBean

foo, tableID

 

Constructor Summary

Sitemap()           No argument Constructor.

Sitemap(javax.servlet.http.HttpServletRequest requestIn)           Alternative Constructor takes HttpServletRequest as an argument to determine which menu items the user is in a role to see.

Sitemap(java.lang.String menuNameIn)           Alternative Constructor to construct a menu other than the default "navigation" menu defined in the sitemap.xml file.

Sitemap(java.lang.String menuNameIn, javax.servlet.http.HttpServletRequest requestIn)           Alternative Constructor to construct a menu other than the default "navigation" menu defined in the sitemap.xml file.

 

Method Summary
void	addMenu(info.crossbar.model.sitemap.Menu item)           Invoked by the Digester.
void	addMenuCategory(info.crossbar.model.sitemap.MenuCategory item)           Invoked by the Digester.
void	addMenuItem(info.crossbar.model.sitemap.MenuItem item)           Invoked by the Digester.
protected  java.util.ArrayList	getCategoriesForMenu(java.lang.String menuName)
java.lang.String	getDescriptionOfMenuItem(java.lang.String locale, java.lang.String itemName)
java.lang.String	getDisplayNameOfCategory(java.lang.String locale, java.lang.String categoryName)
java.lang.String	getDisplayNameOfMenuItem(java.lang.String locale, java.lang.String itemName)
protected  java.util.ArrayList	getItemsForCategory(java.lang.String category)
java.lang.String	getLocationOfMenuCategory(java.lang.String categoryName)
java.lang.String	getLocationOfMenuItem(java.lang.String itemName)
void	init()           Obtain data somewhere and create a CachedRowSet.
void	readXML()           Parse the sitemap.xml file to obtain data to drive a navigation menu.

 

Methods inherited from class info.crossbar.state.CrossbarBaseBean

add, error, getColumnNames, getFoo, getRowCount, getRows, getRowsByIndex, getRowset, init, isLimitedByMaxRows, remove, setFoo, update

 

Methods inherited from class java.lang.Object

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

 

Field Detail

log

private static java.util.logging.Logger log

Set up logging.

---

menus

private static java.util.HashMap menus

A look-up dictionary of menus.

---

categories

private static java.util.HashMap categories

A look-up dictionary of menu categories

---

menuItems

private static java.util.HashMap menuItems

A look-up dictionary of menu items (pages and locations)

---

menuName

private java.lang.String menuName

By default, construct a menu defined by the "navigation" name in the sitemap.xml file.

---

request

private javax.servlet.http.HttpServletRequest request

By default, the HttpServletRequest will be null and the user will not be allowed to see any menu items meant for users in a specific role.

Constructor Detail

Sitemap

public Sitemap()
        throws java.sql.SQLException

No argument Constructor.

---

Sitemap

public Sitemap(java.lang.String menuNameIn)
        throws java.sql.SQLException

Alternative Constructor to construct a menu other than the default "navigation" menu defined in the sitemap.xml file.

---

Sitemap

public Sitemap(javax.servlet.http.HttpServletRequest requestIn)
        throws java.sql.SQLException

Alternative Constructor takes HttpServletRequest as an argument to determine which menu items the user is in a role to see.

---

Sitemap

public Sitemap(java.lang.String menuNameIn,
               javax.servlet.http.HttpServletRequest requestIn)
        throws java.sql.SQLException

Alternative Constructor to construct a menu other than the default "navigation" menu defined in the sitemap.xml file. Takes HttpServletRequest as an argument to determine which menu items the user is in a role to see.

Method Detail

init

public void init()

Obtain data somewhere and create a CachedRowSet.

---

getCategoriesForMenu

protected java.util.ArrayList getCategoriesForMenu(java.lang.String menuName)

---

getDisplayNameOfCategory

public java.lang.String getDisplayNameOfCategory(java.lang.String locale,
                                                 java.lang.String categoryName)

---

getLocationOfMenuCategory

public java.lang.String getLocationOfMenuCategory(java.lang.String categoryName)

---

getItemsForCategory

protected java.util.ArrayList getItemsForCategory(java.lang.String category)

---

getDisplayNameOfMenuItem

public java.lang.String getDisplayNameOfMenuItem(java.lang.String locale,
                                                 java.lang.String itemName)

---

getLocationOfMenuItem

public java.lang.String getLocationOfMenuItem(java.lang.String itemName)

---

getDescriptionOfMenuItem

public java.lang.String getDescriptionOfMenuItem(java.lang.String locale,
                                                 java.lang.String itemName)

---

readXML

public void readXML()

Parse the sitemap.xml file to obtain data to drive a navigation menu.

---

addMenu

public void addMenu(info.crossbar.model.sitemap.Menu item)

Invoked by the Digester.

---

addMenuCategory

public void addMenuCategory(info.crossbar.model.sitemap.MenuCategory item)

Invoked by the Digester.

---

addMenuItem

public void addMenuItem(info.crossbar.model.sitemap.MenuItem item)

Invoked by the Digester.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> info >> crossbar >> [ state overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---