Google

Xerces 3.1.1 API: Class DefaultHandler
Xerces 3.1.1


Class DefaultHandler

java.lang.Object
  |

Default base class for SAX2 event handlers.

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

This class is available as a convenience base class for SAX2 applications: it provides default implementations for all of the callbacks in the four core SAX2 handler classes:

Application writers can extend this class when they need to implement only part of an interface; parser writers can instantiate this class to provide default handlers when the application has not supplied its own.

This class replaces the deprecated SAX1

Since:
SAX 2.0
Version:
2.0


           
Constructor Summary
  int start, int length)
          Receive notification of character data inside an element.
          Receive notification of the end of the document. java.lang.String localName, java.lang.String qName)
          Receive notification of the end of an element.
          Receive notification of the end of a Namespace mapping.
          Receive notification of a recoverable parser error.
          Report a fatal XML parsing error. int start, int length)
          Receive notification of ignorable whitespace in element content. java.lang.String publicId, java.lang.String systemId)
          Receive notification of a notation declaration. java.lang.String data)
          Receive notification of a processing instruction.
          Receive a Locator object for document events.
          Receive notification of a skipped entity.
          Receive notification of the beginning of the document. java.lang.String localName, java.lang.String qName,
          Receive notification of the start of an element. java.lang.String uri)
          Receive notification of the start of a Namespace mapping. java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)
          Receive notification of an unparsed entity declaration.
          Receive notification of a parser warning.
Method Summary
 void
 void
 void
 void
 void
 void
 void
 void
 void
java.lang.String systemId)
          Resolve an external entity.
 void
 void
 void
 void
 void
 void
 void
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultHandler

public DefaultHandler()
Method Detail

resolveEntity

                                 java.lang.String systemId)
Resolve an external entity.

Always return null, so that the parser will use the system identifier provided in the XML document. This method implements the SAX default behaviour: application writers can override it in a subclass to do special translations such as catalog lookups or URI redirection.

Parameters:
publicId - The public identifer, or null if none is available.
systemId - The system identifier provided in the XML document.
Returns:
The new input source, or null to require the

notationDecl

public void notationDecl(java.lang.String name,
                         java.lang.String publicId,
                         java.lang.String systemId)
Receive notification of a notation declaration.

By default, do nothing. Application writers may override this method in a subclass if they wish to keep track of the notations declared in a document.

Parameters:
name - The notation name.
publicId - The notation public identifier, or null if not

unparsedEntityDecl

public void unparsedEntityDecl(java.lang.String name,
                               java.lang.String publicId,
                               java.lang.String systemId,
                               java.lang.String notationName)
Receive notification of an unparsed entity declaration.

By default, do nothing. Application writers may override this method in a subclass to keep track of the unparsed entities declared in a document.

Parameters:
name - The entity name.
publicId - The entity public identifier, or null if not

setDocumentLocator
Receive a Locator object for document events.

By default, do nothing. Application writers may override this method in a subclass if they wish to store the locator for use with other document events.


startDocument

public void startDocument()
Receive notification of the beginning of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the beginning of a document (such as allocating the root node of a tree or creating an output file).


endDocument

public void endDocument()
Receive notification of the end of the document.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of a document (such as finalising a tree or closing an output file).


startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
Receive notification of the start of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each Namespace prefix scope (such as storing the prefix mapping).


endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
Receive notification of the end of a Namespace mapping.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each prefix mapping.


startElement
public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
Receive notification of the start of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the start of each element (such as allocating a new tree node or writing output to a file).


endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
Receive notification of the end of an element.

By default, do nothing. Application writers may override this method in a subclass to take specific actions at the end of each element (such as finalising a tree node or writing output to a file).


characters

public void characters(char[] ch,
                       int start,
                       int length)
Receive notification of character data inside an element.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of character data (such as adding the data to a node or buffer, or printing it to a file).

Parameters:
ch - The characters.
start - The start position in the character array.
length - The number of characters to use from the

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
Receive notification of ignorable whitespace in element content.

By default, do nothing. Application writers may override this method to take specific actions for each chunk of ignorable whitespace (such as adding data to a node or buffer, or printing it to a file).

Parameters:
ch - The whitespace characters.
start - The start position in the character array.
length - The number of characters to use from the

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
Receive notification of a processing instruction.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.

Parameters:
target - The processing instruction target.
data - The processing instruction data, or null if

skippedEntity

public void skippedEntity(java.lang.String name)
Receive notification of a skipped entity.

By default, do nothing. Application writers may override this method in a subclass to take specific actions for each processing instruction, such as setting status variables or invoking other methods.


warning
Receive notification of a parser warning.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each warning, such as inserting the message in a log file or printing it to the console.


error
Receive notification of a recoverable parser error.

The default implementation does nothing. Application writers may override this method in a subclass to take specific actions for each error, such as inserting the message in a log file or printing it to the console.


fatalError
Report a fatal XML parsing error.

The default implementation throws a SAXParseException. Application writers may override this method in a subclass if they need to take specific actions for each fatal error (such as collecting all of the errors into a single report): in any case, the application must stop all regular processing when this method is invoked, since the document is no longer reliable, and the parser may no longer report parsing events.


Xerces 3.1.1