org.apache.xerces.xni
Interface XMLDocumentHandler


public interface XMLDocumentHandler

The document handler interface defines callback methods to report information items in XML documents. Parser components interested in document information implement this interface and are registered as the document handler on the document source.

Version:
$Id: XMLDocumentHandler.java,v 1.2 2001/08/23 00:35:36 lehors Exp $
Author:
Stubs generated by DesignDoc on Mon Sep 18 18:23:16 PDT 2000, Andy Clark, IBM

Method Summary
 void characters(XMLString text)
          Character content.
 void comment(XMLString text)
          A comment.
 void doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId)
          Notifies of the presence of the DOCTYPE line in the document.
 void emptyElement(QName element, XMLAttributes attributes)
          An empty element.
 void endCDATA()
          The end of a CDATA section.
 void endDocument()
          The end of the document.
 void endElement(QName element)
          The end of an element.
 void endEntity(java.lang.String name)
          This method notifies the end of an entity.
 void endPrefixMapping(java.lang.String prefix)
          The end of a namespace prefix mapping.
 void ignorableWhitespace(XMLString text)
          Ignorable whitespace.
 void processingInstruction(java.lang.String target, XMLString data)
          A processing instruction.
 void startCDATA()
          The start of a CDATA section.
 void startDocument(XMLLocator locator, java.lang.String encoding)
          The start of the document.
 void startElement(QName element, XMLAttributes attributes)
          The start of an element.
 void startEntity(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String baseSystemId, java.lang.String encoding)
          This method notifies the start of an entity.
 void startPrefixMapping(java.lang.String prefix, java.lang.String uri)
          The start of a namespace prefix mapping.
 void textDecl(java.lang.String version, java.lang.String encoding)
          Notifies of the presence of a TextDecl line in an entity.
 void xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone)
          Notifies of the presence of an XMLDecl line in the document.
 

Method Detail

startDocument

public void startDocument(XMLLocator locator,
                          java.lang.String encoding)
                   throws XNIException
The start of the document.
Parameters:
locator - The document locator, or null if the document location cannot be reported during the parsing of this document. However, it is strongly recommended that a locator be supplied that can at least report the system identifier of the document.
encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
Throws:
XNIException - Thrown by handler to signal an error.

xmlDecl

public void xmlDecl(java.lang.String version,
                    java.lang.String encoding,
                    java.lang.String standalone)
             throws XNIException
Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call.
Parameters:
version - The XML version.
encoding - The IANA encoding name of the document, or null if not specified.
standalone - The standalone value, or null if not specified.
Throws:
XNIException - Thrown by handler to signal an error.

doctypeDecl

public void doctypeDecl(java.lang.String rootElement,
                        java.lang.String publicId,
                        java.lang.String systemId)
                 throws XNIException
Notifies of the presence of the DOCTYPE line in the document.
Parameters:
rootElement - The name of the root element.
publicId - The public identifier if an external DTD or null if the external DTD is specified using SYSTEM.
systemId - The system identifier if an external DTD, null otherwise.
Throws:
XNIException - Thrown by handler to signal an error.

comment

public void comment(XMLString text)
             throws XNIException
A comment.
Parameters:
text - The text in the comment.
Throws:
XNIException - Thrown by application to signal an error.

processingInstruction

public void processingInstruction(java.lang.String target,
                                  XMLString data)
                           throws XNIException
A processing instruction. Processing instructions consist of a target name and, optionally, text data. The data is only meaningful to the application.

Typically, a processing instruction's data will contain a series of pseudo-attributes. These pseudo-attributes follow the form of element attributes but are not parsed or presented to the application as anything other than text. The application is responsible for parsing the data.

Parameters:
target - The target.
data - The data or null if none specified.
Throws:
XNIException - Thrown by handler to signal an error.

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws XNIException
The start of a namespace prefix mapping. This method will only be called when namespace processing is enabled.
Parameters:
prefix - The namespace prefix.
uri - The URI bound to the prefix.
Throws:
XNIException - Thrown by handler to signal an error.

startElement

public void startElement(QName element,
                         XMLAttributes attributes)
                  throws XNIException
The start of an element.
Parameters:
element - The name of the element.
attributes - The element attributes.
Throws:
XNIException - Thrown by handler to signal an error.

emptyElement

public void emptyElement(QName element,
                         XMLAttributes attributes)
                  throws XNIException
An empty element.
Parameters:
element - The name of the element.
attributes - The element attributes.
Throws:
XNIException - Thrown by handler to signal an error.

startEntity

public void startEntity(java.lang.String name,
                        java.lang.String publicId,
                        java.lang.String systemId,
                        java.lang.String baseSystemId,
                        java.lang.String encoding)
                 throws XNIException
This method notifies the start of an entity.

Note: This method is not called for entity references appearing as part of attribute values.

Parameters:
name - The name of the entity.
publicId - The public identifier of the entity if the entity is external, null otherwise.
systemId - The system identifier of the entity if the entity is external, null otherwise.
baseSystemId - The base system identifier of the entity if the entity is external, null otherwise.
encoding - The auto-detected IANA encoding name of the entity stream. This value will be null in those situations where the entity encoding is not auto-detected (e.g. internal entities or a document entity that is parsed from a java.io.Reader).
Throws:
XNIException - Thrown by handler to signal an error.

textDecl

public void textDecl(java.lang.String version,
                     java.lang.String encoding)
              throws XNIException
Notifies of the presence of a TextDecl line in an entity. If present, this method will be called immediately following the startEntity call.

Note: This method will never be called for the document entity; it is only called for external general entities referenced in document content.

Note: This method is not called for entity references appearing as part of attribute values.

Parameters:
version - The XML version, or null if not specified.
encoding - The IANA encoding name of the entity.
Throws:
XNIException - Thrown by handler to signal an error.

endEntity

public void endEntity(java.lang.String name)
               throws XNIException
This method notifies the end of an entity.

Note: This method is not called for entity references appearing as part of attribute values.

Parameters:
name - The name of the entity.
Throws:
XNIException - Thrown by handler to signal an error.

characters

public void characters(XMLString text)
                throws XNIException
Character content.
Parameters:
text - The content.
Throws:
XNIException - Thrown by handler to signal an error.

ignorableWhitespace

public void ignorableWhitespace(XMLString text)
                         throws XNIException
Ignorable whitespace. For this method to be called, the document source must have some way of determining that the text containing only whitespace characters should be considered ignorable. For example, the validator can determine if a length of whitespace characters in the document are ignorable based on the element content model.
Parameters:
text - The ignorable whitespace.
Throws:
XNIException - Thrown by handler to signal an error.

endElement

public void endElement(QName element)
                throws XNIException
The end of an element.
Parameters:
element - The name of the element.
Throws:
XNIException - Thrown by handler to signal an error.

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws XNIException
The end of a namespace prefix mapping. This method will only be called when namespace processing is enabled.
Parameters:
prefix - The namespace prefix.
Throws:
XNIException - Thrown by handler to signal an error.

startCDATA

public void startCDATA()
                throws XNIException
The start of a CDATA section.
Throws:
XNIException - Thrown by handler to signal an error.

endCDATA

public void endCDATA()
              throws XNIException
The end of a CDATA section.
Throws:
XNIException - Thrown by handler to signal an error.

endDocument

public void endDocument()
                 throws XNIException
The end of the document.
Throws:
XNIException - Thrown by handler to signal an error.


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