Java Doc for DocumentHandler.java in  » Development » Javolution » org » xml » sax » 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 » Development » Javolution » org.xml.sax 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.xml.sax.DocumentHandler

All known Subclasses:   org.xml.sax.HandlerBase,
DocumentHandler
public interface DocumentHandler (Code)
Receive notification of general document events.
This module, both source code and documentation, is in the Public Domain, and comes with NO WARRANTY. See http://www.saxproject.org for further information.

This was the main event-handling interface for SAX1; in SAX2, it has been replaced by org.xml.sax.ContentHandlerContentHandler , which provides Namespace support and reporting of skipped entities. This interface is included in SAX2 only to support legacy SAX1 applications.

The order of events in this interface is very important, and mirrors the order of information in the document itself. For example, all of an element's content (character data, processing instructions, and/or subelements) will appear, in order, between the startElement event and the corresponding endElement event.

Application writers who do not want to implement the entire interface can derive a class from HandlerBase, which implements the default functionality; parser writers can instantiate HandlerBase to obtain a default handler. The application can find the location of any document event using the Locator interface supplied by the Parser through the setDocumentLocator method.


since:
   SAX 1.0
author:
   David Megginson
version:
   2.0.1 (sax2r2)
See Also:   org.xml.sax.Parser.setDocumentHandler
See Also:   org.xml.sax.Locator
See Also:   org.xml.sax.HandlerBase




Method Summary
abstract public  voidcharacters(char ch, int start, int length)
     Receive notification of character data.

The Parser will call this method to report each chunk of character data.

abstract public  voidendDocument()
     Receive notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse.

abstract public  voidendElement(String name)
     Receive notification of the end of an element.
abstract public  voidignorableWhitespace(char ch, int start, int length)
     Receive notification of ignorable whitespace in element content.
abstract public  voidprocessingInstruction(String target, String data)
     Receive notification of a processing instruction.
abstract public  voidsetDocumentLocator(Locator locator)
     Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the DocumentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error.

abstract public  voidstartDocument()
     Receive notification of the beginning of a document.
abstract public  voidstartElement(String name, AttributeList atts)
     Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty).




Method Detail
characters
abstract public void characters(char ch, int start, int length) throws SAXException(Code)
Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).


Parameters:
  ch - The characters from the XML document.
Parameters:
  start - The start position in the array.
Parameters:
  length - The number of characters to read from the array.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   DocumentHandler.ignorableWhitespace
See Also:   
See Also:   org.xml.sax.Locator



endDocument
abstract public void endDocument() throws SAXException(Code)
Receive notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.


exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.



endElement
abstract public void endElement(String name) throws SAXException(Code)
Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

If the element name has a namespace prefix, the prefix will still be attached to the name.


Parameters:
  name - The element type name
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.



ignorableWhitespace
abstract public void ignorableWhitespace(char ch, int start, int length) throws SAXException(Code)
Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.


Parameters:
  ch - The characters from the XML document.
Parameters:
  start - The start position in the array.
Parameters:
  length - The number of characters to read from the array.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   DocumentHandler.characters



processingInstruction
abstract public void processingInstruction(String target, String data) throws SAXException(Code)
Receive notification of a processing instruction.

The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.


Parameters:
  target - The processing instruction target.
Parameters:
  data - The processing instruction data, or null ifnone was supplied.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.



setDocumentLocator
abstract public void setDocumentLocator(Locator locator)(Code)
Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the DocumentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.


Parameters:
  locator - An object that can return the location ofany SAX document event.
See Also:   org.xml.sax.Locator



startDocument
abstract public void startDocument() throws SAXException(Code)
Receive notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).


exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.



startElement
abstract public void startElement(String name, AttributeList atts) throws SAXException(Code)
Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.

If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.


Parameters:
  name - The element type name.
Parameters:
  atts - The attributes attached to the element, if any.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
See Also:   DocumentHandler.endElement
See Also:   org.xml.sax.AttributeList
See Also:   



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