Java Doc for XMLDocumentHandler.java in  » XML » xerces-2_9_1 » org » apache » xerces » xni » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » XML » xerces 2_9_1 » org.apache.xerces.xni 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.xerces.xni.XMLDocumentHandler

All known Subclasses:   org.apache.xerces.impl.xs.opti.DefaultXMLDocumentHandler,  org.apache.xerces.parsers.AbstractXMLDocumentParser,  org.apache.xerces.dom.DOMNormalizer,  org.apache.xerces.jaxp.validation.ValidatorHandlerImpl,
XMLDocumentHandler
public interface XMLDocumentHandler (Code)
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.
author:
   Andy Clark, IBM
version:
   $Id: XMLDocumentHandler.java 447247 2006-09-18 05:23:52Z mrglavas $




Method Summary
public  voidcharacters(XMLString text, Augmentations augs)
     Character content.
public  voidcomment(XMLString text, Augmentations augs)
     A comment.
public  voiddoctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs)
     Notifies of the presence of the DOCTYPE line in the document.
public  voidemptyElement(QName element, XMLAttributes attributes, Augmentations augs)
     An empty element.
public  voidendCDATA(Augmentations augs)
     The end of a CDATA section.
public  voidendDocument(Augmentations augs)
     The end of the document.
public  voidendElement(QName element, Augmentations augs)
     The end of an element.
public  voidendGeneralEntity(String name, Augmentations augs)
     This method notifies the end of a general entity.
public  XMLDocumentSourcegetDocumentSource()
     Returns the document source.
public  voidignorableWhitespace(XMLString text, Augmentations augs)
     Ignorable whitespace.
public  voidprocessingInstruction(String target, XMLString data, Augmentations augs)
     A processing instruction.
public  voidsetDocumentSource(XMLDocumentSource source)
     Sets the document source.
public  voidstartCDATA(Augmentations augs)
     The start of a CDATA section.
public  voidstartDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs)
     The start of the document.
Parameters:
  locator - The document locator, or null if the documentlocation cannot be reported during the parsingof this document.
public  voidstartElement(QName element, XMLAttributes attributes, Augmentations augs)
     The start of an element.
public  voidstartGeneralEntity(String name, XMLResourceIdentifier identifier, 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.
Parameters:
  name - The name of the general entity.
Parameters:
  identifier - The resource identifier.
Parameters:
  encoding - The auto-detected IANA encoding name of the entitystream.

public  voidtextDecl(String version, String encoding, Augmentations augs)
     Notifies of the presence of a TextDecl line in an entity.
public  voidxmlDecl(String version, String encoding, String standalone, Augmentations augs)
     Notifies of the presence of an XMLDecl line in the document.



Method Detail
characters
public void characters(XMLString text, Augmentations augs) throws XNIException(Code)
Character content.
Parameters:
  text - The content.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



comment
public void comment(XMLString text, Augmentations augs) throws XNIException(Code)
A comment.
Parameters:
  text - The text in the comment.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by application to signal an error.



doctypeDecl
public void doctypeDecl(String rootElement, String publicId, String systemId, Augmentations augs) throws XNIException(Code)
Notifies of the presence of the DOCTYPE line in the document.
Parameters:
  rootElement - The name of the root element.
Parameters:
  publicId - The public identifier if an external DTD or nullif the external DTD is specified using SYSTEM.
Parameters:
  systemId - The system identifier if an external DTD, nullotherwise.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



emptyElement
public void emptyElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code)
An empty element.
Parameters:
  element - The name of the element.
Parameters:
  attributes - The element attributes.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



endCDATA
public void endCDATA(Augmentations augs) throws XNIException(Code)
The end of a CDATA section.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



endDocument
public void endDocument(Augmentations augs) throws XNIException(Code)
The end of the document.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



endElement
public void endElement(QName element, Augmentations augs) throws XNIException(Code)
The end of an element.
Parameters:
  element - The name of the element.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



endGeneralEntity
public void endGeneralEntity(String name, Augmentations augs) throws XNIException(Code)
This method notifies the end of a general entity.

Note: This method is not called for entity references appearing as part of attribute values.
Parameters:
  name - The name of the entity.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.




getDocumentSource
public XMLDocumentSource getDocumentSource()(Code)
Returns the document source.



ignorableWhitespace
public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException(Code)
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.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



processingInstruction
public void processingInstruction(String target, XMLString data, Augmentations augs) throws XNIException(Code)
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.
Parameters:
  data - The data or null if none specified.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.




setDocumentSource
public void setDocumentSource(XMLDocumentSource source)(Code)
Sets the document source.



startCDATA
public void startCDATA(Augmentations augs) throws XNIException(Code)
The start of a CDATA section.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



startDocument
public void startDocument(XMLLocator locator, String encoding, NamespaceContext namespaceContext, Augmentations augs) throws XNIException(Code)
The start of the document.
Parameters:
  locator - The document locator, or null if the documentlocation cannot be reported during the parsingof this document. However, it is stronglyrecommended that a locator be supplied that canat least report the system identifier of thedocument.
Parameters:
  encoding - The auto-detected IANA encoding name of the entitystream. This value will be null in those situationswhere the entity encoding is not auto-detected (e.g.internal entities or a document entity that isparsed from a java.io.Reader).
Parameters:
  namespaceContext - The namespace context in effect at thestart of this document.This object represents the current context.Implementors of this class are responsiblefor copying the namespace bindings from thethe current context (and its parent contexts)if that information is important.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



startElement
public void startElement(QName element, XMLAttributes attributes, Augmentations augs) throws XNIException(Code)
The start of an element.
Parameters:
  element - The name of the element.
Parameters:
  attributes - The element attributes.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



startGeneralEntity
public void startGeneralEntity(String name, XMLResourceIdentifier identifier, String encoding, Augmentations augs) throws XNIException(Code)
This method notifies the start of a general entity.

Note: This method is not called for entity references appearing as part of attribute values.
Parameters:
  name - The name of the general entity.
Parameters:
  identifier - The resource identifier.
Parameters:
  encoding - The auto-detected IANA encoding name of the entitystream. This value will be null in those situationswhere the entity encoding is not auto-detected (e.g.internal entities or a document entity that isparsed from a java.io.Reader).
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.




textDecl
public void textDecl(String version, String encoding, Augmentations augs) throws XNIException(Code)
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.
Parameters:
  encoding - The IANA encoding name of the entity.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.




xmlDecl
public void xmlDecl(String version, String encoding, String standalone, Augmentations augs) throws XNIException(Code)
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.
Parameters:
  encoding - The IANA encoding name of the document, or null ifnot specified.
Parameters:
  standalone - The standalone value, or null if not specified.
Parameters:
  augs - Additional information that may include infoset augmentations
exception:
  XNIException - Thrown by handler to signal an error.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.