Packages

  • package root

    org.apache.daffodil.sapi - Provides the classes necessary to compile DFDL schemas, parse and unparse files using the compiled objects, and retrieve results and parsing diagnostics

    Apache Daffodil (incubating) Scala API

    Packages

    org.apache.daffodil.sapi - Provides the classes necessary to compile DFDL schemas, parse and unparse files using the compiled objects, and retrieve results and parsing diagnostics

    org.apache.daffodil.sapi.logger - Provides the classes necessary to receive logging messages from Daffodil.

    org.apache.daffodil.sapi.debugger - Provides the classes necessary to perform parse tracing or create a custom debugger

    Definition Classes
    root
  • package org
    Definition Classes
    root
  • package apache
    Definition Classes
    org
  • package daffodil
    Definition Classes
    apache
  • package sapi

    Provides the classes necessary to compile DFDL schemas, parse and unparse files using the compiled objects, and retrieve results and parsing diagnostics

    Provides the classes necessary to compile DFDL schemas, parse and unparse files using the compiled objects, and retrieve results and parsing diagnostics

    Overview

    The Daffodil object is a factory object to create a Compiler. The Compiler provides a method to compils a provided DFDL schema into a ProcessorFactory, which creates a DataProcessor:

    val c = Daffodil.compiler()
val pf = c.compileFile(file)
val dp = pf.onPath("/")

    The DataProcessor provides the necessary functions to parse and unparse data, returning a ParseResult or UnparseResult, respectively. These contain information about the parse/unparse, such as whether or not the processing succeeded any diagnostic information.

    Parse

    The DataProcessor.parse method accepts input data to parse in the form of a InputSourceDataInputStream and an InfosetOutputter to determine the output representation of the infoset (e.g. Scala XML Nodes, JDOM2 Documents, etc.):

    val scalaOutputter = new ScalaXMLInfosetOutputter()
val is = new InputSourceDataInputStream(data)
val pr = dp.parse(is, scalaOutputter)
val node = scalaOutputter.getResult

    The DataProcessor.parse method is thread-safe and may be called multiple times without the need to create other data processors. However, InfosetOutputter's are not thread safe, requiring a unique instance per thread. An InfosetOutputter should call InfosetOutputter.reset before reuse (or a new one should be allocated). For example:

    val scalaOutputter = new ScalaXMLInfosetOutputter()
files.foreach { f => {
  outputter.reset
  val is = new InputSourceDataInputStream(new FileInputStream(f))
  val pr = dp.parse(is, scalaOutputter)
  val node = scalaOutputter.getResult
}

    One can repeat calls to parse() using the same InputSourceDataInputStream to continue parsing where the previous parse ended. For example:

    val is = new InputSourceDataInputStream(dataStream)
val scalaOutputter = new ScalaXMLInfosetOutputter()
val keepParsing = true
while (keepParsing) {
  scalaOutputter.reset()
  val pr = dp.parse(is, jdomOutputter)
  ...
  keepParsing = !pr.location().isAtEnd() && !pr.isError()
}
    Unparse

    The same DataProcessor used for parse can be used to unparse an infoset via the DataProcessor.unparse method. An InfosetInputter provides the infoset to unparse, with the unparsed data written to the provided java.nio.channels.WritableByteChannel. For example:

    val inputter = new ScalaXMLInfosetInputter(node)
val ur = dp.unparse(inputter, wbc)
    Failures and Diagnostics

    It is possible that failures could occur during the creation of the ProcessorFactory, DataProcessor, or ParseResult. However, rather than throwing an exception on error (e.g. invalid DFDL schema, parse error, etc), these classes extend WithDiagnostics, which is used to determine if an error occurred, and any diagnostic information (see Diagnostic) related to the step. Thus, before continuing, one must check WithDiagnostics.isError. For example:

    val pf = c.compile(file)
if (pf.isError()) {
  val diags = pf.getDiagnostics()
  diags.foreach { d =>
    System.out.println(d.toString())
  }
  return -1;
}
    Saving and Reloading Parsers

    In some cases, it may be beneficial to save a parser and reload it. For example, when starting up, it may be quicker to reload an already compiled parser than to compile it from scratch. To save a DataProcessor:

    val dp = pf.onPath("/")
dp.save(saveFile);

    And to restore a saved DataProcessor:

    val dp = Daffodil.reload(saveFile);
val pr = dp.parse(data, inputter);
    Definition Classes
    daffodil
  • package infoset

    Defines various classes used control the representation of the infoset for parse and unparse.

    Defines various classes used control the representation of the infoset for parse and unparse. Classes that extend InfosetOutputter are provided to the DataProcessor.parse method to deteremine how to output an infoset. These classes are not guaranteed to be thread-safe. Classes that extend InfosetInputter are provided to the DataProcessor.unparse method to determine how to read in an infoset. A new InfosetOutputter is required for each call to unparse().

    Definition Classes
    sapi
  • InfosetInputter
  • InfosetInputterProxy
  • InfosetOutputter
  • InfosetOutputterProxy
  • JDOMInfosetInputter
  • JDOMInfosetOutputter
  • JsonInfosetInputter
  • JsonInfosetOutputter
  • NullInfosetOutputter
  • ScalaXMLInfosetInputter
  • ScalaXMLInfosetOutputter
  • W3CDOMInfosetInputter
  • W3CDOMInfosetOutputter
  • XMLTextInfosetInputter
  • XMLTextInfosetOutputter
c

org.apache.daffodil.sapi.infoset

XMLTextInfosetOutputter

class XMLTextInfosetOutputter extends InfosetOutputterProxy

Linear Supertypes
InfosetOutputterProxy, InfosetOutputter, infoset.InfosetOutputter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. XMLTextInfosetOutputter
  2. InfosetOutputterProxy
  3. InfosetOutputter
  4. InfosetOutputter
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new XMLTextInfosetOutputter(os: OutputStream, pretty: Boolean)

    Output the infoset as XML Text, written to a java.io.OutputStream

    Output the infoset as XML Text, written to a java.io.OutputStream

    os

    the java.io.OutputStream to write the XML text to

    pretty

    enable or disable pretty printing. Pretty printing will only insert indentation and newlines where it will not affect the content of the XML.

  2. new XMLTextInfosetOutputter(writer: Writer)

    Output the infoset as XML Text, written to a java.io.Writer

    Output the infoset as XML Text, written to a java.io.Writer

    writer

    the java.io.Writer to write the XML text to

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4.0) This constructor is deprecated. Use XMLTextInfosetOutputter(java.io.OutputStream, Boolean) instead.

  3. new XMLTextInfosetOutputter(writer: Writer, pretty: Boolean)

    Output the infoset as XML Text, written to a java.io.Writer

    Output the infoset as XML Text, written to a java.io.Writer

    writer

    the java.io.Writer to write the XML text to

    pretty

    enable or disable pretty printing. Pretty printing will only insert indentation and newlines where it will not affect the content of the XML.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4.0) This constructor is deprecated. Use XMLTextInfosetOutputter(java.io.OutputStream, Boolean) instead.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def endArray(diArray: DIArray): Boolean

    Called by Daffodil internals to signify the end of an array of elements.

    Called by Daffodil internals to signify the end of an array of elements.

    diArray

    the array that is ended. Various fields of DIArray can be accessed to determine things like the name, namespace, etc.

    returns

    true on sucess, false if there was an error and Daffodil should stop all future calls to the InfosetOutputter

    Definition Classes
    InfosetOutputterProxy → InfosetOutputter → InfosetOutputter
  7. def endComplex(diComplex: DIComplex): Boolean

    Called by Daffodil internals to signify the end of a complex element.

    Called by Daffodil internals to signify the end of a complex element.

    diComplex

    the complex element that is ended. Various fields of DIComplex can be accessed to determine things like the nil, name, namespace, etc.

    returns

    true on sucess, false if there was an error and Daffodil should stop all future calls to the InfosetOutputter

    Definition Classes
    InfosetOutputterProxy → InfosetOutputter → InfosetOutputter
  8. def endDocument(): Boolean

    Called by Daffodil internals to signify the end of the infoset.

    Called by Daffodil internals to signify the end of the infoset.

    returns

    true on sucess, false if there was an error and Daffodil should stop all future calls to the InfosetOutputter

    Definition Classes
    InfosetOutputterProxy → InfosetOutputter → InfosetOutputter
  9. def endSimple(diSimple: DISimple): Boolean

    Called by Daffodil internals to signify the end of a simple element.

    Called by Daffodil internals to signify the end of a simple element.

    diSimple

    the simple element that is ended. Various fields of DISimple can be accessed to determine things like the value, nil, name, namespace, etc.

    returns

    true on sucess, false if there was an error and Daffodil should stop all future calls to the InfosetOutputter

    Definition Classes
    InfosetOutputterProxy → InfosetOutputter → InfosetOutputter
  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 getBlobDirectory(): Path
    Definition Classes
    InfosetOutputter
  14. final def getBlobPaths(): Seq[Path]
    Definition Classes
    InfosetOutputter
  15. final def getBlobPrefix(): String
    Definition Classes
    InfosetOutputter
  16. final def getBlobSuffix(): String
    Definition Classes
    InfosetOutputter
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def getStatus(): Status
    Definition Classes
    InfosetOutputter
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. val infosetOutputter: infoset.XMLTextInfosetOutputter
    Definition Classes
    XMLTextInfosetOutputter → InfosetOutputterProxy
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def isNilled(diElement: DIElement): Boolean
    Definition Classes
    InfosetOutputter
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def reset(): Unit

    Reset the internal state of this InfosetOutputter.

    Reset the internal state of this InfosetOutputter. This should be called inbetween calls to the parse method.

    Definition Classes
    InfosetOutputterProxy → InfosetOutputter → InfosetOutputter
  27. final def setBlobAttributes(dir: Path, prefix: String, suffix: String): Unit
    Definition Classes
    InfosetOutputter
  28. final def setBlobPaths(paths: Seq[Path]): Unit
    Definition Classes
    InfosetOutputter
  29. def startArray(diArray: DIArray): Boolean

    Called by Daffodil internals to signify the beginning of an array of elements.

    Called by Daffodil internals to signify the beginning of an array of elements.

    diArray

    the array that is started. Various fields of DIArray can be accessed to determine things like the name, namespace, etc.

    returns

    true on sucess, false if there was an error and Daffodil should stop all future calls to the InfosetOutputter

    Definition Classes
    InfosetOutputterProxy → InfosetOutputter → InfosetOutputter
  30. def startComplex(diComplex: DIComplex): Boolean

    Called by Daffodil internals to signify the beginning of a complex element.

    Called by Daffodil internals to signify the beginning of a complex element.

    diComplex

    the complex element that is started. Various fields of DIComplex can be accessed to determine things like the nil, name, namespace, etc.

    returns

    true on sucess, false if there was an error and Daffodil should stop all future calls to the InfosetOutputter

    Definition Classes
    InfosetOutputterProxy → InfosetOutputter → InfosetOutputter
  31. def startDocument(): Boolean

    Called by Daffodil internals to signify the beginning of the infoset.

    Called by Daffodil internals to signify the beginning of the infoset.

    returns

    true on sucess, false if there was an error and Daffodil should stop all future calls to the InfosetOutputter

    Definition Classes
    InfosetOutputterProxy → InfosetOutputter → InfosetOutputter
  32. def startSimple(diSimple: DISimple): Boolean

    Called by Daffodil internals to signify the beginning of a simple element.

    Called by Daffodil internals to signify the beginning of a simple element.

    diSimple

    the simple element that is started. Various fields of DISimple can be accessed to determine things like the value, nil, name, namespace, etc.

    returns

    true on sucess, false if there was an error and Daffodil should stop all future calls to the InfosetOutputter

    Definition Classes
    InfosetOutputterProxy → InfosetOutputter → InfosetOutputter
  33. def status: Status
    Definition Classes
    InfosetOutputter
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from InfosetOutputterProxy

Inherited from InfosetOutputter

Inherited from infoset.InfosetOutputter

Inherited from AnyRef

Inherited from Any

Ungrouped