Home » Xerces-J-src.2.9.1 » org.apache.xerces » xni » [javadoc | source]
org.apache.xerces.xni
public interface: XMLDocumentHandler [javadoc | source]

All Known Implementing Classes:
    XMLNamespaceBinder, XMLDTDValidatorFilter, DOMParser, XMLDTDValidator, DOMAddLines, DOMParserImpl, XNI2SAX, XIncludeHandler, XMLDocumentParser, Counter, UpperCaseFilter, PSVIParser, XML11NamespaceBinder, XMLNSDTDValidator, RevalidationHandler, XML11DTDValidator, DOMASBuilderImpl, XMLDocumentFilter, AbortHandler, SAXParser, DOMParserSaveEncoding, XML11NSDTDValidator, DefaultXMLDocumentHandler, XPointerHandler, Writer, RevalidatingDOMParser, PSVIWriter, SchemaDOMParser, JAXPSAXParser, DOMNormalizer, CSVParser, AbstractDOMParser, JAXPValidatorComponent, DOMDocumentHandler, DocumentTracer, AbstractXMLDocumentParser, DOMResultBuilder, XMLSchemaValidator, DOMResultAugmentor, AbstractSAXParser, ValidatorHandlerImpl, PassThroughFilter, TeeXMLDocumentFilterImpl

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.
Method from org.apache.xerces.xni.XMLDocumentHandler Summary:
characters,   comment,   doctypeDecl,   emptyElement,   endCDATA,   endDocument,   endElement,   endGeneralEntity,   getDocumentSource,   ignorableWhitespace,   processingInstruction,   setDocumentSource,   startCDATA,   startDocument,   startElement,   startGeneralEntity,   textDecl,   xmlDecl
Method from org.apache.xerces.xni.XMLDocumentHandler Detail:
 public  void characters(XMLString text,
    Augmentations augs) throws XNIException
    Character content.
 public  void comment(XMLString text,
    Augmentations augs) throws XNIException
    A comment.
 public  void doctypeDecl(String rootElement,
    String publicId,
    String systemId,
    Augmentations augs) throws XNIException
    Notifies of the presence of the DOCTYPE line in the document.
 public  void emptyElement(QName element,
    XMLAttributes attributes,
    Augmentations augs) throws XNIException
    An empty element.
 public  void endCDATA(Augmentations augs) throws XNIException
    The end of a CDATA section.
 public  void endDocument(Augmentations augs) throws XNIException
    The end of the document.
 public  void endElement(QName element,
    Augmentations augs) throws XNIException
    The end of an element.
 public  void endGeneralEntity(String name,
    Augmentations augs) throws XNIException
    This method notifies the end of a general entity.

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

 public XMLDocumentSource getDocumentSource()
    Returns the document source.
 public  void ignorableWhitespace(XMLString text,
    Augmentations augs) 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.
 public  void processingInstruction(String target,
    XMLString data,
    Augmentations augs) 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.

 public  void setDocumentSource(XMLDocumentSource source)
    Sets the document source.
 public  void startCDATA(Augmentations augs) throws XNIException
    The start of a CDATA section.
 public  void startDocument(XMLLocator locator,
    String encoding,
    NamespaceContext namespaceContext,
    Augmentations augs) throws XNIException
    The start of the document.
 public  void startElement(QName element,
    XMLAttributes attributes,
    Augmentations augs) throws XNIException
    The start of an element.
 public  void startGeneralEntity(String name,
    XMLResourceIdentifier identifier,
    String encoding,
    Augmentations augs) throws XNIException
    This method notifies the start of a general entity.

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

 public  void textDecl(String version,
    String encoding,
    Augmentations augs) 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.

 public  void xmlDecl(String version,
    String encoding,
    String standalone,
    Augmentations augs) 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.