INTERFACES

org.xml.sax.Attributes

processingInstruction

getLineNumber

Receive notification of a processing instruction.

Return the line number where the current document event ends.

void processingInstruction(String target, String data)

int getLineNumber()

getIndex

setDocumentLocator

getPublicId

Look up the index of an attribute by XML 1.0 qualified name.

Receive an object for locating the origin of SAX document events.

Return the public identifier for the current document event.

int getIndex(String qName)

Look up the index of an attribute by Namespace name.

int getIndex(String uri, String localPart)
getLength

Return the number of attributes in the list.

int getLength()
getLocalName

Look up an attribute's local name by index.

String getLocalName(int index)
getQName

Look up an attribute's XML 1.0 qualified name by index.

String getQName(int index)
getType

Look up an attribute's type by index.

String getType(int index)

Look up an attribute's type by XML 1.0 qualified name.

String getType(String qName)

Look up an attribute's type by Namespace name.

String getType(String uri, String localName)
getURI

Look up an attribute's Namespace URI by index.

String getURI(int index)
getValue

Look up an attribute's value by index.

String getValue(int index)

Look up an attribute's value by XML 1.0 qualified name.

String getValue(String qName)

Look up an attribute's value by Namespace name.

String getValue(String uri, String localName)

void setDocumentLocator(Locator locator)

getSystemId

Receive notification of a skipped entity.

Return the system identifier for the current document event.

void skippedEntity(String name)

String getSystemId()

startDocument

org.xml.sax.XMLFilter

Receive notification of the beginning of a document.

getParent

void startDocument()

Get the parent reader.

startElement

XMLReader getParent()

Receive notification of the beginning of an element.

void startElement(String namespaceURI,
String localName,
String qName,
Attributes atts)
startPrefixMapping
void startPrefixMapping(String prefix, String uri)

notationDecl

void endDocument()
endElement

Receive notification of the end of an element.

void endElement(String namespaceURI,
String localName,
String qName)
endPrefixMapping

End the scope of a prefix-URI mapping.

void endPrefixMapping(String prefix)
ignorableWhitespace

Receive notification of ignorable whitespace in element content.

void ignorableWhitespace(char[] ch, int start, int len)

org.xml.sax.XMLReader
Return the current content handler.

Return the current DTD handler.

Receive notification of a notation declaration event.

void notationDecl(String name,
String publicId, String systemId)

DTDHandler getDTDHandler()
getEntityResolver

unparsedEntityDecl

Return the current entity resolver.

Receive notification of an unparsed entity declaration event.

getErrorHandler

void unparsedEntityDecl(String
String
String
String

EntityResolver getEntityResolver()
name,
publicId,
systemId,
notationName)

org.xml.sax.EntityResolver
Allow the application to resolve external entities.

Receive notification of the end of a document.

void setParent(XMLReader parent)

getDTDHandler

characters

endDocument

Set the parent reader.

ContentHandler getContentHandler()

org.xml.sax.DTDHandler

org.xml.sax.ContentHandler

void characters(char[] ch, int start, int len)

setParent

getContentHandler

Begin the scope of a prefix-URI Namespace mapping.

resolveEntity

Receive notification of character data.

String getPublicId()

skippedEntity

InputSource resolveEntity(String publicId,

String systemId)

Return the current error handler.

ErrorHandler getErrorHandler()
getFeature

Look up the value of a feature.

boolean getFeature(String name)
getProperty

Look up the value of a property.

java.lang.Object getProperty(String name)

org.xml.sax.ErrorHandler

parse

error

Parse an XML document.

Receive notification of a recoverable error.

void error(SAXParseException exception)
fatalError

Receive notification of a non-recoverable error.

void fatalError(SAXParseException exception)
warning

Receive notification of a warning.

void warning(SAXParseException exception)

org.xml.sax.Locator
getColumnNumber

Return the column number where the current document event ends.
int getColumnNumber()

void parse(InputSource input)

Parse an XML document from a system identifier (URI).

void parse(String systemId)
setContentHandler

Allow an application to register a content event handler.

void setContentHandler(ContentHandler handler)
setDTDHandler

Allow an application to register a DTD event handler.

void setDTDHandler(DTDHandler handler)
setEntityResolver

Allow an application to register an entity resolver.

void setEntityResolver(EntityResolver resolver)

setErrorHandler

void setSystemId(String systemId)

EXCEPTIONS

Allow an application to register an error event handler.

void setErrorHandler(ErrorHandler handler)
setFeature

org.xml.sax.SAXException

Set the state of a feature.

SAXException

void setFeature(String name, boolean value)

setProperty

Create a new SAXException wrapping an existing exception.

Set the value of a property.

Create a new SAXException.

SAXException(java.lang.Exception e)

void setProperty(String name, Object value)

CLASSES
org.xml.sax.InputSource
A single input source for an XML entity.
InputSource

Zero-argument default constructor.

InputSource()

Create a new input source with a byte stream.

InputSource(java.io.InputStream byteStream)

Create a new input source with a character stream.

InputSource(java.io.Reader characterStream)

Create a new input source with a system identifier.

InputSource(String systemId)

SAXException(String message)

Create a new SAXException from an existing exception.

SAXException(String message, java.lang.Exception e)
getException

Return the embedded exception, if any.

java.lang.Exception getException()

String getMessage()

Override toString to pick up any embedded exception.

String toString()

org.xml.sax.SAXNotRecognizedException
Create a new SAXNotRecognizedException.
SAXNotRecognizedException(String message)

getCharacterStream

org.xml.sax.SAXNotSupportedException

Get the character stream for this input source.

SAXNotSupportedException

java.io.Reader getCharacterStream()
getEncoding

Create a new SAXNotSupportedException.

Get the character encoding for a byte stream or URI.

org.xml.sax.SAXParseException

SAXNotSupportedException(String message)

getPublicId

SAXParseException

Get the public identifier for this input source.

Create a new SAXParseException from a message and a Locator.

getSystemId

Get the system identifier for this input source.

String getSystemId()
setByteStream

Set the byte stream for this input source.

void setByteStream(java.io.InputStream byteStream)
setCharacterStream

Set the character stream for this input source.

void setCharacterStream(java.io.Reader characterStream)
setEncoding

Set the character encoding, if known.

void setEncoding(String encoding)
setPublicId

Set the public identifier for this input source.

void setPublicId(String publicId)
setSystemId

Set the system identifier for this input source.

5 May 2000

toString

SAXNotRecognizedException

String getPublicId()

Version 2 for Java (Core)

Return a detail message for this exception.

Get the byte stream for this input source.

String getEncoding()

Simple API for XML (SAX)

getMessage

getByteStream
java.io.InputStream getByteStream()

Quick Reference

SAXParseException(String msg, Locator l)

Create a SAXParseException from an existing Exception.

SAXParseException(String msg, Locator l, Exception e)

Create a new SAXParseException or wrap and existing Exception.

SAXParseException(String msg,
String publicId,
String systemId,
int lineNumber,
int columnNumber [, Exception e])
getColumnNumber

The column number of the end of the text where the exception occurred.
int getColumnNumber()
getLineNumber

The line number of the end of the text where the exception occurred.

http://www.saxproject.org/

The interfaces, classes and exceptions outlined below are taken from the
org.xml.sax package. This quick reference does not include deprecated
features.
Table of Contents:

Interfaces
Attributes
ContentHandler
DTDHandler
EntityResolver
ErrorHandler
Locator
XMLFilter
XMLReader
Classes
InputSource
Exceptions
SAXException
SAXNotRecognizedException
SAXNotSupportedException
SAXParseException

int getLineNumber()
getPublicId

Get the public identifier of the entity where the exception occurred.
java.lang.String getPublicId()
getSystemId

Get the system identifier of the entity where the exception occurred.
java.lang.String getSystemId()

deepX Ltd.
Dublin, Ireland
info@deepX.com
http://www.deepX.com/