org.apache.xerces.parsers

Class DOMParser

public class DOMParser extends AbstractDOMParser

This is the main Xerces DOM parser 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: DOMParser.java,v 1.77 2005/06/24 02:33:43 mrglavas Exp $

Author: Arnaud Le Hors, IBM Andy Clark, IBM

Field Summary
protected booleanfUseEntityResolver2
Use EntityResolver2.
protected static StringSYMBOL_TABLE
Property identifier: symbol table.
protected static StringUSE_ENTITY_RESOLVER2
Feature identifier: EntityResolver2.
protected static StringXMLGRAMMAR_POOL
Property identifier: XML grammar pool.
Constructor Summary
DOMParser(XMLParserConfiguration config)
Constructs a DOM parser using the specified parser configuration.
DOMParser()
Constructs a DOM parser using the dtd/xml schema parser configuration.
DOMParser(SymbolTable symbolTable)
Constructs a DOM parser using the specified symbol table.
DOMParser(SymbolTable symbolTable, XMLGrammarPool grammarPool)
Constructs a DOM parser using the specified symbol table and grammar pool.
Method Summary
EntityResolvergetEntityResolver()
Return the current entity resolver.
ErrorHandlergetErrorHandler()
Return the current error handler.
booleangetFeature(String featureId)
Query the state of a feature.
ObjectgetProperty(String propertyId)
Query the value of a property.
XMLParserConfigurationgetXMLParserConfiguration()
Returns this parser's XMLParserConfiguration.
voidparse(String systemId)
Parses the input source specified by the given system identifier.
voidparse(InputSource inputSource)
parse
voidsetEntityResolver(EntityResolver resolver)
Sets the resolver used to resolve external entities.
voidsetErrorHandler(ErrorHandler errorHandler)
Allow an application to register an error event handler.
voidsetFeature(String featureId, boolean state)
Set the state of any feature in a SAX2 parser.
voidsetProperty(String propertyId, Object value)
Set the value of any property in a SAX2 parser.

Field Detail

fUseEntityResolver2

protected boolean fUseEntityResolver2
Use EntityResolver2.

SYMBOL_TABLE

protected static final String SYMBOL_TABLE
Property identifier: symbol table.

USE_ENTITY_RESOLVER2

protected static final String USE_ENTITY_RESOLVER2
Feature identifier: EntityResolver2.

XMLGRAMMAR_POOL

protected static final String XMLGRAMMAR_POOL
Property identifier: XML grammar pool.

Constructor Detail

DOMParser

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

DOMParser

public DOMParser()
Constructs a DOM parser using the dtd/xml schema parser configuration.

DOMParser

public DOMParser(SymbolTable symbolTable)
Constructs a DOM parser using the specified symbol table.

DOMParser

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

Method Detail

getEntityResolver

public EntityResolver getEntityResolver()
Return the current entity resolver.

Returns: The current entity resolver, or null if none has been registered.

See Also: DOMParser

getErrorHandler

public ErrorHandler getErrorHandler()
Return the current error handler.

Returns: The current error handler, or null if none has been registered.

See Also: DOMParser

getFeature

public boolean getFeature(String featureId)
Query the state of a feature. Query the current state of any feature in a SAX2 parser. The parser might not recognize the feature.

Parameters: featureId The unique identifier (URI) of the feature being set.

Returns: The current state of the feature.

Throws: org.xml.sax.SAXNotRecognizedException If the requested feature is not known. SAXNotSupportedException If the requested feature is known but not supported.

getProperty

public Object getProperty(String propertyId)
Query the value of a property. Return the current value of a property in a SAX2 parser. The parser might not recognize the property.

Parameters: propertyId The unique identifier (URI) of the property being set.

Returns: The current value of the property.

Throws: org.xml.sax.SAXNotRecognizedException If the requested property is not known. SAXNotSupportedException If the requested property is known but not supported.

getXMLParserConfiguration

public XMLParserConfiguration getXMLParserConfiguration()
Returns this parser's XMLParserConfiguration.

parse

public void parse(String systemId)
Parses the input source specified by the given system identifier.

This method is equivalent to the following:

     parse(new InputSource(systemId));
 

Parameters: systemId The system identifier (URI).

Throws: org.xml.sax.SAXException Throws exception on SAX error. java.io.IOException Throws exception on i/o error.

parse

public void parse(InputSource inputSource)
parse

Parameters: inputSource

Throws: org.xml.sax.SAXException java.io.IOException

setEntityResolver

public void setEntityResolver(EntityResolver resolver)
Sets the resolver used to resolve external entities. The EntityResolver interface supports resolution of public and system identifiers.

Parameters: resolver The new entity resolver. Passing a null value will uninstall the currently installed resolver.

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)
Allow an application to register an error event handler.

If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

Parameters: errorHandler The error handler.

Throws: java.lang.NullPointerException If the handler argument is null.

See Also: DOMParser

setFeature

public void setFeature(String featureId, boolean state)
Set the state of any feature in a SAX2 parser. The parser might not recognize the feature, and if it does recognize it, it might not be able to fulfill the request.

Parameters: featureId The unique identifier (URI) of the feature. state The requested state of the feature (true or false).

Throws: SAXNotRecognizedException If the requested feature is not known. SAXNotSupportedException If the requested feature is known, but the requested state is not supported.

setProperty

public void setProperty(String propertyId, Object value)
Set the value of any property in a SAX2 parser. The parser might not recognize the property, and if it does recognize it, it might not support the requested value.

Parameters: propertyId The unique identifier (URI) of the property being set. value The value to which the property is being set.

Throws: SAXNotRecognizedException If the requested property is not known. SAXNotSupportedException If the requested property is known, but the requested value is not supported.

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