Class

edu.illinois.ncsa.daffodil.sapi

DataProcessor

Related Doc: package sapi

Permalink

class DataProcessor extends WithDiagnostics

Compiled version of a DFDL Schema, used to parse data and get the DFDL infoset

Linear Supertypes
WithDiagnostics, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataProcessor
  2. WithDiagnostics
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def getDiagnostics: Seq[Diagnostic]

    Permalink

    Get the list of Diagnostic's created during the construction of the parent object

    Get the list of Diagnostic's created during the construction of the parent object

    returns

    list of Diagnostic's. May contain errors or warnings, and so may be non-empty even if WithDiagnostics#isError is false.

    Definition Classes
    WithDiagnostics
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. def isError(): Boolean

    Permalink

    Determine if any errors occurred in the creation of the parent object.

    Determine if any errors occurred in the creation of the parent object.

    returns

    true if no errors occurred, false otherwise

    Definition Classes
    WithDiagnostics
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. def parse(input: ReadableByteChannel, output: InfosetOutputter): ParseResult

    Permalink

    Parse input data without specifying a length

    Parse input data without specifying a length

    Use this when you don't know how big the data is. Note that the isAtEnd() does not work properly and will always return -1. If you need isAtEnd() to work, you must use DataProcessor#parse(input:java\.nio\.channels\.ReadableByteChannel,output:edu\.illinois\.ncsa\.daffodil\.sapi\.infoset\.InfosetOutputter)* method that accepts a long and specify the length of the data.

    input

    data to be parsed

    output

    the InfosetOutputter that will be used to output the infoset

    returns

    an object which contains the result, and/or diagnostic information.

  18. def parse(input: ReadableByteChannel, output: InfosetOutputter, lengthLimitInBits: Long): ParseResult

    Permalink

    Parse input data with a specified length

    Parse input data with a specified length

    input

    data to be parsed

    output

    the InfosetOutputter that will be used to output the infoset

    lengthLimitInBits

    the length of the input data in bits. This must be the actual length in bits if you want the location().isAtEnd() function to work. If value is -1, the isAtEnd() function will always return true.

    returns

    an object which contains the result, and/or diagnostic information.

  19. def save(output: WritableByteChannel): Unit

    Permalink

    Save the DataProcessor

    Save the DataProcessor

    The resulting output can be reloaded by Compiler#reload(savedParser:java\.nio\.channels\.ReadableByteChannel)*.

    output

    the byte channel to write the DataProcessor to

  20. def setDebugger(dr: DebuggerRunner): Unit

    Permalink

    Set the debugger runer

    Set the debugger runer

    dr

    debugger runner

  21. def setDebugging(b: Boolean): Unit

    Permalink

    Enable/disable debugging.

    Enable/disable debugging.

    Before enabling, DataProcessor#setDebugger must be called with a non-null debugger.

  22. def setExternalVariables(extVars: Map[String, String]): Unit

    Permalink

    Set the value of multiple DFDL variables

    Set the value of multiple DFDL variables

    extVars

    a map of key/value pairs, where the key is the variable name, and the value is the value of the variable. The key may be preceded by a string of the form "{namespace}" to define a namespace for the variable. If preceded with "{}", then no namespace is used. If not preceded by anything, then Daffodil will figure out the namespace.

  23. def setExternalVariables(extVars: File): Unit

    Permalink

    Read external variables from a Daffodil configuration file

    Read external variables from a Daffodil configuration file

    extVars

    file to read DFDL variables from.

    See also

    Daffodil Configuration File - Daffodil configuration file format

  24. def setValidationMode(mode: ValidationMode.Value): Unit

    Permalink

    Set validation mode

    Set validation mode

    mode

    mode to control validation

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

    Permalink
    Definition Classes
    AnyRef
  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  27. def unparse(input: InfosetInputter, output: WritableByteChannel): UnparseResult

    Permalink

    Unparse an InfosetInputter

    Unparse an InfosetInputter

    input

    the infoset inputter to use for unparsing

    output

    the byte channel to write the data to

    returns

    an object with contains diagnostic information

  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def canProceed(): Boolean

    Permalink

    Determine if this object can be used in any future parse activities

    Determine if this object can be used in any future parse activities

    returns

    true it is safe to proceed, false otherwise

    Definition Classes
    WithDiagnostics
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use !isError() to determine if it is safe to proceed

  2. def parse(input: ReadableByteChannel): ParseResult

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use parse(ReadableByteChannel, InfosetOutputter) to parse the data and get the infoset representation from the InfosetOutputter instead of ParseResult#result()

  3. def parse(input: ReadableByteChannel, lengthLimitInBits: Long): ParseResult

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use parse(ReadableByteChannel, InfosetOutputter, long) to parse the data and get the infoset representation from the InfosetOutputter instead of ParseResult#result()

  4. def unparse(output: WritableByteChannel, infoset: Node): UnparseResult

    Permalink

    Unparse a scala.xml.Node infoset

    Unparse a scala.xml.Node infoset

    output

    the byte channel to write the data to

    infoset

    the infoset to unparse, as a scala xml Node

    returns

    an object with contains the result and/or diagnostic information

    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use unparse(InfosetInputter, WritableByteChannel)

Inherited from WithDiagnostics

Inherited from AnyRef

Inherited from Any

Ungrouped