gnu.xml.aelfred2

Class SAXDriver

public final class SAXDriver extends Object implements Locator, Attributes2, XMLReader, Parser, 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.

Version: $Date: 2001/11/19 18:27:20 $

Author: Written by David Megginson (version 1.2a from Microstar) Updated by David Brownell <dbrownell@users.sourceforge.net>

See Also: Parser

Constructor Summary
SAXDriver()
Constructs a SAX Parser.
Method Summary
intgetColumnNumber()
SAX Locator method (don't invoke on parser);
ContentHandlergetContentHandler()
SAX2: Returns the object used to report the logical content of an XML document.
DTDHandlergetDTDHandler()
SAX2: Returns the object used to process declarations related to notations and unparsed entities.
EntityResolvergetEntityResolver()
SAX2: Returns the object used when resolving external entities during parsing (both general and parameter entities).
ErrorHandlergetErrorHandler()
SAX2: Returns the object used to receive callbacks for XML errors of all levels (fatal, nonfatal, warning); this is never null;
booleangetFeature(String featureId)
SAX2: Tells the value of the specified feature flag.
intgetIndex(String uri, String local)
SAX2 Attributes method (don't invoke on parser);
intgetIndex(String xmlName)
SAX2 Attributes method (don't invoke on parser);
intgetLength()
SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);
intgetLineNumber()
SAX Locator method (don't invoke on parser);
StringgetLocalName(int index)
SAX2 Attributes method (don't invoke on parser);
StringgetName(int i)
SAX1 AttributeList method (don't invoke on parser);
ObjectgetProperty(String propertyId)
SAX2: Returns the specified property.
StringgetPublicId()
SAX Locator method (don't invoke on parser);
StringgetQName(int i)
SAX2 Attributes method (don't invoke on parser);
StringgetSystemId()
SAX Locator method (don't invoke on parser);
StringgetType(int i)
SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);
StringgetType(String uri, String local)
SAX2 Attributes method (don't invoke on parser);
StringgetType(String xmlName)
SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);
StringgetURI(int index)
SAX2 Attributes method (don't invoke on parser);
StringgetValue(int i)
SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);
StringgetValue(String uri, String local)
SAX Attributes method (don't invoke on parser);
StringgetValue(String xmlName)
SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);
booleanisSpecified(int index)
SAX-ext Attributes2 method (don't invoke on parser);
booleanisSpecified(String uri, String local)
SAX-ext Attributes2 method (don't invoke on parser);
booleanisSpecified(String xmlName)
SAX-ext Attributes2 method (don't invoke on parser);
voidparse(InputSource source)
SAX1, SAX2: Auxiliary API to parse an XML document, used mostly when no URI is available.
voidparse(String systemId)
SAX1, SAX2: Preferred API to parse an XML document, using a system identifier (URI).
voidsetContentHandler(ContentHandler handler)
SAX2: Assigns the object used to report the logical content of an XML document.
voidsetDocumentHandler(DocumentHandler handler)
SAX1: Set the document handler for this parser.
voidsetDTDHandler(DTDHandler handler)
SAX1, SAX2: Set the DTD handler for this parser.
voidsetEntityResolver(EntityResolver resolver)
SAX1, SAX2: Set the entity resolver for this parser.
voidsetErrorHandler(ErrorHandler handler)
SAX1, SAX2: Set the error handler for this parser.
voidsetFeature(String featureId, boolean value)
SAX2: Sets the state of feature flags in this parser.
voidsetLocale(Locale locale)
SAX1: Sets the locale used for diagnostics; currently, only locales using the English language are supported.
voidsetProperty(String propertyId, Object value)
SAX2: Assigns the specified property.

Constructor Detail

SAXDriver

public SAXDriver()
Constructs a SAX Parser.

Method Detail

getColumnNumber

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

getContentHandler

public ContentHandler getContentHandler()
SAX2: Returns the object used to report the logical content of an XML document.

getDTDHandler

public DTDHandler getDTDHandler()
SAX2: Returns the object used to process declarations related to notations and unparsed entities.

getEntityResolver

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

getErrorHandler

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

getFeature

public boolean getFeature(String featureId)
SAX2: Tells the value of the specified feature flag.

Throws: SAXNotRecognizedException thrown if the feature flag is neither built in, nor yet assigned.

getIndex

public int getIndex(String uri, String local)
SAX2 Attributes method (don't invoke on parser);

getIndex

public int getIndex(String xmlName)
SAX2 Attributes method (don't invoke on parser);

getLength

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

getLineNumber

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

getLocalName

public String getLocalName(int index)
SAX2 Attributes method (don't invoke on parser);

getName

public String getName(int i)
SAX1 AttributeList method (don't invoke on parser);

getProperty

public Object getProperty(String propertyId)
SAX2: Returns the specified property.

Throws: SAXNotRecognizedException thrown if the property value is neither built in, nor yet stored.

getPublicId

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

getQName

public String getQName(int i)
SAX2 Attributes method (don't invoke on parser);

getSystemId

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

getType

public String getType(int i)
SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);

getType

public String getType(String uri, String local)
SAX2 Attributes method (don't invoke on parser);

getType

public String getType(String xmlName)
SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);

getURI

public String getURI(int index)
SAX2 Attributes method (don't invoke on parser);

getValue

public String getValue(int i)
SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);

getValue

public String getValue(String uri, String local)
SAX Attributes method (don't invoke on parser);

getValue

public String getValue(String xmlName)
SAX1 AttributeList, SAX2 Attributes method (don't invoke on parser);

isSpecified

public boolean isSpecified(int index)
SAX-ext Attributes2 method (don't invoke on parser);

isSpecified

public boolean isSpecified(String uri, String local)
SAX-ext Attributes2 method (don't invoke on parser);

isSpecified

public boolean isSpecified(String xmlName)
SAX-ext Attributes2 method (don't invoke on parser);

parse

public void parse(InputSource source)
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.

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

Throws: SAXException The handlers may throw any SAXException, and the parser normally throws SAXParseException objects. IOException IOExceptions are normally through through the parser if there are problems reading the source document.

See Also: SAXDriver SAXDriver SAXDriver SAXDriver

parse

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

setContentHandler

public void setContentHandler(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).

setDocumentHandler

public void setDocumentHandler(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).

Parameters: handler The object to receive document events.

setDTDHandler

public void setDTDHandler(DTDHandler handler)
SAX1, SAX2: Set the DTD handler for this parser.

Parameters: handler The object to receive DTD events.

setEntityResolver

public void setEntityResolver(EntityResolver resolver)
SAX1, SAX2: Set the entity resolver for this parser.

Parameters: handler The object to receive entity events.

setErrorHandler

public void setErrorHandler(ErrorHandler handler)
SAX1, SAX2: Set the error handler for this parser.

Parameters: handler The object to receive error events.

setFeature

public void setFeature(String featureId, boolean value)
SAX2: Sets the state of feature flags in this parser. Some built-in feature flags are mutable.

setLocale

public void setLocale(Locale locale)
SAX1: Sets the locale used for diagnostics; currently, only locales using the English language are supported.

Parameters: locale The locale for which diagnostics will be generated

setProperty

public void setProperty(String propertyId, Object value)
SAX2: Assigns the specified property. Like SAX1 handlers, these may be changed at any time.

Source code is under GPL (with library exception) in the JAXP project at http://www.gnu.org/software/classpathx/jaxp
This documentation was derived from that source code on 2011-08-26.