DocumentParserUsingDomLS

DOM-LS-based Document parser.

Typical non-trivial creation is as follows, assuming class MyEntityResolver, which extends LSResourceResolver, and class MyErrorHandler, which extends DOMErrorHandler:

def createParser(domImplLS: DOMImplementationLS): LSParser = {
  val parser = domImplLS.createLSParser(DOMImplementationLS.MODE_SYNCHRONOUS, null)
  parser.getDomConfig.setParameter("resource-resolver", new MyEntityResolver)
  parser.getDomConfig.setParameter("error-handler", new MyErrorHandler)
  parser
}

val domParser = DocumentParserUsingDomLS.newInstance().withParserCreator(createParser _)

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

class MyEntityResolver extends LSResourceResolver {
  override def resolveResource(tpe: String, namespaceURI: String, publicId: String, systemId: String, baseURI: String): LSInput = {
    val input = domImplLS.createLSInput()
    // This dirty hack may not work on IBM JVMs
    input.setCharacterStream(new jio.StringReader(""))
    input
  }
}

For completeness, a custom DOMErrorHandler class that simply throws an exception:

class MyErrorHandler extends DOMErrorHandler {
  override def handleError(exc: DOMError): Boolean = {
    sys.error(exc.toString)
  }
}

If more flexibility is needed in configuring the DocumentParser than offered by this class, consider writing a wrapper DocumentParser which wraps a DocumentParserUsingDomLS, but adapts the parse method. This would make it possible to set an encoding on the LSInput, for example. As another example, this would allow for adapting the conversion from a DOM Document to yaidom Document.

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

Linear Supertypes

AbstractDocumentParser, DocumentParser, AnyRef, Any

Instance Constructors

new DocumentParserUsingDomLS(domImplementation: DOMImplementationLS, parserCreator: (DOMImplementationLS) ⇒ LSParser, converterToDocument: ConverterToDocument[Document])

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[Document]
val domImplementation: DOMImplementationLS
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
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
DocumentParserUsingDomLS → 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
val parserCreator: (DOMImplementationLS) ⇒ LSParser
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[Document]): DocumentParserUsingDomLS

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.
def withParserCreator(newParserCreator: (DOMImplementationLS) ⇒ LSParser): DocumentParserUsingDomLS

Related Docs: object DocumentParserUsingDomLS | package parse

final class DocumentParserUsingDomLS extends AbstractDocumentParser

Instance Constructors

new DocumentParserUsingDomLS(domImplementation: DOMImplementationLS, parserCreator: (DOMImplementationLS) ⇒ LSParser, converterToDocument: ConverterToDocument[Document])

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[Document]

val domImplementation: DOMImplementationLS

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

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

val parserCreator: (DOMImplementationLS) ⇒ LSParser

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[Document]): DocumentParserUsingDomLS

def withParserCreator(newParserCreator: (DOMImplementationLS) ⇒ LSParser): DocumentParserUsingDomLS

Inherited from AbstractDocumentParser

Inherited from DocumentParser

Inherited from AnyRef

Inherited from Any

Ungrouped