org.apache.daffodil.japi

Class Compiler

java.lang.Object

org.apache.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(org.apache.daffodil.compiler.Compiler sCompiler)

Method Summary

Modifier and Type	Method and Description
ProcessorFactory	compileFile(java.io.File schemaFile) Compile DFDL schema file into a ProcessorFactory
ProcessorFactory	compileFile(java.io.File schemaFile, java.lang.String rootName, java.lang.String rootNamespace) Compile DFDL schema file into a ProcessorFactory
ProcessorFactory	compileSource(java.net.URI uri) Compile DFDL schema source into a ProcessorFactory
ProcessorFactory	compileSource(java.net.URI uri, java.lang.String rootName, java.lang.String rootNamespace) 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) Deprecated. Pass arguments to compileSource, or compileFile. Since 2.6.0.
void	setExternalDFDLVariable(java.lang.String name, java.lang.String namespace, java.lang.String value) Deprecated. Use DataProcessor.withExternalVariable. Since 2.6.0.
void	setExternalDFDLVariables(java.util.AbstractMap<java.lang.String,java.lang.String> extVarsMap) Deprecated. Use DataProcessor.withExternalVariables. Since 2.6.0.
void	setExternalDFDLVariables(java.io.File extVarsFile) Deprecated. Use DataProcessor.withExternalVariables. Since 2.6.0.
void	setTunable(java.lang.String tunable, java.lang.String value) Deprecated. Use withTunable. Since 2.6.0.
void	setTunables(java.util.AbstractMap<java.lang.String,java.lang.String> tunables) Deprecated. Use withTunables. Since 2.6.0.
void	setValidateDFDLSchemas(boolean value) Deprecated. Do not use this method. DFDL schema validation should be performed. Since 2.6.0.
Compiler	withTunable(java.lang.String tunable, java.lang.String value) Create a new Compiler instance having a specific Daffodil tunable parameter value.
Compiler	withTunables(java.util.AbstractMap<java.lang.String,java.lang.String> tunables) Create a new Compiler instance having specific Daffodil tunable parameter values.

Methods inherited from class java.lang.Object

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

Constructor Detail

Compiler

public Compiler(org.apache.daffodil.compiler.Compiler sCompiler)

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 - if an I/O error occurs while reading the schemaFile

compileFile

public ProcessorFactory compileFile(java.io.File schemaFile,
                                    java.lang.String rootName,
                                    java.lang.String rootNamespace)
                             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.

rootName - name of root element, or null to choose automatically from first element of schema.

rootNamespace - String of namespace of the root element, or null to infer automatically when unambiguous. Pass "" (empty string) for No Namespace.*

Returns:

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

Throws:

java.io.IOException - if an I/O error occurs while reading the schemaFile

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 - if an I/O error occurs while reading the uri

compileSource

public ProcessorFactory compileSource(java.net.URI uri,
                                      java.lang.String rootName,
                                      java.lang.String rootNamespace)
                               throws java.io.IOException

Compile DFDL schema source into a ProcessorFactory

Parameters:

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

rootName - name of root element, or null to choose automatically from first element of schema.

rootNamespace - String of namespace of the root element, or null to infer automatically when unambiguous. Pass "" (empty string) for No Namespace.

Returns:

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

Throws:

java.io.IOException - if an I/O error occurs while reading the uri

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)

Deprecated. Pass arguments to compileSource, or compileFile. Since 2.6.0.

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)

Deprecated. Use DataProcessor.withExternalVariable. Since 2.6.0.

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)

Deprecated. Use DataProcessor.withExternalVariables. Since 2.6.0.

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)

Deprecated. Use DataProcessor.withExternalVariables. Since 2.6.0.

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

setTunable

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

Deprecated. Use withTunable. Since 2.6.0.

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)

Deprecated. Use withTunables. Since 2.6.0.

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

setValidateDFDLSchemas

public void setValidateDFDLSchemas(boolean value)

Deprecated. Do not use this method. DFDL schema validation should be performed. Since 2.6.0.

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

Parameters:

value - true to enable validation, false to disabled

withTunable

public Compiler withTunable(java.lang.String tunable,
                            java.lang.String value)

Create a new Compiler instance having a specific Daffodil tunable parameter value.

Parameters:

tunable - name of the tunable parameter

value - value of the tunable parameter

Returns:

(undocumented)

See Also:

Tunable Parameters - list of tunables names of default values

withTunables

public Compiler withTunables(java.util.AbstractMap<java.lang.String,java.lang.String> tunables)

Create a new Compiler instance having specific Daffodil tunable parameter values.

Parameters:

tunables - a map of key/value pairs, where the key is the tunable name and the value is the value it will get.

Returns:

(undocumented)

See Also:

Tunable Parameters - list of tunables names of default values