Google

Xerces 3.1.1 API: Interface XMLReader
Xerces 3.1.1


Interface XMLReader


public interface XMLReader

Interface for reading an XML document using callbacks.

This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY.

Note: despite its name, this interface does not extend the standard Java Reader interface, because reading XML is a fundamentally different activity than reading character data.

XMLReader is the interface that an XML parser's SAX2 driver must implement. This interface allows an application to set and query features and properties in the parser, to register event handlers for document processing, and to initiate a document parse.

All SAX interfaces are assumed to be synchronous: the is complete, and readers must wait for an event-handler callback to return before reporting the next event.

contains two important enhancements over the old Parser interface:

  1. it adds a standard way to query and set features and properties; and
  2. it adds Namespace support, which is required for many higher-level XML standards.

There are adapters available to convert a SAX1 Parser to a SAX2 XMLReader and vice-versa.

Since:
SAX 2.0
Version:
2.0


          Look up the value of a feature.
          Look up the value of a property.
          Parse an XML document.
          Parse an XML document from a system identifier (URI).
          Allow an application to register a content event handler.
          Allow an application to register a DTD event handler.
          Allow an application to register an entity resolver.
          Allow an application to register an error event handler. boolean value)
          Set the state of a feature. java.lang.Object value)
          Set the value of a property.
Method Summary

          Return the current content handler.

          Return the current DTD handler.

          Return the current entity resolver.

          Return the current error handler.
 boolean
 java.lang.Object
 void
 void
 void
 void
 void
 void
 void
 void
 

Method Detail

getFeature

public boolean getFeature(java.lang.String name)
Look up the value of a feature.

The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but to be unable to return its value; this is especially true in the case of an adapter for a SAX1 Parser, which has no way of knowing whether the underlying parser is performing validation or expanding external entities.

All XMLReaders are required to recognize the

Some feature values may be available only in specific contexts, such as before, during, or after a parse.

Typical usage is something like this:

 XMLReader r = new MySAXDriver();

                         // try to activate validation
 try {
 } catch (SAXException e) {
   System.err.println("Cannot activate validation."); 
 }

                         // register event handlers
 r.setContentHandler(new MyContentHandler());
 r.setErrorHandler(new MyErrorHandler());

                         // parse the first document
 try {
 } catch (IOException e) {
   System.err.println("I/O exception reading XML document");
 } catch (SAXException e) {
   System.err.println("XML exception reading document.");
 }
 

Implementors are free (and encouraged) to invent their own features, using names built on their own URIs.

XMLReader recognizes the feature name but

setFeature

public void setFeature(java.lang.String name,
                       boolean value)
Set the state of a feature.

The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but to be unable to set its value; this is especially true which has no way of affecting whether the underlying parser is validating, for example.

All XMLReaders are required to support setting

Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

XMLReader recognizes the feature name but

getProperty

public java.lang.Object getProperty(java.lang.String name)
Look up the value of a property.

The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to return its state; this is especially true

XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.

Some property values may be available only in specific contexts, such as before, during, or after a parse.

Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.

XMLReader recognizes the property name but

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
Set the value of a property.

The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to set its value; this is especially true

XMLReaders are not required to recognize setting any specific property names, though a core set is provided with SAX2.

Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

This method is also the standard mechanism for setting extended handlers.

XMLReader recognizes the property name but cannot set the requested value.

setEntityResolver
Allow an application to register an entity resolver.

If the application does not register an entity resolver, the XMLReader will perform its own default resolution.

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

Parameters:
resolver - The entity resolver.
Throws:
java.lang.NullPointerException - If the resolver

getEntityResolver

Return the current entity resolver.
Returns:
The current entity resolver, or null if none

setDTDHandler
Allow an application to register a DTD event handler.

If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.

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:
handler - The DTD handler.
Throws:
java.lang.NullPointerException - If the handler

getDTDHandler

Return the current DTD handler.
Returns:
The current DTD handler, or null if none

setContentHandler
Allow an application to register a content event handler.

If the application does not register a content handler, all content events reported by the SAX parser will be silently ignored.

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:
handler - The content handler.
Throws:
java.lang.NullPointerException - If the handler

getContentHandler

Return the current content handler.
Returns:
The current content handler, or null if none

setErrorHandler
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:
handler - The error handler.
Throws:
java.lang.NullPointerException - If the handler

getErrorHandler

Return the current error handler.
Returns:
The current error handler, or null if none

parse
           throws java.io.IOException,
Parse an XML document.

The application can use this method to instruct the XML reader to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).

Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same XMLReader object, possibly with a different input source.

During the parse, the XMLReader will provide information about the XML document through the registered event handlers.

This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.

Parameters:
source - The input source for the top-level of the wrapping another exception.
java.io.IOException - An IO exception from the parser, possibly from a byte stream or character stream

parse

public void parse(java.lang.String systemId)
           throws java.io.IOException,
Parse an XML document from a system identifier (URI).

This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:

 parse(new InputSource(systemId));
 

If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.

wrapping another exception.
java.io.IOException - An IO exception from the parser, possibly from a byte stream or character stream

Xerces 3.1.1