org.apache.xerces.parsers

Class DOMParserImpl

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 $

Author: Pavani Mukthipudi, Sun Microsystems Inc. Elena Litani, IBM Rahul Srivastava, Sun Microsystems Inc.

Field Summary
protected static booleanDEBUG
protected static StringDISALLOW_DOCTYPE_DECL_FEATURE
Feature identifier: disallow docType Decls.
protected static StringDYNAMIC_VALIDATION
Dynamic validation
protected booleanfBusy
protected booleanfNamespaceDeclarations
Include namespace declaration attributes in the document.
protected StringfSchemaType
protected static StringNAMESPACES
Feature identifier: namespaces.
protected static StringNORMALIZE_DATA
Feature identifier: expose schema normalized value
protected static StringPSVI_AUGMENT
protected static StringSYMBOL_TABLE
protected static StringVALIDATION_FEATURE
Feature id: validation.
protected static StringXMLSCHEMA
XML Schema validation
protected static StringXMLSCHEMA_FULL_CHECKING
XML Schema full checking
Constructor Summary
DOMParserImpl(String configuration, String schemaType)
Constructs a DOM Builder using the standard parser configuration.
DOMParserImpl(XMLParserConfiguration config)
Constructs a DOM Builder using the specified parser configuration.
DOMParserImpl(SymbolTable symbolTable)
Constructs a DOM Builder using the specified symbol table.
DOMParserImpl(SymbolTable symbolTable, XMLGrammarPool grammarPool)
Constructs a DOM Builder using the specified symbol table and grammar pool.
Method Summary
voidabort()
booleancanSetParameter(String name, Object value)
booleangetAsync()
booleangetBusy()
DOMConfigurationgetDomConfig()
LSParserFiltergetFilter()
When the application provides a filter, the parser will call out to the filter at the completion of the construction of each Element node.
ObjectgetParameter(String name)
Look up the value of a feature or a property.
DOMStringListgetParameterNames()
DOM Level 3 CR - Experimental.
Documentparse(LSInput is)
Parse an XML document from a resource identified by an LSInput.
DocumentparseURI(String uri)
Parse an XML document from a location identified by an URI reference.
NodeparseWithContext(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.
voidreset()
Resets the parser state.
voidsetFilter(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.
voidsetParameter(String name, Object value)
Set parameters and properties
voidstartElement(QName element, XMLAttributes attributes, Augmentations augs)
The start of an element.

Field Detail

DEBUG

protected static final boolean DEBUG

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

fBusy

protected boolean fBusy

fNamespaceDeclarations

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

fSchemaType

protected String fSchemaType

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

Constructor Detail

DOMParserImpl

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

DOMParserImpl

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

DOMParserImpl

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

DOMParserImpl

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

Method Detail

abort

public void abort()

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)
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)
Parse an XML document from a resource identified by an LSInput.

parseURI

public Document parseURI(String uri)
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)
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.

Throws: DOMException HIERARCHY_REQUEST_ERR: Thrown if this action results in an invalid hierarchy (i.e. a Document with more than one document element).

reset

public void reset()
Resets the parser state.

Throws: SAXException Thrown on initialization error.

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)
Set parameters and properties

startElement

public void startElement(QName element, XMLAttributes attributes, 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.

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.

Copyright © 1999-2005 Apache XML Project. All Rights Reserved.