| org.xml.sax.Parser
All known Subclasses: com.quadcap.text.sax.Parser,
| Parser | | public interface Parser (Code) | | Basic interface for SAX (Simple API for XML) parsers.
All SAX parsers must implement this basic interface: it allows
applications to register handlers for different types of events
and to initiate a parse from a URI, or a character stream.
All SAX parsers must also implement a zero-argument constructor
(though other constructors are also allowed).
SAX parsers are reusable but not re-entrant: the application
may reuse a parser object (possibly with a different input source)
once the first parse has completed successfully, but it may not
invoke the parse() methods recursively within a parse.
author:
David Megginson (ak117@freenet.carleton.ca)
version:
1.0
See Also: org.xml.sax.EntityResolver
See Also: org.xml.sax.DTDHandler
See Also: org.xml.sax.DocumentHandler
See Also: org.xml.sax.ErrorHandler
See Also: org.xml.sax.HandlerBase
See Also: org.xml.sax.InputSource |
| Method Summary | |
| abstract public void | parse(InputSource source)
Parse an XML document.
The application can use this method to instruct the SAX parser
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 Parser instead for each
additional XML document). | | abstract public void | parse(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. | | abstract public void | setDTDHandler(DTDHandler handler)
Allow an application to register a DTD event handler. | | abstract public void | setDocumentHandler(DocumentHandler handler)
Allow an application to register a document event handler. | | abstract public void | setEntityResolver(EntityResolver resolver)
Allow an application to register a custom entity resolver. | | abstract public void | setErrorHandler(ErrorHandler handler)
Allow an application to register an error event handler. | | abstract public void | setLocale(Locale locale)
Allow an application to request a locale for errors and warnings.
SAX parsers are not required to provide localisation for errors
and warnings; if they cannot support the requested locale,
however, they must throw a SAX exception. |
| parse | | abstract public void parse(String systemId) throws SAXException, IOException(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:
java.io.IOException - An IO exception from the parser,possibly from a byte stream or character streamsupplied by the application.
See Also: Parser.parse(org.xml.sax.InputSource) |
| setDTDHandler | | abstract 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 (this is the default behaviour implemented by
HandlerBase).
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: DTDHandler
See Also: HandlerBase |
| setDocumentHandler | | abstract public void setDocumentHandler(DocumentHandler handler)(Code) | | Allow an application to register a document event handler.
If the application does not register a document handler, all
document events reported by the SAX parser will be silently
ignored (this is the default behaviour implemented by
HandlerBase).
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 document handler.
See Also: DocumentHandler
See Also: HandlerBase |
| setEntityResolver | | abstract public void setEntityResolver(EntityResolver resolver)(Code) | | Allow an application to register a custom entity resolver.
If the application does not register an entity resolver, the
SAX parser will resolve system identifiers and open connections
to entities itself (this is the default behaviour implemented in
HandlerBase).
Applications may register a new or different entity resolver
in the middle of a parse, and the SAX parser must begin using
the new resolver immediately.
Parameters:
resolver - The object for resolving entities.
See Also: EntityResolver
See Also: HandlerBase |
| setErrorHandler | | abstract public void setErrorHandler(ErrorHandler handler)(Code) | | Allow an application to register an error event handler.
If the application does not register an error event handler,
all error events reported by the SAX parser will be silently
ignored, except for fatalError, which will throw a SAXException
(this is the default behaviour implemented by HandlerBase).
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: ErrorHandler
See Also: SAXException
See Also: HandlerBase |
| setLocale | | abstract public void setLocale(Locale locale) throws SAXException(Code) | | Allow an application to request a locale for errors and warnings.
SAX parsers are not required to provide localisation for errors
and warnings; if they cannot support the requested locale,
however, they must throw a SAX exception. Applications may
not request a locale change in the middle of a parse.
Parameters:
locale - A Java Locale object.
exception:
org.xml.sax.SAXException - Throws an exception(using the previous or default locale) if the requested locale is not supported.
See Also: org.xml.sax.SAXException
See Also: org.xml.sax.SAXParseException |
|
|