Build 1.0_r1(from source)

org.xmlpull.v1.sax2
Class Driver

java.lang.Object
  extended by org.xmlpull.v1.sax2.Driver
All Implemented Interfaces:
Attributes, Locator, XMLReader

public class Driver
extends Object
implements Locator, XMLReader, Attributes

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


Field Summary
protected static String APACHE_DYNAMIC_VALIDATION_FEATURE
           
protected static String APACHE_SCHEMA_VALIDATION_FEATURE
           
protected  ContentHandler contentHandler
           
protected static String DECLARATION_HANDLER_PROPERTY
           
protected  ErrorHandler errorHandler
           
protected static String LEXICAL_HANDLER_PROPERTY
           
protected static String NAMESPACE_PREFIXES_FEATURE
           
protected static String NAMESPACES_FEATURE
           
protected  XmlPullParser pp
           
protected  String systemId
           
protected static String VALIDATION_FEATURE
           
 
Constructor Summary
Driver()
           
Driver(XmlPullParser pp)
           
 
Method Summary
 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 qName)
          Look up an attribute's type by XML qualified (prefixed) name.
 String getType(String uri, String localName)
          Look up an attribute's type by Namespace 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(InputSource source)
          Parse an XML document.
 void parse(String systemId)
          Parse an XML document from a system identifier (URI).
 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  void startElement(String namespace, String localName, String qName)
          Calls startElement on the ContentHandler with this driver object as the Attributes implementation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DECLARATION_HANDLER_PROPERTY

protected static final String DECLARATION_HANDLER_PROPERTY
See Also:
Constant Field Values

LEXICAL_HANDLER_PROPERTY

protected static final String LEXICAL_HANDLER_PROPERTY
See Also:
Constant Field Values

NAMESPACES_FEATURE

protected static final String NAMESPACES_FEATURE
See Also:
Constant Field Values

NAMESPACE_PREFIXES_FEATURE

protected static final String NAMESPACE_PREFIXES_FEATURE
See Also:
Constant Field Values

VALIDATION_FEATURE

protected static final String VALIDATION_FEATURE
See Also:
Constant Field Values

APACHE_SCHEMA_VALIDATION_FEATURE

protected static final String APACHE_SCHEMA_VALIDATION_FEATURE
See Also:
Constant Field Values

APACHE_DYNAMIC_VALIDATION_FEATURE

protected static final String APACHE_DYNAMIC_VALIDATION_FEATURE
See Also:
Constant Field Values

contentHandler

protected ContentHandler contentHandler

errorHandler

protected ErrorHandler errorHandler

systemId

protected String systemId

pp

protected XmlPullParser pp
Constructor Detail

Driver

public Driver()
       throws XmlPullParserException
Throws:
XmlPullParserException

Driver

public Driver(XmlPullParser pp)
       throws XmlPullParserException
Throws:
XmlPullParserException
Method Detail

getLength

public int getLength()
Description copied from interface: Attributes
Return the number of attributes in the list.

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

Specified by:
getLength in interface Attributes
Returns:
The number of attributes in the list.
See Also:
Attributes.getURI(int), Attributes.getLocalName(int), Attributes.getQName(int), Attributes.getType(int), Attributes.getValue(int)

getURI

public String getURI(int index)
Description copied from interface: Attributes
Look up an attribute's Namespace URI by index.

Specified by:
getURI in interface Attributes
Parameters:
index - The attribute index (zero-based).
Returns:
The Namespace URI, or the empty string if none is available, or null if the index is out of range.
See Also:
Attributes.getLength()

getLocalName

public String getLocalName(int index)
Description copied from interface: Attributes
Look up an attribute's local name by index.

Specified by:
getLocalName in interface Attributes
Parameters:
index - The attribute index (zero-based).
Returns:
The local name, or the empty string if Namespace processing is not being performed, or null if the index is out of range.
See Also:
Attributes.getLength()

getQName

public String getQName(int index)
Description copied from interface: Attributes
Look up an attribute's XML qualified (prefixed) name by index.

Specified by:
getQName in interface Attributes
Parameters:
index - The attribute index (zero-based).
Returns:
The XML qualified name, or the empty string if none is available, or null if the index is out of range.
See Also:
Attributes.getLength()

getType

public String getType(int index)
Description copied from interface: Attributes
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".

Specified by:
getType in interface Attributes
Parameters:
index - The attribute index (zero-based).
Returns:
The attribute's type as a string, or null if the index is out of range.
See Also:
Attributes.getLength()

getValue

public String getValue(int index)
Description copied from interface: Attributes
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.

Specified by:
getValue in interface Attributes
Parameters:
index - The attribute index (zero-based).
Returns:
The attribute's value as a string, or null if the index is out of range.
See Also:
Attributes.getLength()

getIndex

public int getIndex(String uri,
                    String localName)
Description copied from interface: Attributes
Look up the index of an attribute by Namespace name.

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

getIndex

public int getIndex(String qName)
Description copied from interface: Attributes
Look up the index of an attribute by XML qualified (prefixed) name.

Specified by:
getIndex in interface Attributes
Parameters:
qName - The qualified (prefixed) name.
Returns:
The index of the attribute, or -1 if it does not appear in the list.

getType

public String getType(String uri,
                      String localName)
Description copied from interface: Attributes
Look up an attribute's type by Namespace name.

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

Specified by:
getType in interface Attributes
Parameters:
uri - The Namespace URI, or the empty String if the name has no Namespace URI.
localName - The local name of the attribute.
Returns:
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

public String getType(String qName)
Description copied from interface: Attributes
Look up an attribute's type by XML qualified (prefixed) name.

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

Specified by:
getType in interface Attributes
Parameters:
qName - The XML qualified name.
Returns:
The attribute type as a string, or null if the attribute is not in the list or if qualified names are not available.

getValue

public String getValue(String uri,
                       String localName)
Description copied from interface: Attributes
Look up an attribute's value by Namespace name.

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

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

getValue

public String getValue(String qName)
Description copied from interface: Attributes
Look up an attribute's value by XML qualified (prefixed) name.

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

Specified by:
getValue in interface Attributes
Parameters:
qName - The XML qualified name.
Returns:
The attribute value as a string, or null if the attribute is not in the list or if qualified names are not available.

getPublicId

public String getPublicId()
Description copied from interface: Locator
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.

Specified by:
getPublicId in interface Locator
Returns:
A string containing the public identifier, or null if none is available.
See Also:
Locator.getSystemId()

getSystemId

public String getSystemId()
Description copied from interface: Locator
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.

Specified by:
getSystemId in interface Locator
Returns:
A string containing the system identifier, or null if none is available.
See Also:
Locator.getPublicId()

getLineNumber

public int getLineNumber()
Description copied from interface: Locator
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.

Specified by:
getLineNumber in interface Locator
Returns:
The line number, or -1 if none is available.
See Also:
Locator.getColumnNumber()

getColumnNumber

public int getColumnNumber()
Description copied from interface: Locator
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.

Specified by:
getColumnNumber in interface Locator
Returns:
The column number, or -1 if none is available.
See Also:
Locator.getLineNumber()

getFeature

public boolean getFeature(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException
Description copied from interface: XMLReader
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.

Specified by:
getFeature in interface XMLReader
Parameters:
name - The feature name, which is a fully-qualified URI.
Returns:
The current value of the feature (true or false).
Throws:
SAXNotRecognizedException - If the feature value can't be assigned or retrieved.
SAXNotSupportedException - When the XMLReader recognizes the feature name but cannot determine its value at this time.
See Also:
XMLReader.setFeature(java.lang.String, boolean)

setFeature

public void setFeature(String name,
                       boolean value)
                throws SAXNotRecognizedException,
                       SAXNotSupportedException
Description copied from interface: XMLReader
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.

Specified by:
setFeature in interface XMLReader
Parameters:
name - The feature name, which is a fully-qualified URI.
value - The requested value of the feature (true or false).
Throws:
SAXNotRecognizedException - If the feature value can't be assigned or retrieved.
SAXNotSupportedException - When the XMLReader recognizes the feature name but cannot set the requested value.
See Also:
XMLReader.getFeature(java.lang.String)

getProperty

public Object getProperty(String name)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException
Description copied from interface: XMLReader
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.

Specified by:
getProperty in interface XMLReader
Parameters:
name - The property name, which is a fully-qualified URI.
Returns:
The current value of the property.
Throws:
SAXNotRecognizedException - If the property value can't be assigned or retrieved.
SAXNotSupportedException - When the XMLReader recognizes the property name but cannot determine its value at this time.
See Also:
XMLReader.setProperty(java.lang.String, java.lang.Object)

setProperty

public void setProperty(String name,
                        Object value)
                 throws SAXNotRecognizedException,
                        SAXNotSupportedException
Description copied from interface: XMLReader
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.

Specified by:
setProperty in interface XMLReader
Parameters:
name - The property name, which is a fully-qualified URI.
value - The requested value for the property.
Throws:
SAXNotRecognizedException - If the property value can't be assigned or retrieved.
SAXNotSupportedException - When the XMLReader recognizes the property name but cannot set the requested value.

setEntityResolver

public void setEntityResolver(EntityResolver resolver)
Description copied from interface: XMLReader
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.

Specified by:
setEntityResolver in interface XMLReader
Parameters:
resolver - The entity resolver.
See Also:
XMLReader.getEntityResolver()

getEntityResolver

public EntityResolver getEntityResolver()
Description copied from interface: XMLReader
Return the current entity resolver.

Specified by:
getEntityResolver in interface XMLReader
Returns:
The current entity resolver, or null if none has been registered.
See Also:
XMLReader.setEntityResolver(org.xml.sax.EntityResolver)

setDTDHandler

public void setDTDHandler(DTDHandler handler)
Description copied from interface: XMLReader
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.

Specified by:
setDTDHandler in interface XMLReader
Parameters:
handler - The DTD handler.
See Also:
XMLReader.getDTDHandler()

getDTDHandler

public DTDHandler getDTDHandler()
Description copied from interface: XMLReader
Return the current DTD handler.

Specified by:
getDTDHandler in interface XMLReader
Returns:
The current DTD handler, or null if none has been registered.
See Also:
XMLReader.setDTDHandler(org.xml.sax.DTDHandler)

setContentHandler

public void setContentHandler(ContentHandler handler)
Description copied from interface: XMLReader
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.

Specified by:
setContentHandler in interface XMLReader
Parameters:
handler - The content handler.
See Also:
XMLReader.getContentHandler()

getContentHandler

public ContentHandler getContentHandler()
Description copied from interface: XMLReader
Return the current content handler.

Specified by:
getContentHandler in interface XMLReader
Returns:
The current content handler, or null if none has been registered.
See Also:
XMLReader.setContentHandler(org.xml.sax.ContentHandler)

setErrorHandler

public void setErrorHandler(ErrorHandler handler)
Description copied from interface: XMLReader
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.

Specified by:
setErrorHandler in interface XMLReader
Parameters:
handler - The error handler.
See Also:
XMLReader.getErrorHandler()

getErrorHandler

public ErrorHandler getErrorHandler()
Description copied from interface: XMLReader
Return the current error handler.

Specified by:
getErrorHandler in interface XMLReader
Returns:
The current error handler, or null if none has been registered.
See Also:
XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)

parse

public void parse(InputSource source)
           throws SAXException,
                  IOException
Description copied from interface: XMLReader
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.

Specified by:
parse in interface XMLReader
Parameters:
source - The input source for the top-level of the XML document.
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
See Also:
InputSource, XMLReader.parse(java.lang.String), XMLReader.setEntityResolver(org.xml.sax.EntityResolver), XMLReader.setDTDHandler(org.xml.sax.DTDHandler), XMLReader.setContentHandler(org.xml.sax.ContentHandler), XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)

parse

public void parse(String systemId)
           throws SAXException,
                  IOException
Description copied from interface: XMLReader
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.

Specified by:
parse in interface XMLReader
Parameters:
systemId - The system identifier (URI).
Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.
See Also:
XMLReader.parse(org.xml.sax.InputSource)

parseSubTree

public void parseSubTree(XmlPullParser pp)
                  throws SAXException,
                         IOException
Throws:
SAXException
IOException

startElement

protected void startElement(String namespace,
                            String localName,
                            String qName)
                     throws SAXException
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.

Throws:
SAXException

Build 1.0_r1(from source)

Please submit a feedback, bug or feature