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.core.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	compileResource(java.lang.String name) Compile DFDL resource name into a ProcessorFactory
ProcessorFactory	compileResource(java.lang.String name, java.lang.String rootName, java.lang.String rootNamespace) Compile DFDL resource name 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
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.core.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

compileResource

public ProcessorFactory compileResource(java.lang.String name)
                                 throws java.io.IOException

Compile DFDL resource name into a ProcessorFactory

Parameters:

name - Resource name of a DFDL schema 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

java.io.FileNotFoundException - if the resource could not be found

compileResource

public ProcessorFactory compileResource(java.lang.String name,
                                        java.lang.String rootName,
                                        java.lang.String rootNamespace)
                                 throws java.io.IOException,
                                        java.io.FileNotFoundException

Compile DFDL resource name into a ProcessorFactory

Parameters:

name - Resource name of a DFDL schema 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

java.io.FileNotFoundException - if the resource could not be found

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.

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