DocumentPrinterUsingDom

DOM-based Document printer.

It may be the case that the DocumentPrinter does not indent. See bug http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6296446. This problem appears especially when creating a Document from scratch, using NodeBuilders. A possible (implementation-specific!) workaround is to create the DocumentPrinter as follows:

val documentBuilderFactory: DocumentBuilderFactory = DocumentBuilderFactory.newInstance

val transformerFactory: TransformerFactory = TransformerFactory.newInstance
transformerFactory.setAttribute("indent-number", java.lang.Integer.valueOf(2))

val documentPrinter = DocumentPrinterUsingDom.newInstance(documentBuilderFactory, transformerFactory)

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

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

Notes on HTML

In order to serialize a yaidom Document as HTML (which could have been parsed using the TagSoup library), a "transformer creator" can be coded as follows:

val trCreator = { (tf: TransformerFactory) =>
  val t = tf.newTransformer
  t.setOutputProperty(OutputKeys.METHOD, "html")
  t
}

This "transformer creator" is then passed as one of the arguments during DocumentPrinter construction.

Using such a DocumentPrinter configured for "HTML serialization", the serialized HTML is hopefully better understood by browsers than would have been the case with a DocumentPrinter configured for "XML serialization". For example, script tags (with empty content) are typically not written as self-closing tags in the first case, whereas they are in the second case.

If a DocumentPrinter is not explicitly configured for either "HTML or XML serialization", it may still be the case that HTML is serialized as HTML, depending on the TrAX implementation. Yet it is likely that in that case other elements than the document element would be serialized as XML instead of HTML. After all, (immutable) yaidom elements do not know about their ancestry.

Linear Supertypes

AbstractDocumentPrinter, DocumentPrinter, AnyRef, Any

Instance Constructors

new DocumentPrinterUsingDom(docBuilderFactory: DocumentBuilderFactory, docBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder, transformerFactory: TransformerFactory, transformerCreator: (TransformerFactory) ⇒ Transformer, documentConverter: DocumentConverter[DocumentProducer])

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 docBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder
val docBuilderFactory: DocumentBuilderFactory
val documentConverter: DocumentConverter[DocumentProducer]
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 omittingXmlDeclaration: DocumentPrinterUsingDom

Returns a copy of this DocumentPrinter that omits XML declarations
Returns a copy of this DocumentPrinter that omits XML declarations

Definition Classes
DocumentPrinterUsingDom → DocumentPrinter
def print(doc: Document): String

Converts the Document to a String.
Converts the Document to a String. May use a lot of memory for large XML documents.
To have more control over the character encoding of the output, when converting the String to bytes (and of the encoding mentioned in the XML declaration, if any), consider using one of the other overloaded print methods taking a Document.

Definition Classes
DocumentPrinterUsingDom → DocumentPrinter
def print(doc: Document, encoding: String, outputStream: OutputStream): Unit

Serializes the Document to an output stream, using the given encoding.
Serializes the Document to an output stream, using the given encoding. This method should close the output stream afterwards.
May use a lot of memory for large XML documents, although not as much as the print method that returns a byte array.

Definition Classes
DocumentPrinterUsingDom → DocumentPrinter
final def print(elm: Elem): String

Converts the Elem to a String, omitting the XML declaration.
Converts the Elem to a String, omitting the XML declaration. May use a lot of memory for large XML documents.
To have more control over the character encoding of the output, when converting the String to bytes (and of the encoding mentioned in the XML declaration, if any), consider using one of the other overloaded print methods taking an Elem.

Definition Classes
AbstractDocumentPrinter → DocumentPrinter
final def print(elm: Elem, encoding: String, outputStream: OutputStream): Unit

Serializes the Elem to an output stream, omitting the XML declaration.
Serializes the Elem to an output stream, omitting the XML declaration. This method should close the output stream afterwards.

Definition Classes
AbstractDocumentPrinter → DocumentPrinter
final def print(elm: Elem, encoding: String): Array[Byte]

Converts the Elem to a byte array, omitting the XML declaration
Converts the Elem to a byte array, omitting the XML declaration

Definition Classes
AbstractDocumentPrinter → DocumentPrinter
final def print(doc: Document, encoding: String): Array[Byte]

Converts the Document to a byte array, using the given encoding.
Converts the Document to a byte array, using the given encoding. May use a lot of memory for large XML documents.

Definition Classes
AbstractDocumentPrinter → DocumentPrinter
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
val transformerCreator: (TransformerFactory) ⇒ Transformer
val transformerFactory: TransformerFactory
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 withDocumentBuilderCreator(newDocBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder): DocumentPrinterUsingDom
def withDocumentConverter(newDocumentConverter: DocumentConverter[DocumentProducer]): DocumentPrinterUsingDom

Returns an adapted copy having the passed DocumentConverter.
Returns an adapted copy having the passed DocumentConverter. This method makes it possible to use an adapted document converter, which may be needed depending on the JAXP implementation used.
def withTransformerCreator(newTransformerCreator: (TransformerFactory) ⇒ Transformer): DocumentPrinterUsingDom
def withTransformerCreatorForHtml: DocumentPrinterUsingDom

Related Docs: object DocumentPrinterUsingDom | package print

final class DocumentPrinterUsingDom extends AbstractDocumentPrinter

Notes on HTML

Instance Constructors

new DocumentPrinterUsingDom(docBuilderFactory: DocumentBuilderFactory, docBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder, transformerFactory: TransformerFactory, transformerCreator: (TransformerFactory) ⇒ Transformer, documentConverter: DocumentConverter[DocumentProducer])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val docBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder

val docBuilderFactory: DocumentBuilderFactory

val documentConverter: DocumentConverter[DocumentProducer]

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 omittingXmlDeclaration: DocumentPrinterUsingDom

def print(doc: Document): String

def print(doc: Document, encoding: String, outputStream: OutputStream): Unit

final def print(elm: Elem): String

final def print(elm: Elem, encoding: String, outputStream: OutputStream): Unit

final def print(elm: Elem, encoding: String): Array[Byte]

final def print(doc: Document, encoding: String): Array[Byte]

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

def toString(): String

val transformerCreator: (TransformerFactory) ⇒ Transformer

val transformerFactory: TransformerFactory

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withDocumentBuilderCreator(newDocBuilderCreator: (DocumentBuilderFactory) ⇒ DocumentBuilder): DocumentPrinterUsingDom

def withDocumentConverter(newDocumentConverter: DocumentConverter[DocumentProducer]): DocumentPrinterUsingDom

def withTransformerCreator(newTransformerCreator: (TransformerFactory) ⇒ Transformer): DocumentPrinterUsingDom

def withTransformerCreatorForHtml: DocumentPrinterUsingDom

Inherited from AbstractDocumentPrinter

Inherited from DocumentPrinter

Inherited from AnyRef

Inherited from Any

Ungrouped