org.apache.myfaces.trinidadinternal.menu
Class MenuContentHandlerUsingApiImpl

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      org.apache.myfaces.trinidadinternal.menu.MenuContentHandlerUsingApiImpl

All Implemented Interfaces:

java.io.Serializable, org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class MenuContentHandlerUsingApiImpl
extends org.xml.sax.helpers.DefaultHandler
implements org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler, java.io.Serializable

Handler called by the SAXParser when parsing menu metadata as part of the XML Menu Model of Trinidad Faces.

This is called through the Services API (See XMLMenuModel.java) to keep the separation between API's and internal modules.

startElement() and endElement() are called as one would expect, at the start of parsing an element in the menu metadata file and at the end of parsing an element in the menu metadata file. The menu model is created as a List of itemNodes and groupNodes which is available to and used by the XMLMenuModel to create the TreeModel and internal Maps.

See Also:

Serialized Form

Constructor Summary

MenuContentHandlerUsingApiImpl()
Constructs a Menu Content Handler.

Method Summary

void	endDocument() Called by the SAX Parser at the end of parsing a document.
void	endElement(java.lang.String nameSpaceUri, java.lang.String localElemName, java.lang.String qualifiedElemName) Processing done at the end of parsing a node enty element from the menu metadata file.
int	getId()
java.util.Map<java.lang.String,java.lang.Object>	getIdNodeMap(java.lang.Object modelKey) Get the Model's idNodeMap
org.apache.myfaces.trinidad.model.XMLMenuModel	getModel() Get the local (sharedNode) menu model.
java.lang.String	getModelId() Get the local (sharedNode) menu model's Uri.
java.util.Map<java.lang.Object,java.util.List<java.lang.Object>>	getNodeFocusPathMap(java.lang.Object modelKey) Get the Model's nodeFocusPathMap
org.apache.myfaces.trinidad.model.XMLMenuModel	getRootModel() Get the top-level, root menu model, which contains the entire menu tree.
java.lang.String	getRootModelKey() Get the top-level, root menu model's Request Map Key.
org.apache.myfaces.trinidad.model.TreeModel	getTreeModel(java.lang.String uri) Get the treeModel built during parsing
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	getViewIdFocusPathMap(java.lang.Object modelKey) Get the Model's viewIdFocusPathMap
void	setId(int id) sets the id of this content handler No synchronization necessary,let the first thread set the id, the rest of the threads will immediately see the new value and will not try to set again.
void	setModelId(java.lang.String localModelId) Sets the local (sharedNode's) menu Model's System Id.
void	setRootHandler(boolean isRoot)
void	setRootModelKey(java.lang.String rootModelKey) Sets the root menu Model's Request map key.
void	setTreeModelKey(java.lang.String uri) Sets the treeModel map key used to get a cached treeModel from the MenuContentHandlerUsingApiImpl.
void	startDocument() Called by the SAX Parser at the start of parsing a document.
void	startElement(java.lang.String nameSpaceUri, java.lang.String localElemName, java.lang.String qualifiedElemName, org.xml.sax.Attributes attrList) Start the parsing of an node element entry in the menu metadata file.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

MenuContentHandlerUsingApiImpl

public MenuContentHandlerUsingApiImpl()

Constructs a Menu Content Handler.

Method Detail

startDocument

public void startDocument()

Called by the SAX Parser at the start of parsing a document.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

startElement

public void startElement(java.lang.String nameSpaceUri,
                         java.lang.String localElemName,
                         java.lang.String qualifiedElemName,
                         org.xml.sax.Attributes attrList)
                  throws org.xml.sax.SAXException

Start the parsing of an node element entry in the menu metadata file.

If the entry is for an itemNode or a destinationNode, create the node and it to the List. If the entry is for a sharedNode, a new submenu model is created.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Parameters:

nameSpaceUri - - only used when passed to super class.

localElemName - - only used when passed to super class.

qualifiedElemName - - String designating the node type of the entry.

attrList - - List of attributes in the menudata entry.

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String nameSpaceUri,
                       java.lang.String localElemName,
                       java.lang.String qualifiedElemName)

Processing done at the end of parsing a node enty element from the menu metadata file. This manages the node depth properly so that method startElement works correctly to build the List.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Parameters:

nameSpaceUri - - not used.

localElemName - - not used.

qualifiedElemName - - String designating the node type of the entry.

endDocument

public void endDocument()

Called by the SAX Parser at the end of parsing a document. Here, the menuList is put on the menuList map.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

getViewIdFocusPathMap

public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getViewIdFocusPathMap(java.lang.Object modelKey)

Get the Model's viewIdFocusPathMap

Specified by:

getViewIdFocusPathMap in interface org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler

Returns:

the Model's viewIdFocusPathMap

getNodeFocusPathMap

public java.util.Map<java.lang.Object,java.util.List<java.lang.Object>> getNodeFocusPathMap(java.lang.Object modelKey)

Get the Model's nodeFocusPathMap

Specified by:

getNodeFocusPathMap in interface org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler

Returns:

the Model's nodeFocusPathMap

getIdNodeMap

public java.util.Map<java.lang.String,java.lang.Object> getIdNodeMap(java.lang.Object modelKey)

Get the Model's idNodeMap

Specified by:

getIdNodeMap in interface org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler

Returns:

the Model's idNodeMap

getTreeModel

public org.apache.myfaces.trinidad.model.TreeModel getTreeModel(java.lang.String uri)

Get the treeModel built during parsing

Specified by:

getTreeModel in interface org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler

Returns:

List of menu nodes.

getRootModel

public org.apache.myfaces.trinidad.model.XMLMenuModel getRootModel()

Get the top-level, root menu model, which contains the entire menu tree.

Returns:

root, top-level XMLMenuModel

getRootModelKey

public java.lang.String getRootModelKey()

Get the top-level, root menu model's Request Map Key.

Returns:

root, top-level XMLMenuModel's Request Map Key.

setRootModelKey

public void setRootModelKey(java.lang.String rootModelKey)

Sets the root menu Model's Request map key.

This is always only the top-level, root model's Request map key. We do this because the MenuContentHandlerUsingApiImpl and nodes need to be able to call into the root model to:

• notify them root menu model of the currently selected node on a POST
• group node needs to find its referenced item node.

Specified by:

setRootModelKey in interface org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler

Parameters:

rootModelKey - - String the root, top-level menu model's Request map key.

getModel

public org.apache.myfaces.trinidad.model.XMLMenuModel getModel()

Get the local (sharedNode) menu model.

Returns:

sharedNode's XMLMenuModel

getModelId

public java.lang.String getModelId()

Get the local (sharedNode) menu model's Uri.

Returns:

sharedNode's XMLMenuModel Uri

setModelId

public void setModelId(java.lang.String localModelId)

Sets the local (sharedNode's) menu Model's System Id.

Specified by:

setModelId in interface org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler

Parameters:

localModelId - - String the root, top-level menu model's Uri.

setTreeModelKey

public void setTreeModelKey(java.lang.String uri)

Sets the treeModel map key used to get a cached treeModel from the MenuContentHandlerUsingApiImpl. Note: this is set from the XMLMenuModel BEFORE parsing begins

Parameters:

uri - String path to the menu model's metadata

setRootHandler

public void setRootHandler(boolean isRoot)

Specified by:

setRootHandler in interface org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler

setId

public void setId(int id)

sets the id of this content handler No synchronization necessary,let the first thread set the id, the rest of the threads will immediately see the new value and will not try to set again.

Specified by:

setId in interface org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler

getId

public int getId()

Specified by:

getId in interface org.apache.myfaces.trinidad.model.XMLMenuModel.MenuContentHandler