edu.illinois.ncsa.daffodil.sapi

DataProcessor

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
Learn more about member selection
Visibility
  1. Public
  2. All

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 canProceed(): Boolean

    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
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

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

    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 or WithDiagnostics#canProceed is true.

    Definition Classes
    WithDiagnostics
  14. def hashCode(): Int

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

    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
  16. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  20. def parse(input: ReadableByteChannel): ParseResult

    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 long) and specify the length of the data.

    input

    data to be parsed

    returns

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

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

    Parse input data with a specified length

    Parse input data with a specified length

    input

    data to be parsed

    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.

  22. def save(output: Output): Unit

    Save the DataProcessor

    Save the DataProcessor

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

    output

    the byte channel to write the DataProcessor to

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

    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.

  24. def setExternalVariables(extVars: File): Unit

    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

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

    Set validation mode

    Set validation mode

    mode

    mode to control validation

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

    Definition Classes
    AnyRef
  27. def toString(): String

    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from WithDiagnostics

Inherited from AnyRef

Inherited from Any

Ungrouped