edu.illinois.ncsa.daffodil.japi

Class Compiler

java.lang.Object

edu.illinois.ncsa.daffodil.japi.Compiler

public class Compiler
extends java.lang.Object

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

Do not use the Compiler constructor to create a Compiler. Instead, use Daffodil.compiler().

Constructor Summary

Constructors

Constructor and Description
Compiler()

Method Summary

Modifier and Type	Method and Description
ProcessorFactory	compileFile(java.io.File schemaFile) Compile DFDL schema file into a ProcessorFactory
ProcessorFactory	compileSource(java.net.URI uri) Compile DFDL schema source into a ProcessorFactory
DataProcessor	reload(java.io.File savedParser) Reload a saved parser from a file
DataProcessor	reload(java.nio.channels.ReadableByteChannel savedParser) Reload a saved parser from a ReadableByteChannel
void	setDistinguishedRootNode(java.lang.String name, java.lang.String namespace) Specify a global element to be the root of DFDL Schema to start parsing
void	setExternalDFDLVariable(java.lang.String name, java.lang.String namespace, java.lang.String value) Set the value of a DFDL variable
void	setExternalDFDLVariables(java.util.AbstractMap<java.lang.String,java.lang.String> extVarsMap) Set the value of multiple DFDL variables
void	setExternalDFDLVariables(java.io.File extVarsFile) Read external variables from a Daffodil configuration file
void	setTunable(java.lang.String tunable, java.lang.String value) Set a Daffodil tunable parameter
void	setTunables(java.util.AbstractMap<java.lang.String,java.lang.String> tunables) Set the value of multiple tunable parameters
void	setValidateDFDLSchemas(boolean value) Enable/disable DFDL validation of resulting infoset with the DFDL schema

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Compiler

public Compiler()

Method Detail

compileFile

public ProcessorFactory compileFile(java.io.File schemaFile)
                             throws java.io.IOException

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 compileSource(java.net.URI) instead.

Parameters:

schemaFile - DFDL schema file used to create a ProcessorFactory.

Returns:

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

Throws:

java.io.IOException

compileSource

public ProcessorFactory compileSource(java.net.URI uri)
                               throws java.io.IOException

Compile DFDL schema source into a ProcessorFactory

Parameters:

uri - URI of DFDL schema file used to create a ProcessorFactory.

Returns:

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

Throws:

java.io.IOException

reload

public DataProcessor reload(java.io.File savedParser)
                     throws InvalidParserException

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 reload(java.nio.channels.ReadableByteChannel) where the argument is a ReadableByteChannel for a saved parser.

Parameters:

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

Returns:

DataProcessor used to parse data. Must check WithDiagnostics.isError() before using it.

Throws:

InvalidParserException - if the file is not a valid saved parser.

reload

public DataProcessor reload(java.nio.channels.ReadableByteChannel savedParser)
                     throws InvalidParserException

Reload a saved parser from a ReadableByteChannel

Parameters:

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

Returns:

DataProcessor used to parse data. Must check WithDiagnostics.isError() before using it.

Throws:

InvalidParserException - if the file is not a valid saved parser.

setDistinguishedRootNode

public void setDistinguishedRootNode(java.lang.String name,
                                     java.lang.String namespace)

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

Parameters:

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.

setExternalDFDLVariable

public void setExternalDFDLVariable(java.lang.String name,
                                    java.lang.String namespace,
                                    java.lang.String value)

Set the value of a DFDL variable

Parameters:

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

setExternalDFDLVariables

public void setExternalDFDLVariables(java.util.AbstractMap<java.lang.String,java.lang.String> extVarsMap)

Set the value of multiple DFDL variables

Parameters:

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.

setExternalDFDLVariables

public void setExternalDFDLVariables(java.io.File extVarsFile)

Read external variables from a Daffodil configuration file

Parameters:

extVarsFile - file to read DFDL variables from.

See Also:

Daffodil Configuration File - Daffodil configuration file format

setValidateDFDLSchemas

public void setValidateDFDLSchemas(boolean value)

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

Parameters:

value - true to enable validation, false to disabled

setTunable

public void setTunable(java.lang.String tunable,
                       java.lang.String value)

Set a Daffodil tunable parameter

Parameters:

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

setTunables

public void setTunables(java.util.AbstractMap<java.lang.String,java.lang.String> tunables)

Set the value of multiple tunable parameters

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