nu.validator.gnu.xml.aelfred2

Class SAXDriver

java.lang.Object

nu.validator.gnu.xml.aelfred2.SAXDriver

All Implemented Interfaces:

org.xml.sax.AttributeList, org.xml.sax.Attributes, org.xml.sax.ext.Attributes2, org.xml.sax.ext.Locator2, org.xml.sax.Locator, org.xml.sax.Parser, org.xml.sax.XMLReader

public final class SAXDriver
extends java.lang.Object
implements org.xml.sax.ext.Locator2, org.xml.sax.ext.Attributes2, org.xml.sax.XMLReader, org.xml.sax.Parser, org.xml.sax.AttributeList

An enhanced SAX2 version of Microstar's Ælfred XML parser. The enhancements primarily relate to significant improvements in conformance to the XML specification, and SAX2 support. Performance has been improved. See the package level documentation for more information.

Name	Notes
Features ... URL prefix is http://xml.org/sax/features/
(URL)/external-general-entities	Value defaults to true
(URL)/external-parameter-entities	Value defaults to true
(URL)/is-standalone	(PRELIMINARY) Returns true iff the document's parsing has started (some non-error event after startDocument() was reported) and the document's standalone flag is set.
(URL)/namespace-prefixes	Value defaults to false (but XML 1.0 names are always reported)
(URL)/lexical-handler/parameter-entities	Value is fixed at true
(URL)/namespaces	Value defaults to true
(URL)/resolve-dtd-uris	(PRELIMINARY) Value defaults to true
(URL)/string-interning	Value is fixed at true
(URL)/use-attributes2	(PRELIMINARY) Value is fixed at true
(URL)/use-entity-resolver2	(PRELIMINARY) Value defaults to true
(URL)/validation	Value is fixed at false
Handler Properties ... URL prefix is http://xml.org/sax/properties/
(URL)/declaration-handler	A declaration handler may be provided.
(URL)/lexical-handler	A lexical handler may be provided.

This parser currently implements the SAX1 Parser API, but it may not continue to do so in the future.

Author:

Written by David Megginson (version 1.2a from Microstar), Updated by David Brownell <[email protected]>

See Also:

Parser

Constructor Summary

Constructors

Constructor and Description
SAXDriver() Constructs a SAX Parser.

Method Summary

Modifier and Type	Method and Description
int	getColumnNumber() SAX Locator method (don't invoke on parser);
org.xml.sax.ContentHandler	getContentHandler() SAX2: Returns the object used to report the logical content of an XML document.
org.xml.sax.DTDHandler	getDTDHandler() SAX2: Returns the object used to process declarations related to notations and unparsed entities.
java.lang.String	getEncoding()
org.xml.sax.EntityResolver	getEntityResolver() SAX2: Returns the object used when resolving external entities during parsing (both general and parameter entities).
org.xml.sax.ErrorHandler	getErrorHandler() SAX2: Returns the object used to receive callbacks for XML errors of all levels (fatal, nonfatal, warning); this is never null;
boolean	getFeature(java.lang.String featureId) SAX2: Tells the value of the specified feature flag.
int	getIndex(java.lang.String xmlName) SAX2 Attributes method (don't invoke on parser);
int	getIndex(java.lang.String uri, java.lang.String local) SAX2 Attributes method (don't invoke on parser);
int	getLength() SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);
int	getLineNumber() SAX Locator method (don't invoke on parser);
java.lang.String	getLocalName(int index) SAX2 Attributes method (don't invoke on parser);
java.lang.String	getName(int index) SAX1 AttributeList method (don't invoke on parser);
java.lang.Object	getProperty(java.lang.String propertyId) SAX2: Returns the specified property.
java.lang.String	getPublicId() SAX Locator method (don't invoke on parser);
java.lang.String	getQName(int index) SAX2 Attributes method (don't invoke on parser);
java.lang.String	getSystemId() SAX Locator method (don't invoke on parser);
java.lang.String	getType(int index) SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);
java.lang.String	getType(java.lang.String xmlName) SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);
java.lang.String	getType(java.lang.String uri, java.lang.String local) SAX2 Attributes method (don't invoke on parser);
java.lang.String	getURI(int index) SAX2 Attributes method (don't invoke on parser);
java.lang.String	getValue(int index) SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);
java.lang.String	getValue(java.lang.String xmlName) SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);
java.lang.String	getValue(java.lang.String uri, java.lang.String local) SAX Attributes method (don't invoke on parser);
java.lang.String	getXMLVersion()
boolean	isDeclared(int index)
boolean	isDeclared(java.lang.String qName)
boolean	isDeclared(java.lang.String uri, java.lang.String localName)
boolean	isSpecified(int index) SAX-ext Attributes2 method (don't invoke on parser);
boolean	isSpecified(java.lang.String xmlName) SAX-ext Attributes2 method (don't invoke on parser);
boolean	isSpecified(java.lang.String uri, java.lang.String local) SAX-ext Attributes2 method (don't invoke on parser);
void	lockErrorHandler()
void	parse(org.xml.sax.InputSource source) SAX1, SAX2: Auxiliary API to parse an XML document, used mostly when no URI is available.
void	parse(java.lang.String systemId) SAX1, SAX2: Preferred API to parse an XML document, using a system identifier (URI).
void	setCharacterHandler(nu.validator.htmlparser.common.CharacterHandler characterHandler) Sets the characterHandler.
void	setContentHandler(org.xml.sax.ContentHandler handler) SAX2: Assigns the object used to report the logical content of an XML document.
void	setDocumentHandler(org.xml.sax.DocumentHandler handler) Deprecated. SAX2 programs should use the XMLReader interface and a ContentHandler.
void	setDTDHandler(org.xml.sax.DTDHandler handler) SAX1, SAX2: Set the DTD handler for this parser.
void	setEntityResolver(org.xml.sax.EntityResolver resolver) SAX1, SAX2: Set the entity resolver for this parser.
void	setErrorHandler(org.xml.sax.ErrorHandler handler) SAX1, SAX2: Set the error handler for this parser.
void	setFeature(java.lang.String featureId, boolean value) SAX2: Sets the state of feature flags in this parser.
void	setLocale(java.util.Locale locale) SAX1: Sets the locale used for diagnostics; currently, only locales using the English language are supported.
void	setProperty(java.lang.String propertyId, java.lang.Object value) SAX2: Assigns the specified property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SAXDriver

public SAXDriver()

Constructs a SAX Parser.

Method Detail

setLocale

public void setLocale(java.util.Locale locale)
               throws org.xml.sax.SAXException

SAX1: Sets the locale used for diagnostics; currently, only locales using the English language are supported.

Specified by:

setLocale in interface org.xml.sax.Parser

Parameters:

locale - The locale for which diagnostics will be generated

Throws:

org.xml.sax.SAXException

getEntityResolver

public org.xml.sax.EntityResolver getEntityResolver()

SAX2: Returns the object used when resolving external entities during parsing (both general and parameter entities).

Specified by:

getEntityResolver in interface org.xml.sax.XMLReader

setEntityResolver

public void setEntityResolver(org.xml.sax.EntityResolver resolver)

SAX1, SAX2: Set the entity resolver for this parser.

Specified by:

setEntityResolver in interface org.xml.sax.Parser

Specified by:

setEntityResolver in interface org.xml.sax.XMLReader

Parameters:

resolver -

getDTDHandler

public org.xml.sax.DTDHandler getDTDHandler()

SAX2: Returns the object used to process declarations related to notations and unparsed entities.

Specified by:

getDTDHandler in interface org.xml.sax.XMLReader

setDTDHandler

public void setDTDHandler(org.xml.sax.DTDHandler handler)

SAX1, SAX2: Set the DTD handler for this parser.

Specified by:

setDTDHandler in interface org.xml.sax.Parser

Specified by:

setDTDHandler in interface org.xml.sax.XMLReader

Parameters:

handler - The object to receive DTD events.

setDocumentHandler

@Deprecated
public void setDocumentHandler(org.xml.sax.DocumentHandler handler)

Deprecated. SAX2 programs should use the XMLReader interface and a ContentHandler.

SAX1: Set the document handler for this parser. If a content handler was set, this document handler will supplant it. The parser is set to report all XML 1.0 names rather than to filter out "xmlns" attributes (the "namespace-prefixes" feature is set to true).

Specified by:

setDocumentHandler in interface org.xml.sax.Parser

Parameters:

handler - The object to receive document events.

getContentHandler

public org.xml.sax.ContentHandler getContentHandler()

SAX2: Returns the object used to report the logical content of an XML document.

Specified by:

getContentHandler in interface org.xml.sax.XMLReader

setContentHandler

public void setContentHandler(org.xml.sax.ContentHandler handler)

SAX2: Assigns the object used to report the logical content of an XML document. If a document handler was set, this content handler will supplant it (but XML 1.0 style name reporting may remain enabled).

Specified by:

setContentHandler in interface org.xml.sax.XMLReader

lockErrorHandler

public void lockErrorHandler()

setErrorHandler

public void setErrorHandler(org.xml.sax.ErrorHandler handler)

SAX1, SAX2: Set the error handler for this parser.

Specified by:

setErrorHandler in interface org.xml.sax.Parser

Specified by:

setErrorHandler in interface org.xml.sax.XMLReader

Parameters:

handler - The object to receive error events.

getErrorHandler

public org.xml.sax.ErrorHandler getErrorHandler()

SAX2: Returns the object used to receive callbacks for XML errors of all levels (fatal, nonfatal, warning); this is never null;

Specified by:

getErrorHandler in interface org.xml.sax.XMLReader

parse

public void parse(org.xml.sax.InputSource source)
           throws org.xml.sax.SAXException,
                  java.io.IOException

SAX1, SAX2: Auxiliary API to parse an XML document, used mostly when no URI is available. If you want anything useful to happen, you should set at least one type of handler.

Specified by:

parse in interface org.xml.sax.Parser

Specified by:

parse in interface org.xml.sax.XMLReader

Parameters:

source - The XML input source. Don't set 'encoding' unless you know for a fact that it's correct.

Throws:

org.xml.sax.SAXException - The handlers may throw any SAXException, and the parser normally throws SAXParseException objects.

java.io.IOException - IOExceptions are normally through through the parser if there are problems reading the source document.

See Also:

setEntityResolver(org.xml.sax.EntityResolver), setDTDHandler(org.xml.sax.DTDHandler), setContentHandler(org.xml.sax.ContentHandler), setErrorHandler(org.xml.sax.ErrorHandler)

parse

public void parse(java.lang.String systemId)
           throws org.xml.sax.SAXException,
                  java.io.IOException

SAX1, SAX2: Preferred API to parse an XML document, using a system identifier (URI).

Specified by:

parse in interface org.xml.sax.Parser

Specified by:

parse in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXException

java.io.IOException

getFeature

public boolean getFeature(java.lang.String featureId)
                   throws org.xml.sax.SAXNotRecognizedException,
                          org.xml.sax.SAXNotSupportedException

SAX2: Tells the value of the specified feature flag.

Specified by:

getFeature in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException - thrown if the feature flag is neither built in, nor yet assigned.

org.xml.sax.SAXNotSupportedException

getProperty

public java.lang.Object getProperty(java.lang.String propertyId)
                             throws org.xml.sax.SAXNotRecognizedException

SAX2: Returns the specified property.

Specified by:

getProperty in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException - thrown if the property value is neither built in, nor yet stored.

setFeature

public void setFeature(java.lang.String featureId,
                       boolean value)
                throws org.xml.sax.SAXNotRecognizedException,
                       org.xml.sax.SAXNotSupportedException

SAX2: Sets the state of feature flags in this parser. Some built-in feature flags are mutable.

Specified by:

setFeature in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

setProperty

public void setProperty(java.lang.String propertyId,
                        java.lang.Object value)
                 throws org.xml.sax.SAXNotRecognizedException,
                        org.xml.sax.SAXNotSupportedException

SAX2: Assigns the specified property. Like SAX1 handlers, these may be changed at any time.

Specified by:

setProperty in interface org.xml.sax.XMLReader

Throws:

org.xml.sax.SAXNotRecognizedException

org.xml.sax.SAXNotSupportedException

getLength

public int getLength()

SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);

Specified by:

getLength in interface org.xml.sax.AttributeList

Specified by:

getLength in interface org.xml.sax.Attributes

getURI

public java.lang.String getURI(int index)

SAX2 Attributes method (don't invoke on parser);

Specified by:

getURI in interface org.xml.sax.Attributes

getLocalName

public java.lang.String getLocalName(int index)

SAX2 Attributes method (don't invoke on parser);

Specified by:

getLocalName in interface org.xml.sax.Attributes

getQName

public java.lang.String getQName(int index)

SAX2 Attributes method (don't invoke on parser);

Specified by:

getQName in interface org.xml.sax.Attributes

getName

public java.lang.String getName(int index)

SAX1 AttributeList method (don't invoke on parser);

Specified by:

getName in interface org.xml.sax.AttributeList

getType

public java.lang.String getType(int index)

SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);

Specified by:

getType in interface org.xml.sax.AttributeList

Specified by:

getType in interface org.xml.sax.Attributes

getValue

public java.lang.String getValue(int index)

SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);

Specified by:

getValue in interface org.xml.sax.AttributeList

Specified by:

getValue in interface org.xml.sax.Attributes

getIndex

public int getIndex(java.lang.String uri,
                    java.lang.String local)

SAX2 Attributes method (don't invoke on parser);

Specified by:

getIndex in interface org.xml.sax.Attributes

getIndex

public int getIndex(java.lang.String xmlName)

SAX2 Attributes method (don't invoke on parser);

Specified by:

getIndex in interface org.xml.sax.Attributes

getType

public java.lang.String getType(java.lang.String uri,
                                java.lang.String local)

SAX2 Attributes method (don't invoke on parser);

Specified by:

getType in interface org.xml.sax.Attributes

getType

public java.lang.String getType(java.lang.String xmlName)

SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);

Specified by:

getType in interface org.xml.sax.AttributeList

Specified by:

getType in interface org.xml.sax.Attributes

getValue

public java.lang.String getValue(java.lang.String uri,
                                 java.lang.String local)

SAX Attributes method (don't invoke on parser);

Specified by:

getValue in interface org.xml.sax.Attributes

getValue

public java.lang.String getValue(java.lang.String xmlName)

SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);

Specified by:

getValue in interface org.xml.sax.AttributeList

Specified by:

getValue in interface org.xml.sax.Attributes

isDeclared

public boolean isDeclared(int index)

Specified by:

isDeclared in interface org.xml.sax.ext.Attributes2

Returns:

false unless the attribute was declared in the DTD.

Throws:

java.lang.ArrayIndexOutOfBoundsException - When the supplied index does not identify an attribute.

isDeclared

public boolean isDeclared(java.lang.String qName)

Specified by:

isDeclared in interface org.xml.sax.ext.Attributes2

Returns:

false unless the attribute was declared in the DTD.

Throws:

java.lang.IllegalArgumentException - When the supplied names do not identify an attribute.

isDeclared

public boolean isDeclared(java.lang.String uri,
                          java.lang.String localName)

Specified by:

isDeclared in interface org.xml.sax.ext.Attributes2

Returns:

false unless the attribute was declared in the DTD.

Throws:

java.lang.IllegalArgumentException - When the supplied names do not identify an attribute.

isSpecified

public boolean isSpecified(int index)

SAX-ext Attributes2 method (don't invoke on parser);

Specified by:

isSpecified in interface org.xml.sax.ext.Attributes2

isSpecified

public boolean isSpecified(java.lang.String uri,
                           java.lang.String local)

SAX-ext Attributes2 method (don't invoke on parser);

Specified by:

isSpecified in interface org.xml.sax.ext.Attributes2

isSpecified

public boolean isSpecified(java.lang.String xmlName)

SAX-ext Attributes2 method (don't invoke on parser);

Specified by:

isSpecified in interface org.xml.sax.ext.Attributes2

getPublicId

public java.lang.String getPublicId()

SAX Locator method (don't invoke on parser);

Specified by:

getPublicId in interface org.xml.sax.Locator

getSystemId

public java.lang.String getSystemId()

SAX Locator method (don't invoke on parser);

Specified by:

getSystemId in interface org.xml.sax.Locator

getLineNumber

public int getLineNumber()

SAX Locator method (don't invoke on parser);

Specified by:

getLineNumber in interface org.xml.sax.Locator

getColumnNumber

public int getColumnNumber()

SAX Locator method (don't invoke on parser);

Specified by:

getColumnNumber in interface org.xml.sax.Locator

setCharacterHandler

public void setCharacterHandler(nu.validator.htmlparser.common.CharacterHandler characterHandler)

Sets the characterHandler.

Parameters:

characterHandler - the characterHandler to set

getEncoding

public java.lang.String getEncoding()

Specified by:

getEncoding in interface org.xml.sax.ext.Locator2

getXMLVersion

public java.lang.String getXMLVersion()

Specified by:

getXMLVersion in interface org.xml.sax.ext.Locator2