Driver

AI-generated Key Takeaways

• The Driver class is a SAX2 driver that converts XmlPullParser events into SAX2 callbacks.

• It implements the Locator, XMLReader, and Attributes interfaces, providing methods for parsing XML documents.

• The Driver class supports features like namespaces, validation, and lexical handling.

• It includes public methods for setting content handlers, error handlers, DTD handlers, entity resolvers, and features.

• Developers can use the parse() method to initiate parsing of an XML document from a system ID or an InputSource.

public class Driver extends Object
implements Locator XMLReader Attributes

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

Constant Summary

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

Field Summary

protected ContentHandler	contentHandler
protected ErrorHandler	errorHandler
protected XmlPullParser	pp
protected String	systemId

Public Constructor Summary

	Driver()
	Driver(XmlPullParser pp)

Public Method Summary

int	getColumnNumber()
ContentHandler	getContentHandler()
DTDHandler	getDTDHandler()
EntityResolver	getEntityResolver()
ErrorHandler	getErrorHandler()
boolean	getFeature(String name)
int	getIndex(String qName)
int	getIndex(String uri, String localName)
int	getLength()
int	getLineNumber()
String	getLocalName(int index)
Object	getProperty(String name)
String	getPublicId()
String	getQName(int index)
String	getSystemId()
String	getType(int index)
String	getType(String uri, String localName)
String	getType(String qName)
String	getURI(int index)
String	getValue(int index)
String	getValue(String qName)
String	getValue(String uri, String localName)
void	parse(String systemId)
void	parse(InputSource source)
void	parseSubTree(XmlPullParser pp)
void	setContentHandler(ContentHandler handler)
void	setDTDHandler(DTDHandler handler)
void	setEntityResolver(EntityResolver resolver)
void	setErrorHandler(ErrorHandler handler)
void	setFeature(String name, boolean value)
void	setProperty(String name, Object value)

Protected Method Summary

void	startElement(String namespace, String localName, String qName) Calls startElement on the ContentHandler with this driver object as the Attributes implementation.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface org.xml.sax.Locator

abstract int	getColumnNumber()
abstract int	getLineNumber()
abstract String	getPublicId()
abstract String	getSystemId()

From interface org.xml.sax.XMLReader

abstract ContentHandler	getContentHandler()
abstract DTDHandler	getDTDHandler()
abstract EntityResolver	getEntityResolver()
abstract ErrorHandler	getErrorHandler()
abstract boolean	getFeature(String arg0)
abstract Object	getProperty(String arg0)
abstract void	parse(InputSource arg0)
abstract void	parse(String arg0)
abstract void	setContentHandler(ContentHandler arg0)
abstract void	setDTDHandler(DTDHandler arg0)
abstract void	setEntityResolver(EntityResolver arg0)
abstract void	setErrorHandler(ErrorHandler arg0)
abstract void	setFeature(String arg0, boolean arg1)
abstract void	setProperty(String arg0, Object arg1)

From interface org.xml.sax.Attributes

abstract int	getIndex(String arg0)
abstract int	getIndex(String arg0, String arg1)
abstract int	getLength()
abstract String	getLocalName(int arg0)
abstract String	getQName(int arg0)
abstract String	getType(String arg0)
abstract String	getType(int arg0)
abstract String	getType(String arg0, String arg1)
abstract String	getURI(int arg0)
abstract String	getValue(String arg0)
abstract String	getValue(int arg0)
abstract String	getValue(String arg0, String arg1)

Constants

protected static final String APACHE_DYNAMIC_VALIDATION_FEATURE

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

protected static final String APACHE_SCHEMA_VALIDATION_FEATURE

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

protected static final String DECLARATION_HANDLER_PROPERTY

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

protected static final String LEXICAL_HANDLER_PROPERTY

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

protected static final String NAMESPACES_FEATURE

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

protected static final String NAMESPACE_PREFIXES_FEATURE

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

protected static final String VALIDATION_FEATURE

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

Fields

protected ContentHandler contentHandler

protected ErrorHandler errorHandler

protected XmlPullParser pp

protected String systemId

Public Constructors

public Driver ()

Throws

XmlPullParserException

public Driver (XmlPullParser pp)

Parameters

pp

Throws

XmlPullParserException

Public Methods

public int getColumnNumber ()

public ContentHandler getContentHandler ()

public DTDHandler getDTDHandler ()

public EntityResolver getEntityResolver ()

public ErrorHandler getErrorHandler ()

public boolean getFeature (String name)

Parameters

name

Throws

SAXNotRecognizedException
SAXNotSupportedException

public int getIndex (String qName)

Parameters

qName

public int getIndex (String uri, String localName)

Parameters

uri
localName

public int getLength ()

public int getLineNumber ()

public String getLocalName (int index)

Parameters

index

public Object getProperty (String name)

Parameters

name

Throws

SAXNotRecognizedException
SAXNotSupportedException

public String getPublicId ()

public String getQName (int index)

Parameters

index

public String getSystemId ()

public String getType (int index)

Parameters

index

public String getType (String uri, String localName)

Parameters

uri
localName

public String getType (String qName)

Parameters

qName

public String getURI (int index)

Parameters

index

public String getValue (int index)

Parameters

index

public String getValue (String qName)

Parameters

qName

public String getValue (String uri, String localName)

Parameters

uri
localName

public void parse (String systemId)

Parameters

systemId

Throws

SAXException
IOException

public void parse (InputSource source)

Parameters

source

Throws

SAXException
IOException

public void parseSubTree (XmlPullParser pp)

Parameters

pp

Throws

SAXException
IOException

public void setContentHandler (ContentHandler handler)

Parameters

handler

public void setDTDHandler (DTDHandler handler)

Parameters

handler

public void setEntityResolver (EntityResolver resolver)

Parameters

resolver

public void setErrorHandler (ErrorHandler handler)

Parameters

handler

public void setFeature (String name, boolean value)

Parameters

name
value

Throws

SAXNotRecognizedException
SAXNotSupportedException

public void setProperty (String name, Object value)

Parameters

name
value

Throws

SAXNotRecognizedException
SAXNotSupportedException

Protected Methods

protected 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
localName
qName

Throws

SAXException