eu.cdevreeze.yaidom.parse

DocumentParserUsingDom

final class DocumentParserUsingDom extends AbstractDocumentParser

DOM-based Document parser.

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

val dbf = DocumentBuilderFactory.newInstance()
dbf.setNamespaceAware(true)

def createDocumentBuilder(dbf: DocumentBuilderFactory): DocumentBuilder = {
  val db = dbf.newDocumentBuilder()
  db.setEntityResolver(new MyEntityResolver)
  db.setErrorHandler(new MyErrorHandler)
  db
}

val docParser = DocumentParserUsingDom.newInstance(dbf, createDocumentBuilder _)

If we want the DocumentBuilderFactory to be a validating one, using an XML Schema, we could obtain the DocumentBuilderFactory as follows:

val schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI)
val schemaSource = new StreamSource(new File(pathToSchema))
val schema = schemaFactory.newSchema(schemaSource)

val dbf = {
  val result = DocumentBuilderFactory.newInstance()
  result.setNamespaceAware(true)
  result.setSchema(schema)
  result
}

A custom EntityResolver 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 EntityResolver {
override def resolveEntity(publicId: String, systemId: String): InputSource = {
  // This dirty hack may not work on IBM JVMs
  new InputSource(new java.io.StringReader(""))
}
}

For completeness, a custom ErrorHandler class that simply prints parse exceptions to standard output:

class MyErrorHandler extends ErrorHandler {
def warning(exc: SAXParseException): Unit = { println(exc) }
def error(exc: SAXParseException): Unit = { println(exc) }
def fatalError(exc: SAXParseException): Unit = { println(exc) }
}

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

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

Linear Supertypes
AbstractDocumentParser, DocumentParser, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DocumentParserUsingDom
  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 DocumentParserUsingDom(docBuilderFactory: DocumentBuilderFactory, docBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder)

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 docBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder

  9. val docBuilderFactory: DocumentBuilderFactory

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

    Definition Classes
    AnyRef

  11. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  12. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  14. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  19. 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
    DocumentParserUsingDom → DocumentParser

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

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

  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( ... )

Inherited from AbstractDocumentParser

Inherited from DocumentParser

Inherited from AnyRef

Inherited from Any

Ungrouped