File	Doc	Category	Size	Date	Package
XMLDocumentHandler.java	API Doc	Apache Xerces 3.0.1	12400	Fri Sep 14 20:33:56 BST 2007	org.apache.xerces.xni

XMLDocumentHandler

Fields Summary

Constructors Summary

Methods Summary
public void	characters(XMLString text, Augmentations augs) Character content. param text The content. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	comment(XMLString text, Augmentations augs) A comment. param text The text in the comment. param augs Additional information that may include infoset augmentations exception XNIException Thrown by application to signal an error.
public void	doctypeDecl(java.lang.String rootElement, java.lang.String publicId, java.lang.String systemId, Augmentations augs) Notifies of the presence of the DOCTYPE line in the document. param rootElement The name of the root element. param publicId The public identifier if an external DTD or null if the external DTD is specified using SYSTEM. param systemId The system identifier if an external DTD, null otherwise. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	emptyElement(QName element, XMLAttributes attributes, Augmentations augs) An empty element. param element The name of the element. param attributes The element attributes. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	endCDATA(Augmentations augs) The end of a CDATA section. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	endDocument(Augmentations augs) The end of the document. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	endElement(QName element, Augmentations augs) The end of an element. param element The name of the element. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	endGeneralEntity(java.lang.String name, Augmentations augs) This method notifies the end of a general entity. Note: This method is not called for entity references appearing as part of attribute values. param name The name of the entity. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public org.apache.xerces.xni.parser.XMLDocumentSource	getDocumentSource() Returns the document source.
public void	ignorableWhitespace(XMLString text, Augmentations augs) 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. param text The ignorable whitespace. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	processingInstruction(java.lang.String target, XMLString data, Augmentations augs) 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. param target The target. param data The data or null if none specified. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	setDocumentSource(org.apache.xerces.xni.parser.XMLDocumentSource source) Sets the document source.
public void	startCDATA(Augmentations augs) The start of a CDATA section. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	startDocument(XMLLocator locator, java.lang.String encoding, NamespaceContext namespaceContext, Augmentations augs) The start of the document. param 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. param 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). param namespaceContext The namespace context in effect at the start of this document. This object represents the current context. Implementors of this class are responsible for copying the namespace bindings from the the current context (and its parent contexts) if that information is important. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	startElement(QName element, XMLAttributes attributes, Augmentations augs) The start of an element. param element The name of the element. param attributes The element attributes. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	startGeneralEntity(java.lang.String name, XMLResourceIdentifier identifier, java.lang.String encoding, Augmentations augs) This method notifies the start of a general entity. Note: This method is not called for entity references appearing as part of attribute values. param name The name of the general entity. param identifier The resource identifier. param 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). param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	textDecl(java.lang.String version, java.lang.String encoding, Augmentations augs) 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. param version The XML version, or null if not specified. param encoding The IANA encoding name of the entity. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.
public void	xmlDecl(java.lang.String version, java.lang.String encoding, java.lang.String standalone, Augmentations augs) Notifies of the presence of an XMLDecl line in the document. If present, this method will be called immediately following the startDocument call. param version The XML version. param encoding The IANA encoding name of the document, or null if not specified. param standalone The standalone value, or null if not specified. param augs Additional information that may include infoset augmentations exception XNIException Thrown by handler to signal an error.