org.apache.xerces.impl.xs.opti
Class SchemaDOMParser

java.lang.Object
  org.apache.xerces.impl.xs.opti.DefaultXMLDocumentHandler
      org.apache.xerces.impl.xs.opti.SchemaDOMParser

All Implemented Interfaces:

XMLDocumentHandler, XMLDTDContentModelHandler, XMLDTDHandler

public class SchemaDOMParser
extends DefaultXMLDocumentHandler

Version:

$Id: SchemaDOMParser.java 446728 2006-09-15 20:43:46Z mrglavas $

Author:

Rahul Srivastava, Sun Microsystems Inc., Sandy Gao, IBM

Field Summary

static java.lang.String	ERROR_REPORTER Property identifier: error reporter.
static java.lang.String	GENERATE_SYNTHETIC_ANNOTATION Feature identifier: generate synthetic annotations.

Fields inherited from interface org.apache.xerces.xni.XMLDTDHandler

CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE

Fields inherited from interface org.apache.xerces.xni.XMLDTDContentModelHandler

OCCURS_ONE_OR_MORE, OCCURS_ZERO_OR_MORE, OCCURS_ZERO_OR_ONE, SEPARATOR_CHOICE, SEPARATOR_SEQUENCE

Constructor Summary

SchemaDOMParser(XMLParserConfiguration config)
Default constructor.

Method Summary

void	characters(XMLString text, Augmentations augs) Character content.
void	comment(XMLString text, Augmentations augs) A comment.
void	emptyElement(QName element, XMLAttributes attributes, Augmentations augs) An empty element.
void	endCDATA(Augmentations augs) The end of a CDATA section.
void	endDocument(Augmentations augs) The end of the document.
void	endElement(QName element, Augmentations augs) The end of an element.
Document	getDocument() Returns the DOM document object.
Document	getDocument2() Gets the document from SchemaParsingConfig
boolean	getFeature(java.lang.String featureId) Delegates to SchemaParsingConfig.getFeature
java.lang.Object	getProperty(java.lang.String propertyId) Delegates to SchemaParsingConfig.getProperty.
void	ignorableWhitespace(XMLString text, Augmentations augs) Ignorable whitespace.
void	parse(XMLInputSource inputSource) Delegates parsing to SchemaParsingConfig
void	processingInstruction(java.lang.String target, XMLString data, Augmentations augs) A processing instruction.
void	reset() Reset SchemaParsingConfig
void	resetNodePool() ResetNodePool on SchemaParsingConfig
void	setEntityResolver(XMLEntityResolver er) Delegates to SchemaParsingConfig.setEntityResolver.
void	setFeature(java.lang.String featureId, boolean state) Delegates to SchemaParsingConfig.setFeature
void	setProperty(java.lang.String propertyId, java.lang.Object value) Delegates to SchemaParsingConfig.setProperty.
void	startCDATA(Augmentations augs) The start of a CDATA section.
void	startDocument(XMLLocator locator, java.lang.String encoding, NamespaceContext namespaceContext, Augmentations augs) The start of the document.
void	startElement(QName element, XMLAttributes attributes, Augmentations augs) The start of an element.

Methods inherited from class org.apache.xerces.impl.xs.opti.DefaultXMLDocumentHandler

any, attributeDecl, doctypeDecl, element, elementDecl, empty, endAttlist, endConditional, endContentModel, endDTD, endExternalSubset, endGeneralEntity, endGroup, endParameterEntity, endPrefixMapping, externalEntityDecl, getDocumentSource, getDTDContentModelSource, getDTDSource, ignoredCharacters, internalEntityDecl, notationDecl, occurrence, pcdata, separator, setDocumentSource, setDTDContentModelSource, setDTDSource, startAttlist, startConditional, startContentModel, startDTD, startExternalSubset, startGeneralEntity, startGroup, startParameterEntity, startPrefixMapping, textDecl, unparsedEntityDecl, xmlDecl

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_REPORTER

public static final java.lang.String ERROR_REPORTER

Property identifier: error reporter.

See Also:

Constant Field Values

GENERATE_SYNTHETIC_ANNOTATION

public static final java.lang.String GENERATE_SYNTHETIC_ANNOTATION

Feature identifier: generate synthetic annotations.

See Also:

Constant Field Values

Constructor Detail

SchemaDOMParser

public SchemaDOMParser(XMLParserConfiguration config)

Default constructor.

Method Detail

startDocument

public void startDocument(XMLLocator locator,
                          java.lang.String encoding,
                          NamespaceContext namespaceContext,
                          Augmentations augs)
                   throws XNIException

Description copied from class: DefaultXMLDocumentHandler

The start of the document.

Specified by:

startDocument in interface XMLDocumentHandler

Overrides:

startDocument in class DefaultXMLDocumentHandler

Parameters:

locator - The document locator, or null if the document location cannot be reported during the parsing of this document. However, it is strongly recommended that a locator be supplied that can at least report the system identifier of the document.

encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).

namespaceContext - The namespace context in effect at the start of this document. This object represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endDocument

public void endDocument(Augmentations augs)
                 throws XNIException

The end of the document.

Specified by:

endDocument in interface XMLDocumentHandler

Overrides:

endDocument in class DefaultXMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

comment

public void comment(XMLString text,
                    Augmentations augs)
             throws XNIException

A comment.

Specified by:

comment in interface XMLDocumentHandler

Specified by:

comment in interface XMLDTDHandler

Overrides:

comment in class DefaultXMLDocumentHandler

Parameters:

text - The text in the comment.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by application to signal an error.

processingInstruction

public void processingInstruction(java.lang.String target,
                                  XMLString data,
                                  Augmentations augs)
                           throws XNIException

A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.

Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.

Specified by:

processingInstruction in interface XMLDocumentHandler

Specified by:

processingInstruction in interface XMLDTDHandler

Overrides:

processingInstruction in class DefaultXMLDocumentHandler

Parameters:

target - The target.

data - The data or null if none specified.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

characters

public void characters(XMLString text,
                       Augmentations augs)
                throws XNIException

Character content.

Specified by:

characters in interface XMLDocumentHandler

Overrides:

characters in class DefaultXMLDocumentHandler

Parameters:

text - The content.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startElement

public void startElement(QName element,
                         XMLAttributes attributes,
                         Augmentations augs)
                  throws XNIException

The start of an element.

Specified by:

startElement in interface XMLDocumentHandler

Overrides:

startElement in class DefaultXMLDocumentHandler

Parameters:

element - The name of the element.

attributes - The element attributes.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

emptyElement

public void emptyElement(QName element,
                         XMLAttributes attributes,
                         Augmentations augs)
                  throws XNIException

An empty element.

Specified by:

emptyElement in interface XMLDocumentHandler

Overrides:

emptyElement in class DefaultXMLDocumentHandler

Parameters:

element - The name of the element.

attributes - The element attributes.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endElement

public void endElement(QName element,
                       Augmentations augs)
                throws XNIException

The end of an element.

Specified by:

endElement in interface XMLDocumentHandler

Overrides:

endElement in class DefaultXMLDocumentHandler

Parameters:

element - The name of the element.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

ignorableWhitespace

public void ignorableWhitespace(XMLString text,
                                Augmentations augs)
                         throws XNIException

Ignorable whitespace. For this method to be called, the document source must have some way of determining that the text containing only whitespace characters should be considered ignorable. For example, the validator can determine if a length of whitespace characters in the document are ignorable based on the element content model.

Specified by:

ignorableWhitespace in interface XMLDocumentHandler

Overrides:

ignorableWhitespace in class DefaultXMLDocumentHandler

Parameters:

text - The ignorable whitespace.

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

startCDATA

public void startCDATA(Augmentations augs)
                throws XNIException

The start of a CDATA section.

Specified by:

startCDATA in interface XMLDocumentHandler

Overrides:

startCDATA in class DefaultXMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

endCDATA

public void endCDATA(Augmentations augs)
              throws XNIException

The end of a CDATA section.

Specified by:

endCDATA in interface XMLDocumentHandler

Overrides:

endCDATA in class DefaultXMLDocumentHandler

Parameters:

augs - Additional information that may include infoset augmentations

Throws:

XNIException - Thrown by handler to signal an error.

getDocument

public Document getDocument()

Returns the DOM document object.

setFeature

public void setFeature(java.lang.String featureId,
                       boolean state)

Delegates to SchemaParsingConfig.setFeature

Parameters:

featureId -

state -

getFeature

public boolean getFeature(java.lang.String featureId)

Delegates to SchemaParsingConfig.getFeature

Parameters:

featureId -

Returns:

boolean

setProperty

public void setProperty(java.lang.String propertyId,
                        java.lang.Object value)

Delegates to SchemaParsingConfig.setProperty.

Parameters:

propertyId -

value -

getProperty

public java.lang.Object getProperty(java.lang.String propertyId)

Delegates to SchemaParsingConfig.getProperty.

Parameters:

propertyId -

Returns:

Object

setEntityResolver

public void setEntityResolver(XMLEntityResolver er)

Delegates to SchemaParsingConfig.setEntityResolver.

Parameters:

er - XMLEntityResolver

parse

public void parse(XMLInputSource inputSource)
           throws java.io.IOException

Delegates parsing to SchemaParsingConfig

Parameters:

inputSource -

Throws:

java.io.IOException

getDocument2

public Document getDocument2()

Gets the document from SchemaParsingConfig

Returns:

Document

reset

public void reset()

Reset SchemaParsingConfig

resetNodePool

public void resetNodePool()

ResetNodePool on SchemaParsingConfig