DocumentParserUsingStax

StAX-based Document parser.

Typical non-trivial creation is as follows, assuming a class MyXmlResolver, which extends XMLResolver, and a class MyXmlReporter, which extends XMLReporter:

val xmlInputFactory = XMLInputFactory.newFactory()
xmlInputFactory.setProperty(XMLInputFactory.IS_COALESCING, java.lang.Boolean.TRUE)
xmlInputFactory.setXMLResolver(new MyXmlResolver)
xmlInputFactory.setXMLReporter(new MyXmlReporter)

val docParser = DocumentParserUsingStax.newInstance(xmlInputFactory)

A custom XMLResolver could be used to retrieve DTDs locally, or even to suppress DTD resolution. The latter can be coded as follows (compare with http://stuartsierra.com/2008/05/08/stop-your-java-sax-parser-from-downloading-dtds), risking some loss of information:

class MyXmlResolver extends XMLResolver {
  override def resolveEntity(publicId: String, systemId: String, baseUri: String, namespace: String): Any = {
    // This dirty hack may not work on IBM JVMs
    new java.io.StringReader("")
  }
}

A trivial XMLReporter could look like this:

class MyXmlReporter extends XMLReporter {
  override def report(message: String, errorType: String, relatedInformation: AnyRef, location: Location): Unit = {
    println("Location: %s. Error type: %s. Message: %s.".format(location, errorType, message))
  }
}

If more flexibility is needed in configuring the DocumentParser than offered by this class, consider writing a wrapper DocumentParser which wraps a DocumentParserUsingStax, but adapts the parse method. This would make it possible to adapt the conversion from StAX events to yaidom Document, for example.

A DocumentParserUsingStax instance can be re-used multiple times, from the same thread. If the XMLInputFactory is thread-safe, it can even be re-used from multiple threads. Typically a XMLInputFactory cannot be trusted to be thread-safe, however. In a web application, one (safe) way to deal with that is to use one XMLInputFactory instance per request.

Linear Supertypes

AbstractDocumentParser, DocumentParser, AnyRef, Any

Instance Constructors

new DocumentParserUsingStax(inputFactory: XMLInputFactory, converterToDocument: ConverterToDocument[Iterator[XMLEvent]])

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val converterToDocument: ConverterToDocument[Iterator[XMLEvent]]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val inputFactory: XMLInputFactory
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parse(inputStream: InputStream): Document

Parses the input stream into a yaidom Document.
Parses the input stream into a yaidom Document. Closes the input stream afterwards.

Definition Classes
DocumentParserUsingStax → DocumentParser
final def parse(file: File): Document

Parses the content of the given File into a eu.cdevreeze.yaidom.simple.Document.
Parses the content of the given File into a eu.cdevreeze.yaidom.simple.Document.

Definition Classes
AbstractDocumentParser → DocumentParser
final def parse(uri: URI): Document

Parses the content of the given URI into a eu.cdevreeze.yaidom.simple.Document.
Parses the content of the given URI into a eu.cdevreeze.yaidom.simple.Document.

Definition Classes
AbstractDocumentParser → DocumentParser
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withConverterToDocument(newConverterToDocument: ConverterToDocument[Iterator[XMLEvent]]): DocumentParserUsingStax

Returns an adapted copy having the passed ConverterToDocument.
Returns an adapted copy having the passed ConverterToDocument. This method makes it possible to use an adapted converter, which may be needed depending on the JAXP implementation used.

Related Docs: object DocumentParserUsingStax | package parse

final class DocumentParserUsingStax extends AbstractDocumentParser

Instance Constructors

new DocumentParserUsingStax(inputFactory: XMLInputFactory, converterToDocument: ConverterToDocument[Iterator[XMLEvent]])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val converterToDocument: ConverterToDocument[Iterator[XMLEvent]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

val inputFactory: XMLInputFactory

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parse(inputStream: InputStream): Document

final def parse(file: File): Document

final def parse(uri: URI): Document

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withConverterToDocument(newConverterToDocument: ConverterToDocument[Iterator[XMLEvent]]): DocumentParserUsingStax

Inherited from AbstractDocumentParser

Inherited from DocumentParser

Inherited from AnyRef

Inherited from Any

Ungrouped