| |
|
| java.lang.Object
 javax.xml.parsers.SAXParser
| SAXParser | | abstract public class SAXParser (Code) | | Defines the API that wraps an
org.xml.sax.XMLReader implementation class. In JAXP 1.0, this class wrapped the
org.xml.sax.Parser interface, however this interface was
replaced by the
org.xml.sax.XMLReader . For ease
of transition, this class continues to support the same name
and interface as well as supporting new methods.
An instance of this class can be obtained from the
javax.xml.parsers.SAXParserFactory.newSAXParser method.
Once an instance of this class is obtained, XML can be parsed from
a variety of input sources. These input sources are InputStreams,
Files, URLs, and SAX InputSources.
This static method creates a new factory instance based
on a system property setting or uses the platform default
if no property has been defined.
The system property that controls which Factory implementation
to create is named "javax.xml.parsers.SAXParserFactory".
This property names a class that is a concrete subclass of this
abstract class. If no property is defined, a platform default
will be used.
As the content is parsed by the underlying parser, methods of the
given
org.xml.sax.HandlerBase or the
org.xml.sax.helpers.DefaultHandler are called.
Implementors of this class which wrap an underlaying implementation
can consider using the
org.xml.sax.helpers.ParserAdapter class to initially adapt their SAX1 implementation to work under
this revised class.
author:
Jeff Suttor
version:
$Revision: 1.6 $, $Date: 2007/01/27 01:26:27 $ |
| Constructor Summary | |
| protected | SAXParser()
Protected constructor to prevent instaniation. |
| Method Summary | |
| abstract public org.xml.sax.Parser | getParser()
Returns the SAX parser that is encapsultated by the
implementation of this class. | | abstract public Object | getProperty(String name)
Returns the particular property requested for in the underlying
implementation of
org.xml.sax.XMLReader .
Parameters:
name - The name of the property to be retrieved. | | public Schema | getSchema()
| | abstract public org.xml.sax.XMLReader | getXMLReader()
Returns the
org.xml.sax.XMLReader that is encapsulated by the
implementation of this class. | | abstract public boolean | isNamespaceAware()
Indicates whether or not this parser is configured to
understand namespaces. | | abstract public boolean | isValidating()
Indicates whether or not this parser is configured to
validate XML documents. | | public boolean | isXIncludeAware()
| | public void | parse(InputStream is, HandlerBase hb)
Parse the content of the given
java.io.InputStream instance as XML using the specified
org.xml.sax.HandlerBase . | | public void | parse(InputStream is, HandlerBase hb, String systemId)
Parse the content of the given
java.io.InputStream instance as XML using the specified
org.xml.sax.HandlerBase . | | public void | parse(InputStream is, DefaultHandler dh)
Parse the content of the given
java.io.InputStream instance as XML using the specified
org.xml.sax.helpers.DefaultHandler . | | public void | parse(InputStream is, DefaultHandler dh, String systemId)
Parse the content of the given
java.io.InputStream instance as XML using the specified
org.xml.sax.helpers.DefaultHandler . | | public void | parse(String uri, HandlerBase hb)
Parse the content described by the giving Uniform Resource
Identifier (URI) as XML using the specified
org.xml.sax.HandlerBase . | | public void | parse(String uri, DefaultHandler dh)
Parse the content described by the giving Uniform Resource
Identifier (URI) as XML using the specified
org.xml.sax.helpers.DefaultHandler . | | public void | parse(File f, HandlerBase hb)
Parse the content of the file specified as XML using the
specified
org.xml.sax.HandlerBase . | | public void | parse(File f, DefaultHandler dh)
Parse the content of the file specified as XML using the
specified
org.xml.sax.helpers.DefaultHandler . | | public void | parse(InputSource is, HandlerBase hb)
Parse the content given
org.xml.sax.InputSource as XML using the specified
org.xml.sax.HandlerBase . | | public void | parse(InputSource is, DefaultHandler dh)
Parse the content given
org.xml.sax.InputSource as XML using the specified
org.xml.sax.helpers.DefaultHandler . | | public void | reset()
Reset this SAXParser to its original configuration.
SAXParser is reset to the same state as when it was created with
SAXParserFactory.newSAXParser .
reset() is designed to allow the reuse of existing SAXParsers
thus saving resources associated with the creation of new SAXParsers.
The reset SAXParser is not guaranteed to have the same
Schema Object, e.g. | | abstract public void | setProperty(String name, Object value)
Sets the particular property in the underlying implementation of
org.xml.sax.XMLReader . |
| getParser | | abstract public org.xml.sax.Parser getParser() throws SAXException(Code) | | Returns the SAX parser that is encapsultated by the
implementation of this class.
The SAX parser that is encapsultated by theimplementation of this class.
throws:
SAXException - If any SAX errors occur during processing. |
| getSchema | | public Schema getSchema()(Code) | | Get a reference to the the
Schema being used by
the XML processor.
If no schema is being used, null is returned.
Schema being used or nullif none in use
throws:
UnsupportedOperationException - When implementation does notoverride this method
since:
1.5 |
| isNamespaceAware | | abstract public boolean isNamespaceAware()(Code) | | Indicates whether or not this parser is configured to
understand namespaces.
true if this parser is configured tounderstand namespaces; false otherwise. |
| isValidating | | abstract public boolean isValidating()(Code) | | Indicates whether or not this parser is configured to
validate XML documents.
true if this parser is configured tovalidate XML documents; false otherwise. |
| reset | | public void reset()(Code) | | Reset this SAXParser to its original configuration.
SAXParser is reset to the same state as when it was created with
SAXParserFactory.newSAXParser .
reset() is designed to allow the reuse of existing SAXParsers
thus saving resources associated with the creation of new SAXParsers.
The reset SAXParser is not guaranteed to have the same
Schema Object, e.g.
Object.equals(Object obj) . It is guaranteed to have a functionally equal
Schema.
throws:
UnsupportedOperationException - When Implementations do notoverride this method
since:
1.5 |
|
|
|