Package com.webmethods.caf.faces.bean.nav.xml

Class XMLAppNavBuilder

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.webmethods.caf.faces.bean.nav.xml.XMLAppNavBuilder

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class XMLAppNavBuilder
extends DefaultHandler

SAX parser handler which builds an IAppNavPage hierarchy from a sequence of SAX events.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CHARACTER_ENCODING	Default character encoding used by the parser.
static final String	ELEMENT_APP_NAV
static final String	ELEMENT_ID
static final String	ELEMENT_PAGE
static final String	ELEMENT_RESOURCE_BUNDLE
static final String	ELEMENT_RESOURCE_KEY
static final String	ELEMENT_TITLE
static final String	ELEMENT_URL
protected StringBuilder	m_buf	Buffer to keep values while parsing.
protected FacesContext	m_ctx	The context.
protected Class<?>	m_pageClass	Class name of the page, this must be a sub-class of XMLAppNavPage.
protected String	m_resourceBundle	Resource bundle location.
protected XMLAppNavPage	m_root	Root page of the navigation hierarchy.
protected Stack<XMLAppNavPage>	m_stack	Stack of XMLAppNavPages used while building the hierarchy.

Constructor Summary

Constructors

Constructor	Description
XMLAppNavBuilder(FacesContext ctx)	Constructor.
XMLAppNavBuilder(FacesContext ctx, String pageClass)	Constructor with page Class.

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)	(non-Javadoc)
void	endDocument()	(non-Javadoc)
void	endElement(String uri, String localName, String qName)	(non-Javadoc)
void	error(SAXParseException e)	(non-Javadoc)
void	fatalError(SAXParseException e)	(non-Javadoc)
IAppNavPage	getRoot()	Gets the current IAppNavPage hierarchy root.
InputSource	resolveEntity(String publicId, String systemId)	(non-Javadoc)
void	startDocument()	(non-Javadoc)
void	startElement(String uri, String localName, String qName, Attributes attributes)	(non-Javadoc)
void	warning(SAXParseException e)	(non-Javadoc)

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

endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Field Details

ELEMENT_APP_NAV

public static final String ELEMENT_APP_NAV

See Also:

• Constant Field Values

ELEMENT_ID

public static final String ELEMENT_ID

See Also:

• Constant Field Values

ELEMENT_PAGE

public static final String ELEMENT_PAGE

See Also:

• Constant Field Values

ELEMENT_RESOURCE_BUNDLE

public static final String ELEMENT_RESOURCE_BUNDLE

See Also:

• Constant Field Values

ELEMENT_RESOURCE_KEY

public static final String ELEMENT_RESOURCE_KEY

See Also:

• Constant Field Values

ELEMENT_TITLE

public static final String ELEMENT_TITLE

See Also:

• Constant Field Values

ELEMENT_URL

public static final String ELEMENT_URL

See Also:

• Constant Field Values

DEFAULT_CHARACTER_ENCODING

public static final String DEFAULT_CHARACTER_ENCODING

Default character encoding used by the parser.

See Also:

• Constant Field Values

m_buf

protected StringBuilder m_buf

Buffer to keep values while parsing.

m_ctx

protected FacesContext m_ctx

The context.

m_pageClass

protected Class<?> m_pageClass

Class name of the page, this must be a sub-class of XMLAppNavPage.

m_resourceBundle

protected String m_resourceBundle

Resource bundle location.

m_root

protected XMLAppNavPage m_root

Root page of the navigation hierarchy.

m_stack

protected Stack<XMLAppNavPage> m_stack

Stack of XMLAppNavPages used while building the hierarchy.

Constructor Details

XMLAppNavBuilder

public XMLAppNavBuilder(FacesContext ctx)

Constructor.

Parameters:

ctx - FacesContext

XMLAppNavBuilder

public XMLAppNavBuilder(FacesContext ctx,
 String pageClass)

Constructor with page Class.

Parameters:

ctx - FacesContext

pageClass - Class name of the page, this must be a sub-class of XMLAppNavPage.

Method Details

resolveEntity

public InputSource resolveEntity(String publicId,
 String systemId)
                          throws SAXException,
IOException

(non-Javadoc)

Specified by:

resolveEntity in interface EntityResolver

Overrides:

resolveEntity in class DefaultHandler

Throws:

SAXException

IOException

See Also:

• DefaultHandler.resolveEntity(java.lang.String, java.lang.String)

startDocument

public void startDocument()
                   throws SAXException

(non-Javadoc)

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

See Also:

• DefaultHandler.startDocument()

endDocument

public void endDocument()
                 throws SAXException

(non-Javadoc)

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

See Also:

• DefaultHandler.endDocument()

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attributes)
                  throws SAXException

(non-Javadoc)

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

See Also:

• DefaultHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(String uri,
 String localName,
 String qName)
                throws SAXException

(non-Javadoc)

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

See Also:

• DefaultHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

(non-Javadoc)

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

See Also:

• DefaultHandler.characters(char[], int, int)

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

(non-Javadoc)

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Throws:

SAXException

See Also:

• DefaultHandler.fatalError(org.xml.sax.SAXParseException)

error

public void error(SAXParseException e)
           throws SAXException

(non-Javadoc)

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Throws:

SAXException

See Also:

• DefaultHandler.error(org.xml.sax.SAXParseException)

warning

public void warning(SAXParseException e)
             throws SAXException

(non-Javadoc)

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Throws:

SAXException

See Also:

• DefaultHandler.warning(org.xml.sax.SAXParseException)

getRoot

public IAppNavPage getRoot()

Gets the current IAppNavPage hierarchy root.