Java Doc for XMLReader.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.XMLReader

XMLReader
public interface XMLReader (Code)
Interface for reading an XML document using callbacks.
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.

Note: despite its name, this interface does not extend the standard Java j2me.io.Reader Reader interface, because reading XML is a fundamentally different activity than reading character data.

XMLReader is the interface that an XML parser's SAX2 driver must implement. This interface allows an application to set and query features and properties in the parser, to register event handlers for document processing, and to initiate a document parse.

All SAX interfaces are assumed to be synchronous: the XMLReader.parse parse methods must not return until parsing is complete, and readers must wait for an event-handler callback to return before reporting the next event.

This interface replaces the (now deprecated) SAX 1.0 org.xml.sax.Parser Parser interface. The XMLReader interface contains two important enhancements over the old Parser interface (as well as some minor ones):

  1. it adds a standard way to query and set features and properties; and
  2. it adds Namespace support, which is required for many higher-level XML standards.

There are adapters available to convert a SAX1 Parser to a SAX2 XMLReader and vice-versa.


since:
   SAX 2.0
author:
   David Megginson
version:
   2.0.1+ (sax2r3pre1)
See Also:   org.xml.sax.XMLFilter
See Also:   org.xml.sax.helpers.ParserAdapter
See Also:   org.xml.sax.helpers.XMLReaderAdapter
See Also:   




Method Summary
public  ContentHandlergetContentHandler()
     Return the current content handler.
public  DTDHandlergetDTDHandler()
     Return the current DTD handler.
public  EntityResolvergetEntityResolver()
     Return the current entity resolver.
public  ErrorHandlergetErrorHandler()
     Return the current error handler.
public  booleangetFeature(String name)
     Look up the value of a feature flag.

The feature name is any fully-qualified URI.

public  ObjectgetProperty(String name)
     Look up the value of a property.

The property name is any fully-qualified URI.

public  voidparse(InputSource input)
     Parse an XML document.

The application can use this method to instruct the XML reader to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).

Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document).

public  voidparse(String systemId)
     Parse an XML document from a system identifier (URI).

This method is a shortcut for the common case of reading a document from a system identifier.

public  voidsetContentHandler(ContentHandler handler)
     Allow an application to register a content event handler.
public  voidsetDTDHandler(DTDHandler handler)
     Allow an application to register a DTD event handler.
public  voidsetEntityResolver(EntityResolver resolver)
     Allow an application to register an entity resolver.
public  voidsetErrorHandler(ErrorHandler handler)
     Allow an application to register an error event handler.

If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue.

public  voidsetFeature(String name, boolean value)
     Set the value of a feature flag.

The feature name is any fully-qualified URI.

public  voidsetProperty(String name, Object value)
     Set the value of a property.

The property name is any fully-qualified URI.




Method Detail
getContentHandler
public ContentHandler getContentHandler()(Code)
Return the current content handler. The current content handler, or null if nonehas been registered.
See Also:   XMLReader.setContentHandler



getDTDHandler
public DTDHandler getDTDHandler()(Code)
Return the current DTD handler. The current DTD handler, or null if nonehas been registered.
See Also:   XMLReader.setDTDHandler



getEntityResolver
public EntityResolver getEntityResolver()(Code)
Return the current entity resolver. The current entity resolver, or null if nonehas been registered.
See Also:   XMLReader.setEntityResolver



getErrorHandler
public ErrorHandler getErrorHandler()(Code)
Return the current error handler. The current error handler, or null if nonehas been registered.
See Also:   XMLReader.setErrorHandler



getFeature
public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException(Code)
Look up the value of a feature flag.

The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but temporarily be unable to return its value. Some feature values may be available only in specific contexts, such as before, during, or after a parse. Also, some feature values may not be programmatically accessible. (In the case of an adapter for SAX1 org.xml.sax.Parser , there is no implementation-independent way to expose whether the underlying parser is performing validation, expanding external entities, and so forth.)

All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names.

Typical usage is something like this:

 XMLReader r = new MySAXDriver();
 // try to activate validation
 try {
 r.setFeature("http://xml.org/sax/features/validation", true);
 } catch (SAXException e) {
 System.err.println("Cannot activate validation."); 
 }
 // register event handlers
 r.setContentHandler(new MyContentHandler());
 r.setErrorHandler(new MyErrorHandler());
 // parse the first document
 try {
 r.parse("http://www.foo.com/mydoc.xml");
 } catch (IOException e) {
 System.err.println("I/O exception reading XML document");
 } catch (SAXException e) {
 System.err.println("XML exception reading document.");
 }
 

Implementors are free (and encouraged) to invent their own features, using names built on their own URIs.


Parameters:
  name - The feature name, which is a fully-qualified URI. The current value of the feature (true or false).
exception:
  org.xml.sax.SAXNotRecognizedException - If the featurevalue can't be assigned or retrieved.
exception:
  org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the feature name but cannot determine its value at this time.
See Also:   XMLReader.setFeature



getProperty
public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException(Code)
Look up the value of a property.

The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but temporarily be unable to return its value. Some property values may be available only in specific contexts, such as before, during, or after a parse.

XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.

Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.


Parameters:
  name - The property name, which is a fully-qualified URI. The current value of the property.
exception:
  org.xml.sax.SAXNotRecognizedException - If the propertyvalue can't be assigned or retrieved.
exception:
  org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the property name but cannot determine its value at this time.
See Also:   XMLReader.setProperty



parse
public void parse(InputSource input) throws IOException, SAXException(Code)
Parse an XML document.

The application can use this method to instruct the XML reader to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).

Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same XMLReader object, possibly with a different input source. Configuration of the XMLReader object (such as handler bindings and values established for feature flags and properties) is unchanged by completion of a parse, unless the definition of that aspect of the configuration explicitly specifies other behavior. (For example, feature flags or properties exposing characteristics of the document being parsed.)

During the parse, the XMLReader will provide information about the XML document through the registered event handlers.

This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.


Parameters:
  input - The input source for the top-level of theXML document.
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
exception:
  j2me.io.IOException - An IO exception from the parser,possibly from a byte stream or character streamsupplied by the application.
See Also:   org.xml.sax.InputSource
See Also:   XMLReader.setEntityResolver
See Also:   XMLReader.setDTDHandler
See Also:   XMLReader.setContentHandler
See Also:   XMLReader.setErrorHandler
See Also:   



parse
public void parse(String systemId) throws IOException, SAXException(Code)
Parse an XML document from a system identifier (URI).

This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:

 parse(new InputSource(systemId));
 

If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.


Parameters:
  systemId - The system identifier (URI).
exception:
  org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception.
exception:
  j2me.io.IOException - An IO exception from the parser,possibly from a byte stream or character streamsupplied by the application.
See Also:   XMLReader.parse(org.xml.sax.InputSource)



setContentHandler
public void setContentHandler(ContentHandler handler)(Code)
Allow an application to register a content event handler.

If the application does not register a content handler, all content events reported by the SAX parser will be silently ignored.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.


Parameters:
  handler - The content handler.
See Also:   XMLReader.getContentHandler



setDTDHandler
public void setDTDHandler(DTDHandler handler)(Code)
Allow an application to register a DTD event handler.

If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.


Parameters:
  handler - The DTD handler.
See Also:   XMLReader.getDTDHandler



setEntityResolver
public void setEntityResolver(EntityResolver resolver)(Code)
Allow an application to register an entity resolver.

If the application does not register an entity resolver, the XMLReader will perform its own default resolution.

Applications may register a new or different resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.


Parameters:
  resolver - The entity resolver.
See Also:   XMLReader.getEntityResolver



setErrorHandler
public void setErrorHandler(ErrorHandler handler)(Code)
Allow an application to register an error event handler.

If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.

Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.


Parameters:
  handler - The error handler.
See Also:   XMLReader.getErrorHandler



setFeature
public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException(Code)
Set the value of a feature flag.

The feature name is any fully-qualified URI. It is possible for an XMLReader to expose a feature value but to be unable to change the current value. Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

All XMLReaders are required to support setting http://xml.org/sax/features/namespaces to true and http://xml.org/sax/features/namespace-prefixes to false.


Parameters:
  name - The feature name, which is a fully-qualified URI.
Parameters:
  value - The requested value of the feature (true or false).
exception:
  org.xml.sax.SAXNotRecognizedException - If the featurevalue can't be assigned or retrieved.
exception:
  org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the feature name but cannot set the requested value.
See Also:   XMLReader.getFeature



setProperty
public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException(Code)
Set the value of a property.

The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to change the current value. Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

XMLReaders are not required to recognize setting any specific property names, though a core set is defined by SAX2.

This method is also the standard mechanism for setting extended handlers.


Parameters:
  name - The property name, which is a fully-qualified URI.
Parameters:
  value - The requested value for the property.
exception:
  org.xml.sax.SAXNotRecognizedException - If the propertyvalue can't be assigned or retrieved.
exception:
  org.xml.sax.SAXNotSupportedException - When theXMLReader recognizes the property name but cannot set the requested value.



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