org.apache.xerces.parsers

Class DOMParserImpl

Implemented Interfaces:
DOMConfiguration, LSParser, org.apache.xerces.xni.XMLDocumentHandler, org.apache.xerces.xni.XMLDTDContentModelHandler, org.apache.xerces.xni.XMLDTDHandler
Known Direct Subclasses:
DOMASBuilderImpl

public class DOMParserImpl
extends AbstractDOMParser
implements LSParser, DOMConfiguration

This is Xerces DOM Builder class. It uses the abstract DOM parser with a document scanner, a dtd scanner, and a validator, as well as a grammar pool.
Version:
$Id: DOMParserImpl.java,v 1.35 2005/07/25 04:24:21 mrglavas Exp $
Authors:
Pavani Mukthipudi, Sun Microsystems Inc.
Elena Litani, IBM
Rahul Srivastava, Sun Microsystems Inc.

Field Summary

protected static boolean
DEBUG
protected static String
DISALLOW_DOCTYPE_DECL_FEATURE
Feature identifier: disallow docType Decls.
protected static String
DYNAMIC_VALIDATION
Dynamic validation
protected static String
NAMESPACES
Feature identifier: namespaces.
protected static String
NORMALIZE_DATA
Feature identifier: expose schema normalized value
protected static String
PSVI_AUGMENT
protected static String
SYMBOL_TABLE
protected static String
VALIDATION_FEATURE
Feature id: validation.
protected static String
XMLSCHEMA
XML Schema validation
protected static String
XMLSCHEMA_FULL_CHECKING
XML Schema full checking
protected boolean
fBusy
protected boolean
fNamespaceDeclarations
Include namespace declaration attributes in the document.
protected String
fSchemaType

Fields inherited from class org.apache.xerces.parsers.AbstractDOMParser

CORE_DOCUMENT_CLASS_NAME, CREATE_CDATA_NODES_FEATURE, CREATE_ENTITY_REF_NODES, CURRENT_ELEMENT_NODE, DEFAULT_DOCUMENT_CLASS_NAME, DEFER_NODE_EXPANSION, DOCUMENT_CLASS_NAME, INCLUDE_COMMENTS_FEATURE, INCLUDE_IGNORABLE_WHITESPACE, NAMESPACES, PSVI_DOCUMENT_CLASS_NAME, abort, fBaseURIStack, fCreateCDATANodes, fCreateEntityRefNodes, fCurrentCDATASection, fCurrentCDATASectionIndex, fCurrentEntityDecl, fCurrentNode, fCurrentNodeIndex, fDOMFilter, fDeferNodeExpansion, fDeferredDocumentImpl, fDeferredEntityDecl, fDocument, fDocumentClassName, fDocumentImpl, fDocumentIndex, fDocumentType, fDocumentTypeIndex, fErrorHandler, fFilterReject, fFirstChunk, fInCDATASection, fInDTD, fInDTDExternalSubset, fInEntityRef, fIncludeComments, fIncludeIgnorableWhitespace, fInternalSubset, fNamespaceAware, fRejectedElement, fRoot, fSkippedElemStack, fStorePSVI, fStringBuffer

Fields inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser

fDTDContentModelSource, fDTDSource, fDocumentSource, fInDTD

Fields inherited from class org.apache.xerces.parsers.XMLParser

ENTITY_RESOLVER, ERROR_HANDLER, fConfiguration

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

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

CONDITIONAL_IGNORE, CONDITIONAL_INCLUDE

Constructor Summary

DOMParserImpl(String configuration, String schemaType)
Constructs a DOM Builder using the standard parser configuration.
DOMParserImpl(SymbolTable symbolTable)
Constructs a DOM Builder using the specified symbol table.
DOMParserImpl(SymbolTable symbolTable, org.apache.xerces.xni.grammars.XMLGrammarPool grammarPool)
Constructs a DOM Builder using the specified symbol table and grammar pool.
DOMParserImpl(org.apache.xerces.xni.parser.XMLParserConfiguration config)
Constructs a DOM Builder using the specified parser configuration.

Method Summary

void
abort()
boolean
canSetParameter(String name, Object value)
boolean
getAsync()
boolean
getBusy()
DOMConfiguration
getDomConfig()
LSParserFilter
getFilter()
When the application provides a filter, the parser will call out to the filter at the completion of the construction of each Element node.
Object
getParameter(String name)
Look up the value of a feature or a property.
DOMStringList
getParameterNames()
DOM Level 3 CR - Experimental.
Document
parse(LSInput is)
Parse an XML document from a resource identified by an LSInput.
Document
parseURI(String uri)
Parse an XML document from a location identified by an URI reference.
Node
parseWithContext(LSInput is, Node cnode, short action)
Parse an XML document or fragment from a resource identified by an LSInput and insert the content into an existing document at the position epcified with the contextNode and action arguments.
void
reset()
Resets the parser state.
void
setFilter(LSParserFilter filter)
When the application provides a filter, the parser will call out to the filter at the completion of the construction of each Element node.
void
setParameter(String name, Object value)
Set parameters and properties
void
startElement(org.apache.xerces.xni.QName element, org.apache.xerces.xni.XMLAttributes attributes, org.apache.xerces.xni.Augmentations augs)
The start of an element.

Methods inherited from class org.apache.xerces.parsers.AbstractDOMParser

abort, attributeDecl, characters, comment, createAttrNode, createElementNode, doctypeDecl, elementDecl, emptyElement, endAttlist, endCDATA, endConditional, endDTD, endDocument, endElement, endExternalSubset, endGeneralEntity, endParameterEntity, externalEntityDecl, getDocument, getDocumentClassName, handleBaseURI, handleBaseURI, ignorableWhitespace, ignoredCharacters, internalEntityDecl, notationDecl, processingInstruction, reset, setCharacterData, setDocumentClassName, setLocale, startAttlist, startCDATA, startConditional, startDTD, startDocument, startElement, startExternalSubset, startGeneralEntity, startParameterEntity, textDecl, unparsedEntityDecl, xmlDecl

Methods inherited from class org.apache.xerces.parsers.AbstractXMLDocumentParser

any, attributeDecl, characters, comment, doctypeDecl, element, elementDecl, empty, emptyElement, endAttlist, endCDATA, endConditional, endContentModel, endDTD, endDocument, endElement, endExternalSubset, endGeneralEntity, endGroup, endParameterEntity, externalEntityDecl, getDTDContentModelSource, getDTDSource, getDocumentSource, ignorableWhitespace, ignoredCharacters, internalEntityDecl, notationDecl, occurrence, pcdata, processingInstruction, reset, separator, setDTDContentModelSource, setDTDSource, setDocumentSource, startAttlist, startCDATA, startConditional, startContentModel, startDTD, startDocument, startElement, startExternalSubset, startGeneralEntity, startGroup, startParameterEntity, textDecl, unparsedEntityDecl, xmlDecl

Methods inherited from class org.apache.xerces.parsers.XMLParser

parse, reset

Field Details

DEBUG

protected static final boolean DEBUG
Field Value:
false

DISALLOW_DOCTYPE_DECL_FEATURE

protected static final String DISALLOW_DOCTYPE_DECL_FEATURE
Feature identifier: disallow docType Decls.

DYNAMIC_VALIDATION

protected static final String DYNAMIC_VALIDATION
Dynamic validation

NAMESPACES

protected static final String NAMESPACES
Feature identifier: namespaces.

NORMALIZE_DATA

protected static final String NORMALIZE_DATA
Feature identifier: expose schema normalized value

PSVI_AUGMENT

protected static final String PSVI_AUGMENT

SYMBOL_TABLE

protected static final String SYMBOL_TABLE

VALIDATION_FEATURE

protected static final String VALIDATION_FEATURE
Feature id: validation.

XMLSCHEMA

protected static final String XMLSCHEMA
XML Schema validation

XMLSCHEMA_FULL_CHECKING

protected static final String XMLSCHEMA_FULL_CHECKING
XML Schema full checking

fBusy

protected boolean fBusy

fNamespaceDeclarations

protected boolean fNamespaceDeclarations
Include namespace declaration attributes in the document. *

fSchemaType

protected String fSchemaType

Constructor Details

DOMParserImpl

public DOMParserImpl(String configuration,
                     String schemaType)
Constructs a DOM Builder using the standard parser configuration.

DOMParserImpl

public DOMParserImpl(SymbolTable symbolTable)
Constructs a DOM Builder using the specified symbol table.

DOMParserImpl

public DOMParserImpl(SymbolTable symbolTable,
                     org.apache.xerces.xni.grammars.XMLGrammarPool grammarPool)
Constructs a DOM Builder using the specified symbol table and grammar pool.

DOMParserImpl

public DOMParserImpl(org.apache.xerces.xni.parser.XMLParserConfiguration config)
Constructs a DOM Builder using the specified parser configuration.

Method Details

abort

public void abort()
Overrides:
abort in interface AbstractDOMParser
See Also:
org.w3c.dom.ls.DOMParser.abort()

canSetParameter

public boolean canSetParameter(String name,
                               Object value)

getAsync

public boolean getAsync()
See Also:
org.w3c.dom.ls.LSParser.getAsync()

getBusy

public boolean getBusy()
See Also:
org.w3c.dom.ls.LSParser.getBusy()

getDomConfig

public DOMConfiguration getDomConfig()

getFilter

public LSParserFilter getFilter()
When the application provides a filter, the parser will call out to the filter at the completion of the construction of each Element node. The filter implementation can choose to remove the element from the document being constructed (unless the element is the document element) or to terminate the parse early. If the document is being validated when it's loaded the validation happens before the filter is called.

getParameter

public Object getParameter(String name)
            throws DOMException
Look up the value of a feature or a property.

getParameterNames

public DOMStringList getParameterNames()
DOM Level 3 CR - Experimental. The list of the parameters supported by this DOMConfiguration object and for which at least one value can be set by the application. Note that this list can also contain parameter names defined outside this specification.

parse

public Document parse(LSInput is)
            throws LSException
Parse an XML document from a resource identified by an LSInput.

parseURI

public Document parseURI(String uri)
            throws LSException
Parse an XML document from a location identified by an URI reference. If the URI contains a fragment identifier (see section 4.1 in ), the behavior is not defined by this specification.

parseWithContext

public Node parseWithContext(LSInput is,
                             Node cnode,
                             short action)
            throws DOMException,
                   LSException
Parse an XML document or fragment from a resource identified by an LSInput and insert the content into an existing document at the position epcified with the contextNode and action arguments. When parsing the input stream the context node is used for resolving unbound namespace prefixes.
Parameters:
is - The LSInput from which the source document is to be read.
cnode - The Node that is used as the context for the data that is being parsed.
action - This parameter describes which action should be taken between the new set of node being inserted and the existing children of the context node. The set of possible actions is defined above.

reset

public void reset()
Resets the parser state.
Overrides:
reset in interface AbstractDOMParser

setFilter

public void setFilter(LSParserFilter filter)
When the application provides a filter, the parser will call out to the filter at the completion of the construction of each Element node. The filter implementation can choose to remove the element from the document being constructed (unless the element is the document element) or to terminate the parse early. If the document is being validated when it's loaded the validation happens before the filter is called.

setParameter

public void setParameter(String name,
                         Object value)
            throws DOMException
Set parameters and properties

startElement

public void startElement(org.apache.xerces.xni.QName element,
                         org.apache.xerces.xni.XMLAttributes attributes,
                         org.apache.xerces.xni.Augmentations augs)
The start of an element. If the document specifies the start element by using an empty tag, then the startElement method will immediately be followed by the endElement method, with no intervening methods. Overriding the parent to handle DOM_NAMESPACE_DECLARATIONS=false.
Specified by:
startElement in interface org.apache.xerces.xni.XMLDocumentHandler
Overrides:
startElement in interface AbstractDOMParser
Parameters:
element - The name of the element.
attributes - The element attributes.
augs - Additional information that may include infoset augmentations

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.