Class

edu.illinois.ncsa.daffodil.sapi

Compiler

Related Doc: package sapi

Permalink

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
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. def compileFile(schemaFile: File): ProcessorFactory

    Permalink

    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] )
  7. def compileSource(uri: URI): ProcessorFactory

    Permalink

    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] )
  8. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  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 reload(savedParser: ReadableByteChannel): DataProcessor

    Permalink

    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

    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.

  18. def reload(savedParser: File): DataProcessor

    Permalink

    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(savedParser: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

    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.

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

    Permalink

    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.

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

    Permalink

    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

  21. def setExternalDFDLVariables(extVarsFile: File): Unit

    Permalink

    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

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

    Permalink

    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.

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

    Permalink

    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

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

    Permalink

    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

  25. def setValidateDFDLSchemas(value: Boolean): Unit

    Permalink

    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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  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( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped