edu.illinois.ncsa.daffodil.sapi

Compiler

class Compiler extends AnyRef

Compile DFDL schemas into ProcessorFactory's or reload saved parsers into DataProcessor's.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Compiler
  2. AnyRef
  3. 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 clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def compileFile(schemaFile: File): ProcessorFactory

    Compile DFDL schema file into a ProcessorFactory

    Compile DFDL schema file into a ProcessorFactory

    To allow jar-file packaging, (where schema files might be part of a jar), it is recommended to use Compiler#compileSource instead.

    schemaFile

    DFDL schema file used to create a ProcessorFactory.

    returns

    ProcessorFactory used to create DataProcessor(s). Must check ProcessorFactory#isError before using it.

    Annotations
    @throws( classOf[java.io.IOException] )
  9. def compileSource(uri: URI): ProcessorFactory

    Compile DFDL schema source into a ProcessorFactory

    Compile DFDL schema source into a ProcessorFactory

    uri

    URI of DFDL schema file used to create a ProcessorFactory.

    returns

    ProcessorFactory used to create DataProcessor(s). Must check ProcessorFactory#isError before using it.

    Annotations
    @throws( classOf[java.io.IOException] )
  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 reload(savedParser: Input): DataProcessor

    Reload a saved parser from a java.nio.channels.ReadableByteChannel

    Reload a saved parser from a java.nio.channels.ReadableByteChannel

    savedParser

    java.nio.channels.ReadableByteChannel of a saved parser, created with DataProcessor#save(java.nio.channels.WritableByteChannel)

    returns

    DataProcessor used to parse data. Must check DataProcessor#isError before using it.

    Exceptions thrown
    [[InvalidParserException]]

    if the file is not a valid saved parser.

  20. def reload(savedParser: File): DataProcessor

    Reload a saved parser from a file

    Reload a saved parser from a file

    To allow jar-file packaging, (where the savedParser might be part of a jar), it is recommended to use the other version of Compiler#reload(java.nio.channels.ReadableByteChannel) where the argument is a java.nio.channels.ReadableByteChannel for a saved parser.

    savedParser

    file of a saved parser, created with DataProcessor#save(java.nio.channels.WritableByteChannel)

    returns

    DataProcessor used to parse data. Must check DataProcessor#isError before using it.

    Exceptions thrown
    [[InvalidParserException]]

    if the file is not a valid saved parser.

  21. def setDistinguishedRootNode(name: String, namespace: String): Unit

    Specify a global element to be the root of DFDL Schema to start parsing

    Specify a global element to be the root of DFDL Schema to start parsing

    name

    name of the root node

    namespace

    namespace of the root node. Set to empty string to specify no namespace. Set to to NULL to figure out the namespace.

  22. def setExternalDFDLVariable(name: String, namespace: String, value: String): Unit

    Set the value of a DFDL variable

    Set the value of a DFDL variable

    name

    name of the variable

    namespace

    namespace of the variable. Set to empty string to specify no namespace. Set to to NULL to figure out the namespace.

    value

    value to so the variable to

  23. def setExternalDFDLVariables(extVarsFile: File): Unit

    Read external variables from a Daffodil configuration file

    Read external variables from a Daffodil configuration file

    extVarsFile

    file to read DFDL variables from.

    See also

    Daffodil Configuration File - Daffodil configuration file format

  24. def setExternalDFDLVariables(extVarsMap: Map[String, String]): Unit

    Set the value of multiple DFDL variables

    Set the value of multiple DFDL variables

    extVarsMap

    a may 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. With not preceded by "{namespace}", then Daffodil will figure out the namespace.

  25. def setTunable(tunable: String, value: String): Unit

    Set a Daffodil tunable parameter

    Set a Daffodil tunable parameter

    tunable

    name of the tunable parameter to set.

    value

    value of the tunable parameter to set

    See also

    Tunable Parameters - list of tunables names of default values

  26. def setTunables(tunables: Map[String, String]): Unit

    Set the value of multiple tunable parameters

    Set the value of multiple tunable parameters

    tunables

    a map of key/value pairs, where the key is the tunable name and the value is the value to set it to

    See also

    Tunable Parameters - list of tunables names of default values

  27. def setValidateDFDLSchemas(value: Boolean): Unit

    Enable/disable DFDL validation of resulting infoset with the DFDL schema

    Enable/disable DFDL validation of resulting infoset with the DFDL schema

    value

    true to enable validation, false to disabled

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

    Definition Classes
    AnyRef
  29. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped