org.openxml.parser

Class XMLSAXParser

java.lang.Object

org.openxml.parser.StreamParser

org.openxml.parser.ContentParser

org.openxml.parser.XMLSAXParser

All Implemented Interfaces:

EntityResolver, Locator, Parser

public final class XMLSAXParser
extends ContentParser
implements Parser

Field Summary

Fields inherited from class org.openxml.parser.ContentParser

_docType, _documentHandler, _dtdHandler, _entityResolver, _nodeText

Fields inherited from class org.openxml.parser.StreamParser

_curChar, _tokenText, CR, EOF, LF, SPACE, TOKEN_CDATA, TOKEN_CLOSE_TAG, TOKEN_COMMENT, TOKEN_DTD, TOKEN_ENTITY_REF, TOKEN_EOF, TOKEN_OPEN_TAG, TOKEN_PE_REF, TOKEN_PI, TOKEN_SECTION, TOKEN_SECTION_END, TOKEN_TEXT, VALIDITY, WELL_FORMED

Constructor Summary

Constructors

Constructor and Description
XMLSAXParser()

Method Summary

Modifier and Type	Method and Description
protected void	init(InputSource input) Initializes the parser to parse a new document.
protected boolean	isHtml()
void	parse(InputSource input)
protected boolean	parseDocumentDecl(boolean XMLDecl) Parses the document declaration for XML documents and external entities, returning the standalone status and changing the character encoding (if necessary).
protected void	parseDTDSubset(boolean standalone) Parser the external DTD subset.
protected boolean	parseNextNode(int token) Parses the next node based on the supplied token.
protected int	readTokenEntity() Reads general entity reference token or character reference.
protected int	readTokenEntity(boolean ignoreError)
protected int	readTokenMarkup() Reads markup token.
protected int	readTokenPERef() Reads parameter entity reference token.
protected String	slicePITokenText() Slices processing instruction text into target and instruction code.

Methods inherited from class org.openxml.parser.ContentParser

enterElementState, getElementState, getPreviousState, isTokenSpace, leaveElementState, parse, parseAttrEntity, parseAttributes, parseContentEntity, parseGeneralEntity, readTokenContent, resolveEntity, setDocumentHandler, setDTDHandler, setEntityResolver

Methods inherited from class org.openxml.parser.StreamParser

canReadName, close, error, fatalError, format, format, format, getColumnNumber, getErrorHandler, getLastException, getLineNumber, getPublicId, getReader, getSystemId, isClosed, isNamePart, isNamePartFirst, isSpace, isTokenAllSpace, isWarning, message, pushBack, pushBack, pushBack, pushBackToken, readChar, readTokenName, readTokenNameCur, readTokenQuoted, setEncoding, setErrorHandler, setLocale, skipSpace, warning

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.Parser

parse, setDocumentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setLocale

Constructor Detail

XMLSAXParser

public XMLSAXParser()

Method Detail

init

protected void init(InputSource input)
             throws SAXException,
                    IOException

Initializes the parser to parse a new document. Must be called before any parsing occurs. See StreamParser.init(org.xml.sax.InputSource).

Overrides:

init in class ContentParser

Parameters:

input - The input source to parse

Throws:

SAXException - The input source cannot be used

IOException - An error occurs accessing the input stream

parse

public void parse(InputSource input)
           throws SAXException,
                  IOException

Specified by:

parse in interface Parser

Throws:

SAXException

IOException

isHtml

protected boolean isHtml()

Specified by:

isHtml in class ContentParser

parseDTDSubset

protected final void parseDTDSubset(boolean standalone)
                             throws SAXException

Parser the external DTD subset.

Throws:

SAXException

parseNextNode

protected boolean parseNextNode(int token)
                         throws SAXException

Parses the next node based on the supplied token.

The return value indicates if the root element has been closed with a closing tag or reached end of file (false), or should parsing continue (true).

Parameters:

token - The last token read with ContentParser.readTokenContent()

Returns:

True if continue parsing, false if current element has been closed or reached end of file

Throws:

SAXException - A parsing error has been encountered, and based on it severity, an exception is thrown to terminate parsing

See Also:

ContentParser.parseAttributes(java.lang.String), ContentParser.readTokenContent()

readTokenMarkup

protected final int readTokenMarkup()
                             throws SAXException

Reads markup token. Returns the token code and the token value in StreamParser._tokenText. The preceding '<' has been consumed prior to calling this method. No valid character is held in StreamParser._curChar on entry or exit.

The following rules govern how tokens are parsed and which code is returned:

• StreamParser.TOKEN_OPEN_TAG returned for opening tag. Opening tag is '<' immediately followed by valid tag name (returned as token text) and optional whitespace. Attributes and terminating '>' are not read by this method. A whitespace between the '<' and tag name is reported as an error; an empty tag name will never be returned.
  
• StreamParser.TOKEN_CLOSE_TAG returned for closing tag. Closing tag is '</' followed by valid tag name (returned as token text) and '>'. All text following the tag name until the terminating '>' is ignored; a whitespace between the '<' and tag name is reported as an error; an empty tag name will never be returned.
  
• StreamParser.TOKEN_COMMENT returned for comment. Comment is terminated with '<!--' and '-->'. All text inbetween is consumed, and returned as token text.
  
• StreamParser.TOKEN_CDATA returned for CDATA section. Section starts with '<![CDATA[' and ends with ']]>'. All text inbetween is consumed and returned as token text.
  
• StreamParser.TOKEN_PI returned for processing instruction. Processing instruction is terminated with '<?' and '?>'. All text inbetween is consumed, and returned as token text.
  
• StreamParser.TOKEN_DTD returned for DTD declaration. DTD declaration starts with '<!' immediately followed by a token name (returned as token text). All other declaration contents is not read by this method. A whitespace between the '<!' and the token name is not allowed; an empty declaration name is never returned.
  
• StreamParser.TOKEN_SECTION returned for DTD conditional section. Conditional section begins with '<![' and is not a CDATA section. Only the '<![' sequence is read and consumed by this method.

If no markup is found, the token code StreamParser.TOKEN_TEXT is returned, with '<' contained in StreamParser._tokenText and the input stream is not affected. An error is reported.

Returns:

The markup token code of StreamParser.TOKEN_TEXT

Throws:

SAXException - A parsing error has been encountered

readTokenEntity

protected final int readTokenEntity()
                             throws SAXException

Reads general entity reference token or character reference. Returns the token code StreamParser.TOKEN_ENTITY_REF and the entity name in StreamParser._tokenText. The preceding '&' has been consumed prior to calling this method, and the trailing ';' is consumed by this method. No valid character is held in StreamParser._curChar on entry or exit.

If no valid entity name is found, the token code StreamParser.TOKEN_TEXT is returned, with '&' contained in StreamParser._tokenText and the input stream is not affected.

A '#' sign indicates a character reference (either decimal or hexadecimal) which is read and stored in StreamParser._tokenText, and the token code StreamParser.TOKEN_TEXT is returned. If the character reference value is invalid, the token code StreamParser.TOKEN_TEXT is returned, with the invalid part contained in StreamParser._tokenText and the input stream is not affected.

If the entity reference or character reference is not terminated with a ';', a well-formed error is issued, and the name is returned as textual string instead of an entity reference.

Returns:

Token code either StreamParser.TOKEN_ENTITY_REF or StreamParser.TOKEN_TEXT

Throws:

SAXException - A parsing error has been encountered

readTokenEntity

protected final int readTokenEntity(boolean ignoreError)
                             throws SAXException

Throws:

SAXException

parseDocumentDecl

protected final boolean parseDocumentDecl(boolean XMLDecl)
                                   throws SAXException

Parses the document declaration for XML documents and external entities, returning the standalone status and changing the character encoding (if necessary). Errors are issued if the document declaration is invalid.

The document declaration is contained in a processing instruction that appears at the very beginning of the document or entity and begins with 'xml' (case sensitive). The processing instruction's full text is expected in the variable StreamParser._tokenText on entry.

The declaration for XML documents contains a version number, optional character encoding and optional standalone status. The default standalone status is false. The declaration for external entities and external subsets contains an optional version number, and mandatory character encoding.

Currently only XML version "1.0" is supported. The current character encoding is changed by calling StreamParser.setEncoding(java.lang.String).

Parameters:

XMLDecl - True if expecting XML document declaration, false if expecting external entity/subset declaration

Returns:

True if XML document is standalone

Throws:

SAXException - A parsing error has been encountered

slicePITokenText

protected final String slicePITokenText()
                                 throws SAXException

Slices processing instruction text into target and instruction code. Called with the processing instruction text in StreamParser._tokenText, returning the valid target name, and StreamParser._tokenText truncated to contain just the instruction code. If no valid target name is found, an empty name amd empty instruction are returned. StreamParser._curChar is undetermined on entry and exit and is used inside function.

Returns:

The target name

Throws:

SAXException - A parsing error has been encountered

readTokenPERef

protected final int readTokenPERef()
                            throws SAXException,
                                   IOException

Reads parameter entity reference token. Returns the token code StreamParser.TOKEN_PE_REF and the entity name in StreamParser._tokenText. The preceding '%' has been consumed prior to calling this method, and the trailing ';' is consumed by this method. No valid character is held in StreamParser._curChar on entry or exit.

If no valid entity name is found, the token code StreamParser.TOKEN_TEXT is returned, with '%' contained in StreamParser._tokenText and the input stream is not affected.

If the entity reference is not terminated with a ';', a well-formed error is issued, but the entity reference is still regarded valid.

Returns:

Token code either StreamParser.TOKEN_PE_REF or StreamParser.TOKEN_TEXT

Throws:

SAXException - A parsing error has been encountered, and based on it severity, an exception is thrown to terminate parsing

IOException - An I/O exception has been encountered when reading from the input stream