eu.cdevreeze.yaidom.parse

DocumentParserUsingDomLS

final class DocumentParserUsingDomLS extends AbstractDocumentParser

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()
  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
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DocumentParserUsingDomLS
  2. AbstractDocumentParser
  3. DocumentParser
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentParserUsingDomLS(domImplementation: DOMImplementationLS, parserCreator: (DOMImplementationLS) ⇒ LSParser)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  8. val domImplementation: DOMImplementationLS

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

  19. final def parse(file: File): Document

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

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

    Definition Classes
    AbstractDocumentParser → DocumentParser

  20. final def parse(uri: URI): Document

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

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

    Definition Classes
    AbstractDocumentParser → DocumentParser

  21. val parserCreator: (DOMImplementationLS) ⇒ LSParser

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

    Definition Classes
    AnyRef

  23. def toString(): String

    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

Inherited from AbstractDocumentParser

Inherited from DocumentParser

Inherited from AnyRef

Inherited from Any

Ungrouped