Skip to content

Most visited

Recently visited

navigation

Driver

public class Driver
extends Object implements Locator, XMLReader, Attributes

java.lang.Object
   ↳ org.xmlpull.v1.sax2.Driver


SAX2 Driver that pulls events from XmlPullParser and converts them into SAX2 callbacks.

Summary

Constants

String APACHE_DYNAMIC_VALIDATION_FEATURE

String APACHE_SCHEMA_VALIDATION_FEATURE

String DECLARATION_HANDLER_PROPERTY

String LEXICAL_HANDLER_PROPERTY

String NAMESPACES_FEATURE

String NAMESPACE_PREFIXES_FEATURE

String VALIDATION_FEATURE

Fields

protected ContentHandler contentHandler

protected ErrorHandler errorHandler

protected XmlPullParser pp

protected String systemId

Public constructors

Driver()
Driver(XmlPullParser pp)

Public methods

int getColumnNumber()

Return the column number where the current document event ends.

ContentHandler getContentHandler()

Return the current content handler.

DTDHandler getDTDHandler()

Return the current DTD handler.

EntityResolver getEntityResolver()

Return the current entity resolver.

ErrorHandler getErrorHandler()

Return the current error handler.

boolean getFeature(String name)

Look up the value of a feature flag.

int getIndex(String qName)

Look up the index of an attribute by XML qualified (prefixed) name.

int getIndex(String uri, String localName)

Look up the index of an attribute by Namespace name.

int getLength()

Return the number of attributes in the list.

int getLineNumber()

Return the line number where the current document event ends.

String getLocalName(int index)

Look up an attribute's local name by index.

Object getProperty(String name)

Look up the value of a property.

String getPublicId()

Return the public identifier for the current document event.

String getQName(int index)

Look up an attribute's XML qualified (prefixed) name by index.

String getSystemId()

Return the system identifier for the current document event.

String getType(int index)

Look up an attribute's type by index.

String getType(String uri, String localName)

Look up an attribute's type by Namespace name.

String getType(String qName)

Look up an attribute's type by XML qualified (prefixed) name.

String getURI(int index)

Look up an attribute's Namespace URI by index.

String getValue(int index)

Look up an attribute's value by index.

String getValue(String qName)

Look up an attribute's value by XML qualified (prefixed) name.

String getValue(String uri, String localName)

Look up an attribute's value by Namespace name.

void parse(String systemId)

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

void parse(InputSource source)

Parse an XML document.

void parseSubTree(XmlPullParser pp)
void setContentHandler(ContentHandler handler)

Allow an application to register a content event handler.

void setDTDHandler(DTDHandler handler)

Allow an application to register a DTD event handler.

void setEntityResolver(EntityResolver resolver)

Allow an application to register an entity resolver.

void setErrorHandler(ErrorHandler handler)

Allow an application to register an error event handler.

void setFeature(String name, boolean value)

Set the value of a feature flag.

void setProperty(String name, Object value)

Set the value of a property.

Protected methods

void startElement(String namespace, String localName, String qName)

Calls startElement on the ContentHandler with this driver object as the Attributes implementation.

Inherited methods

From class java.lang.Object
From interface org.xml.sax.Locator
From interface org.xml.sax.XMLReader
From interface org.xml.sax.Attributes

Constants

APACHE_DYNAMIC_VALIDATION_FEATURE

Added in API level 1
String APACHE_DYNAMIC_VALIDATION_FEATURE

Constant Value: "http://apache.org/xml/features/validation/dynamic"

APACHE_SCHEMA_VALIDATION_FEATURE

Added in API level 1
String APACHE_SCHEMA_VALIDATION_FEATURE

Constant Value: "http://apache.org/xml/features/validation/schema"

DECLARATION_HANDLER_PROPERTY

Added in API level 1
String DECLARATION_HANDLER_PROPERTY

Constant Value: "http://xml.org/sax/properties/declaration-handler"

LEXICAL_HANDLER_PROPERTY

Added in API level 1
String LEXICAL_HANDLER_PROPERTY

Constant Value: "http://xml.org/sax/properties/lexical-handler"

NAMESPACES_FEATURE

Added in API level 1
String NAMESPACES_FEATURE

Constant Value: "http://xml.org/sax/features/namespaces"

NAMESPACE_PREFIXES_FEATURE

Added in API level 1
String NAMESPACE_PREFIXES_FEATURE

Constant Value: "http://xml.org/sax/features/namespace-prefixes"

VALIDATION_FEATURE

Added in API level 1
String VALIDATION_FEATURE

Constant Value: "http://xml.org/sax/features/validation"

Fields

contentHandler

Added in API level 1
ContentHandler contentHandler

errorHandler

Added in API level 1
ErrorHandler errorHandler

pp

Added in API level 1
XmlPullParser pp

systemId

Added in API level 1
String systemId

Public constructors

Driver

Added in API level 1
Driver ()

Throws
XmlPullParserException

Driver

Added in API level 1
Driver (XmlPullParser pp)

Parameters
pp XmlPullParser
Throws
XmlPullParserException

Public methods

getColumnNumber

Added in API level 1
int getColumnNumber ()

Return the column number where the current document event ends. This is one-based number of Java char values since the last line end.

Warning: The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. For example, when lines contain combining character sequences, wide characters, surrogate pairs, or bi-directional text, the value may not correspond to the column in a text editor's display.

The return value is an approximation of the column number in the document entity or external parsed entity where the markup triggering the event appears.

If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first column in each line is column 1.

Returns
int The column number, or -1 if none is available.

getContentHandler

Added in API level 1
ContentHandler getContentHandler ()

Return the current content handler.

Returns
ContentHandler The current content handler, or null if none has been registered.

getDTDHandler

Added in API level 1
DTDHandler getDTDHandler ()

Return the current DTD handler.

Returns
DTDHandler The current DTD handler, or null if none has been registered.

getEntityResolver

Added in API level 1
EntityResolver getEntityResolver ()

Return the current entity resolver.

Returns
EntityResolver The current entity resolver, or null if none has been registered.

getErrorHandler

Added in API level 1
ErrorHandler getErrorHandler ()

Return the current error handler.

Returns
ErrorHandler The current error handler, or null if none has been registered.

getFeature

Added in API level 1
boolean getFeature (String name)

Look up the value of a feature flag.

The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but temporarily be unable to return its value. Some feature values may be available only in specific contexts, such as before, during, or after a parse. Also, some feature values may not be programmatically accessible. (In the case of an adapter for SAX1 Parser, there is no implementation-independent way to expose whether the underlying parser is performing validation, expanding external entities, and so forth.)

All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names.

Typical usage is something like this:

 XMLReader r = new MySAXDriver();

                         // try to activate validation
 try {
   r.setFeature("http://xml.org/sax/features/validation", true);
 } catch (SAXException e) {
   System.err.println("Cannot activate validation.");
 }

                         // register event handlers
 r.setContentHandler(new MyContentHandler());
 r.setErrorHandler(new MyErrorHandler());

                         // parse the first document
 try {
   r.parse("http://www.foo.com/mydoc.xml");
 } catch (IOException e) {
   System.err.println("I/O exception reading XML document");
 } catch (SAXException e) {
   System.err.println("XML exception reading document.");
 }
 

Implementors are free (and encouraged) to invent their own features, using names built on their own URIs.

Parameters
name String: The feature name, which is a fully-qualified URI.
Returns
boolean The current value of the feature (true or false).
Throws
SAXNotRecognizedException
SAXNotSupportedException

getIndex

Added in API level 1
int getIndex (String qName)

Look up the index of an attribute by XML qualified (prefixed) name.

Parameters
qName String: The qualified (prefixed) name.
Returns
int The index of the attribute, or -1 if it does not appear in the list.

getIndex

Added in API level 1
int getIndex (String uri, 
                String localName)

Look up the index of an attribute by Namespace name.

Parameters
uri String: The Namespace URI, or the empty string if the name has no Namespace URI.
localName String: The attribute's local name.
Returns
int The index of the attribute, or -1 if it does not appear in the list.

getLength

Added in API level 1
int getLength ()

Return the number of attributes in the list.

Once you know the number of attributes, you can iterate through the list.

Returns
int The number of attributes in the list.

getLineNumber

Added in API level 1
int getLineNumber ()

Return the line number where the current document event ends. Lines are delimited by line ends, which are defined in the XML specification.

Warning: The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. In some cases, these "line" numbers match what would be displayed as columns, and in others they may not match the source text due to internal entity expansion.

The return value is an approximation of the line number in the document entity or external parsed entity where the markup triggering the event appears.

If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first line is line 1.

Returns
int The line number, or -1 if none is available.

getLocalName

Added in API level 1
String getLocalName (int index)

Look up an attribute's local name by index.

Parameters
index int: The attribute index (zero-based).
Returns
String The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range.

getProperty

Added in API level 1
Object getProperty (String name)

Look up the value of a property.

The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but temporarily be unable to return its value. Some property values may be available only in specific contexts, such as before, during, or after a parse.

XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.

Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.

Parameters
name String: The property name, which is a fully-qualified URI.
Returns
Object The current value of the property.
Throws
SAXNotRecognizedException
SAXNotSupportedException

getPublicId

Added in API level 1
String getPublicId ()

Return the public identifier for the current document event.

The return value is the public identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

Returns
String A string containing the public identifier, or null if none is available.

getQName

Added in API level 1
String getQName (int index)

Look up an attribute's XML qualified (prefixed) name by index.

Parameters
index int: The attribute index (zero-based).
Returns
String The XML qualified name, or the empty string if none is available, or null if the index is out of range.

getSystemId

Added in API level 1
String getSystemId ()

Return the system identifier for the current document event.

The return value is the system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application. For example, a file name must always be provided as a file:... URL, and other kinds of relative URI are also resolved against their bases.

Returns
String A string containing the system identifier, or null if none is available.

getType

Added in API level 1
String getType (int index)

Look up an attribute's type by index.

The attribute type is one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION" (always in upper case).

If the parser has not read a declaration for the attribute, or if the parser does not report attribute types, then it must return the value "CDATA" as stated in the XML 1.0 Recommendation (clause 3.3.3, "Attribute-Value Normalization").

For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".

Parameters
index int: The attribute index (zero-based).
Returns
String The attribute's type as a string, or null if the index is out of range.

getType

Added in API level 1
String getType (String uri, 
                String localName)

Look up an attribute's type by Namespace name.

See getType(int) for a description of the possible types.

Parameters
uri String: The Namespace URI, or the empty String if the name has no Namespace URI.
localName String: The local name of the attribute.
Returns
String The attribute type as a string, or null if the attribute is not in the list or if Namespace processing is not being performed.

getType

Added in API level 1
String getType (String qName)

Look up an attribute's type by XML qualified (prefixed) name.

See getType(int) for a description of the possible types.

Parameters
qName String: The XML qualified name.
Returns
String The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.

getURI

Added in API level 1
String getURI (int index)

Look up an attribute's Namespace URI by index.

Parameters
index int: The attribute index (zero-based).
Returns
String The Namespace URI, or the empty string if none is available, or null if the index is out of range.

getValue

Added in API level 1
String getValue (int index)

Look up an attribute's value by index.

If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.

Parameters
index int: The attribute index (zero-based).
Returns
String The attribute's value as a string, or null if the index is out of range.

getValue

Added in API level 1
String getValue (String qName)

Look up an attribute's value by XML qualified (prefixed) name.

See getValue(int) for a description of the possible values.

Parameters
qName String: The XML qualified name.
Returns
String The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available.

getValue

Added in API level 1
String getValue (String uri, 
                String localName)

Look up an attribute's value by Namespace name.

See getValue(int) for a description of the possible values.

Parameters
uri String: The Namespace URI, or the empty String if the name has no Namespace URI.
localName String: The local name of the attribute.
Returns
String The attribute value as a string, or null if the attribute is not in the list.

parse

Added in API level 1
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. 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 String: The system identifier (URI).
Throws
SAXException
IOException

parse

Added in API level 1
void parse (InputSource source)

Parse an XML document.

The application can use this method to instruct the XML reader 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 XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same XMLReader object, possibly with a different input source. Configuration of the XMLReader object (such as handler bindings and values established for feature flags and properties) is unchanged by completion of a parse, unless the definition of that aspect of the configuration explicitly specifies other behavior. (For example, feature flags or properties exposing characteristics of the document being parsed.)

During the parse, the XMLReader will provide information about the XML document through the registered event handlers.

This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.

Parameters
source InputSource: The input source for the top-level of the XML document.
Throws
SAXException
IOException

parseSubTree

Added in API level 1
void parseSubTree (XmlPullParser pp)

Parameters
pp XmlPullParser
Throws
SAXException
IOException

setContentHandler

Added in API level 1
void setContentHandler (ContentHandler handler)

Allow an application to register a content event handler.

If the application does not register a content handler, all content events reported by the SAX parser will be silently ignored.

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 ContentHandler: The content handler.

setDTDHandler

Added in API level 1
void setDTDHandler (DTDHandler handler)

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.

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 DTDHandler: The DTD handler.

setEntityResolver

Added in API level 1
void setEntityResolver (EntityResolver resolver)

Allow an application to register an entity resolver.

If the application does not register an entity resolver, the XMLReader will perform its own default resolution.

Applications may register a new or different resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.

Parameters
resolver EntityResolver: The entity resolver.

setErrorHandler

Added in API level 1
void setErrorHandler (ErrorHandler handler)

Allow an application to register an error event handler.

If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.

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 ErrorHandler: The error handler.

setFeature

Added in API level 1
void setFeature (String name, 
                boolean value)

Set the value of a feature flag.

The feature name is any fully-qualified URI. It is possible for an XMLReader to expose a feature value but to be unable to change the current value. Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

All XMLReaders are required to support setting http://xml.org/sax/features/namespaces to true and http://xml.org/sax/features/namespace-prefixes to false.

Parameters
name String: The feature name, which is a fully-qualified URI.
value boolean: The requested value of the feature (true or false).
Throws
SAXNotRecognizedException
SAXNotSupportedException

setProperty

Added in API level 1
void setProperty (String name, 
                Object value)

Set the value of a property.

The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to change the current value. Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

XMLReaders are not required to recognize setting any specific property names, though a core set is defined by SAX2.

This method is also the standard mechanism for setting extended handlers.

Parameters
name String: The property name, which is a fully-qualified URI.
value Object: The requested value for the property.
Throws
SAXNotRecognizedException
SAXNotSupportedException

Protected methods

startElement

Added in API level 1
void startElement (String namespace, 
                String localName, 
                String qName)

Calls startElement on the ContentHandler with this driver object as the Attributes implementation. In default implementation Attributes object is valid only during this method call and may not be stored. Sub-classes can overwrite this method to cache attributes.

Parameters
namespace String
localName String
qName String
Throws
SAXException
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.