Driver

APACHE_DYNAMIC_VALIDATION_FEATURE

protected static val APACHE_DYNAMIC_VALIDATION_FEATURE: String

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

APACHE_SCHEMA_VALIDATION_FEATURE

protected static val APACHE_SCHEMA_VALIDATION_FEATURE: String

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

DECLARATION_HANDLER_PROPERTY

protected static val DECLARATION_HANDLER_PROPERTY: String

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

LEXICAL_HANDLER_PROPERTY

protected static val LEXICAL_HANDLER_PROPERTY: String

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

NAMESPACES_FEATURE

protected static val NAMESPACES_FEATURE: String

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

NAMESPACE_PREFIXES_FEATURE

protected static val NAMESPACE_PREFIXES_FEATURE: String

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

VALIDATION_FEATURE

protected static val VALIDATION_FEATURE: String

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

Driver

Driver()

Driver

Driver(pp: XmlPullParser!)

getColumnNumber

open fun getColumnNumber(): Int

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.

getContentHandler

open fun getContentHandler(): ContentHandler!

Return the current content handler.

getDTDHandler

open fun getDTDHandler(): DTDHandler!

Return the current DTD handler.

getEntityResolver

open fun getEntityResolver(): EntityResolver!

Return the current entity resolver.

getErrorHandler

open fun getErrorHandler(): ErrorHandler!

Return the current error handler.

getFeature

open fun getFeature(name: String!): Boolean

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.

getIndex

open fun getIndex(qName: String!): Int

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

getIndex

open fun getIndex(
    uri: String!, 
    localName: String!
): Int

Look up the index of an attribute by Namespace name.

getLength

open fun getLength(): Int

Return the number of attributes in the list.

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

getLineNumber

open fun getLineNumber(): Int

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.

getLocalName

open fun getLocalName(index: Int): String!

Look up an attribute's local name by index.

getProperty

open fun getProperty(name: String!): Any!

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.

getPublicId

open fun getPublicId(): String!

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.

getQName

open fun getQName(index: Int): String!

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

getSystemId

open fun getSystemId(): String!

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.

getType

open fun getType(index: Int): String!

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".

getType

open fun getType(qName: String!): String!

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

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

getType

open fun getType(
    uri: String!, 
    localName: String!
): String!

Look up an attribute's type by Namespace name.

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

getURI

open fun getURI(index: Int): String!

Look up an attribute's Namespace URI by index.

getValue

open fun getValue(index: Int): String!

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.

getValue

open fun getValue(qName: String!): String!

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

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

getValue

open fun getValue(
    uri: String!, 
    localName: String!
): String!

Look up an attribute's value by Namespace name.

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

parse

open fun parse(systemId: String!): Unit

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.

parse

open fun parse(source: InputSource!): Unit

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.

parseSubTree

open fun parseSubTree(pp: XmlPullParser!): Unit

setContentHandler

open fun setContentHandler(handler: ContentHandler!): Unit

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.

setDTDHandler

open fun setDTDHandler(handler: DTDHandler!): Unit

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.

setEntityResolver

open fun setEntityResolver(resolver: EntityResolver!): Unit

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.

setErrorHandler

open fun setErrorHandler(handler: ErrorHandler!): Unit

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.

setFeature

open fun setFeature(
    name: String!, 
    value: Boolean
): Unit

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.

setProperty

open fun setProperty(
    name: String!, 
    value: Any!
): Unit

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.

startElement

protected open fun startElement(
    namespace: String!, 
    localName: String!, 
    qName: String!
): Unit

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.

contentHandler

protected var contentHandler: ContentHandler!

errorHandler

protected var errorHandler: ErrorHandler!

pp

protected var pp: XmlPullParser!

systemId

protected var systemId: String!