class Compiler extends AnyRef
Compile DFDL schemas into ProcessorFactory's or reload saved parsers into DataProcessor's.
- Alphabetic
- By Inheritance
- Compiler
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
compileFile(schemaFile: File, optRootName: Option[String] = None, optRootNamespace: Option[String] = None): 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.
- optRootName
Option for name of root element, or None to choose automatically from first element of schema. Defaults to None.
- optRootNamespace
Option for string of namespace of the root element, or None to infer automatically when unambiguous. Pass Some("") (empty string) for No Namespace. Defaults to None.
- returns
ProcessorFactory used to create DataProcessor(s). Must check ProcessorFactory.isError before using it.
- Annotations
- @throws( classOf[java.io.IOException] )
-
def
compileSource(uri: URI, optRootName: Option[String] = None, optRootNamespace: Option[String] = None): 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.
- optRootName
Option for name of root element, or None to choose automatically from first element of schema. Defaults to None.
- optRootNamespace
Option for string of namespace of the root element, or None to infer automatically when unambiguous. Pass Some("") (empty string) for No Namespace. Defaults to None.
- returns
ProcessorFactory used to create DataProcessor(s). Must check ProcessorFactory.isError before using it.
- Annotations
- @throws( classOf[java.io.IOException] )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
reload(savedParser: ReadableByteChannel): 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
- 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.
-
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 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.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
withTunable(tunable: String, value: String): Compiler
Return a new Compiler with a specific Daffodil tunable parameter
Return a new Compiler with a specific 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
-
def
withTunables(tunables: Map[String, String]): Compiler
Return a new Compiler with multiple tunable parameters
Return a new Compiler with 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
Deprecated Value Members
-
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.
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Pass arguments to compileSource, or compileFile.
-
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
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use DataProcessor.setExternalVariables
-
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.
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use DataProcessor.setExternalVariables
- See also
Daffodil Configuration File - Daffodil configuration file format
-
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.
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use DataProcessor.setExternalVariables
-
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
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use withTunable.
- See also
Tunable Parameters - list of tunables names of default values
-
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
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Use withTunables.
- See also
Tunable Parameters - list of tunables names of default values
-
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
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.0) Do not use this method. DFDL schema validation should be performed.
This is the documentation for the Apache Daffodil Scala API.
Package structure
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.udf - Provides the classes necessary to create User Defined Functions to extend the DFDL expression language