org.apache.daffodil.japi

Class DataProcessor

java.lang.Object

org.apache.daffodil.japi.WithDiagnostics

org.apache.daffodil.japi.DataProcessor

All Implemented Interfaces:

java.io.Serializable

public class DataProcessor
extends WithDiagnostics
implements scala.Serializable

Compiled version of a DFDL Schema, used to parse data and get the DFDL infoset

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataProcessor(org.apache.daffodil.processors.DataProcessor dp)

Method Summary

Modifier and Type	Method and Description
DaffodilUnparseContentHandler	newContentHandlerInstance(java.nio.channels.WritableByteChannel output) Obtain a new DaffodilUnparseContentHandler from the current DataProcessor.
DaffodilParseXMLReader	newXMLReaderInstance() Obtain a new DaffodilParseXMLReader from the current DataProcessor.
ParseResult	parse(InputSourceDataInputStream input, InfosetOutputter output) Parse input data from an InputSourceDataInputStream and output the infoset to an InfosetOutputter
ParseResult	parse(java.nio.channels.ReadableByteChannel input) Deprecated. Use parse(InputSourceDataInputStream, InfosetOutputter) to parse the data and get the infoset representation from the InfosetOutputter instead of ParseResult#result(). Since 2.2.0.
ParseResult	parse(java.nio.channels.ReadableByteChannel input, InfosetOutputter output) Deprecated. Use parse(InputSourceDataInputStream, InfosetOutputter) to parse the data and get the infoset representation from the InfosetOutputter instead of ParseResult#result(). Since 2.2.0.
ParseResult	parse(java.nio.channels.ReadableByteChannel input, InfosetOutputter output, long lengthLimitInBits) Deprecated. Use parse(InputSourceDataInputStream, InfosetOutputter) to parse the data and get the infoset representation from the InfosetOutputter instead of ParseResult#result(). Since 2.2.0.
ParseResult	parse(java.nio.channels.ReadableByteChannel input, long lengthLimitInBits) Deprecated. Use parse(InputSourceDataInputStream, InfosetOutputter) to parse the data and get the infoset representation from the InfosetOutputter instead of ParseResult#result(). Since 2.2.0.
void	save(java.nio.channels.WritableByteChannel output) Save the DataProcessor
void	setDebugger(DebuggerRunner dr) Deprecated. Use withDebuggerRunner. Since 2.6.0.
void	setDebugging(boolean flag) Deprecated. Use withDebugging. Since 2.6.0.
void	setExternalVariables(java.io.File extVars) Deprecated. Use withExternalVariables. Since 2.6.0.
void	setExternalVariables(scala.collection.immutable.Map<java.lang.String,java.lang.String> extVars) Deprecated. Use withExternalVariables. Since 2.6.0.
void	setValidationMode(ValidationMode mode) Deprecated. Use withValidationMode. Since 2.6.0.
UnparseResult	unparse(InfosetInputter input, java.nio.channels.WritableByteChannel output) Unparse an InfosetInputter
UnparseResult	unparse(java.nio.channels.WritableByteChannel output, org.jdom2.Document infoset) Deprecated. Use unparse(InfosetInputter, WritableByteChannel). Since 2.0.0.
DataProcessor	withDebugger(org.apache.daffodil.debugger.Debugger dbg) Obtain a new DataProcessor with a specified debugger.
DataProcessor	withDebuggerRunner(DebuggerRunner dr) Obtain a new DataProcessor with a specified debugger runner.
DataProcessor	withDebugging(boolean flag) Obtain a new DataProcessor instance with debugging enabled or disabled.
DataProcessor	withExternalVariables(java.util.AbstractMap<java.lang.String,java.lang.String> extVars) Obtain a new DataProcessor with multiple DFDL variables set.
DataProcessor	withExternalVariables(java.io.File extVars) Obtain a new DataProcessor with external variables read from a Daffodil configuration file
DataProcessor	withExternalVariables(scala.collection.immutable.Map<java.lang.String,java.lang.String> extVars) Deprecated. Use withExternalVariables that accepts a Java AbstractMap. Since 3.0.
DataProcessor	withValidationMode(ValidationMode mode) Obtain a new DataProcessor having a specific validation mode
DataProcessor	withValidator(org.apache.daffodil.api.Validator validator) Obtain a new DataProcessor having a specific validator

Methods inherited from class org.apache.daffodil.japi.WithDiagnostics

canProceed, getDiagnostics, isError

Methods inherited from class java.lang.Object

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

Constructor Detail

DataProcessor

public DataProcessor(org.apache.daffodil.processors.DataProcessor dp)

Method Detail

newContentHandlerInstance

public DaffodilUnparseContentHandler newContentHandlerInstance(java.nio.channels.WritableByteChannel output)

Obtain a new DaffodilUnparseContentHandler from the current DataProcessor.

Parameters:

output - (undocumented)

Returns:

(undocumented)

newXMLReaderInstance

public DaffodilParseXMLReader newXMLReaderInstance()

Obtain a new DaffodilParseXMLReader from the current DataProcessor.

Returns:

(undocumented)

parse

public ParseResult parse(java.nio.channels.ReadableByteChannel input,
                         long lengthLimitInBits)

Deprecated. Use parse(InputSourceDataInputStream, InfosetOutputter) to parse the data and get the infoset representation from the InfosetOutputter instead of ParseResult#result(). Since 2.2.0.

Parse input data with a specified length

Parameters:

input - data to be parsed

lengthLimitInBits - the length of the input data in bits, or -1 if no limit

Returns:

an object which contains the result, and/or diagnostic information.

parse

public ParseResult parse(java.nio.channels.ReadableByteChannel input)

Deprecated. Use parse(InputSourceDataInputStream, InfosetOutputter) to parse the data and get the infoset representation from the InfosetOutputter instead of ParseResult#result(). Since 2.2.0.

Parse input data without specifying a length

Parameters:

input - data to be parsed

Returns:

an object which contains the result, and/or diagnostic information.

parse

public ParseResult parse(java.nio.channels.ReadableByteChannel input,
                         InfosetOutputter output,
                         long lengthLimitInBits)

Deprecated. Use parse(InputSourceDataInputStream, InfosetOutputter) to parse the data and get the infoset representation from the InfosetOutputter instead of ParseResult#result(). Since 2.2.0.

Parse input data with a specified length

Parameters:

input - data to be parsed

output - the InfosetOutputter that will be used to output the infoset

lengthLimitInBits - the length of the input data in bits, or -1 if no limit

Returns:

an object which contains the result, and/or diagnostic information.

parse

public ParseResult parse(java.nio.channels.ReadableByteChannel input,
                         InfosetOutputter output)

Deprecated. Use parse(InputSourceDataInputStream, InfosetOutputter) to parse the data and get the infoset representation from the InfosetOutputter instead of ParseResult#result(). Since 2.2.0.

Parse input data without specifying a length

Use this when you don't know how big the data is.

Parameters:

input - data to be parsed

output - the InfosetOutputter that will be used to output the infoset

Returns:

an object which contains the result, and/or diagnostic information.

parse

public ParseResult parse(InputSourceDataInputStream input,
                         InfosetOutputter output)

Parse input data from an InputSourceDataInputStream and output the infoset to an InfosetOutputter

Parameters:

input - data to be parsed

output - the InfosetOutputter that will be used to output the infoset

Returns:

an object which contains the result, and/or diagnostic information.

save

public void save(java.nio.channels.WritableByteChannel output)

Save the DataProcessor

The resulting output can be reloaded by Compiler.reload(java.nio.channels.ReadableByteChannel). Note that external variable bindings are not saved, and will not be restored upon reloading.

Parameters:

output - the byte channel to write the DataProcessor to

setDebugger

public void setDebugger(DebuggerRunner dr)

Deprecated. Use withDebuggerRunner. Since 2.6.0.

Set the debugger runner

Parameters:

dr - debugger runner

setDebugging

public void setDebugging(boolean flag)

Deprecated. Use withDebugging. Since 2.6.0.

Enable/disable debugging.

Before enabling, withDebugger(org.apache.daffodil.debugger.Debugger) or withDebuggerRunner(DebuggerRunner) must be called with a non-null debugger.

Parameters:

flag - true to enable debugging, false to disabled

setExternalVariables

public void setExternalVariables(java.io.File extVars)
                          throws ExternalVariableException

Deprecated. Use withExternalVariables. Since 2.6.0.

Read external variables from a Daffodil configuration file

Parameters:

extVars - file to read DFDL variables from.

Throws:

ExternalVariableException - if an error occurs while setting an external variable

See Also:

Daffodil Configuration File - Daffodil configuration file format

setExternalVariables

public void setExternalVariables(scala.collection.immutable.Map<java.lang.String,java.lang.String> extVars)
                          throws ExternalVariableException

Deprecated. Use withExternalVariables. Since 2.6.0.

Set the value of multiple DFDL variables

Parameters:

extVars - a map 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. If not preceded by anything, then Daffodil will figure out the namespace.

Throws:

ExternalVariableException - if an error occurs while setting an external variable

setValidationMode

public void setValidationMode(ValidationMode mode)
                       throws InvalidUsageException

Deprecated. Use withValidationMode. Since 2.6.0.

Set validation mode

Parameters:

mode - mode to control validation

Throws:

InvalidUsageException - if mode is not a valid ValidateMode value

unparse

public UnparseResult unparse(InfosetInputter input,
                             java.nio.channels.WritableByteChannel output)

Unparse an InfosetInputter

Parameters:

input - the infoset inputter to use for unparsing

output - the byte channel to write the data to

Returns:

an object with contains diagnostic information

unparse

public UnparseResult unparse(java.nio.channels.WritableByteChannel output,
                             org.jdom2.Document infoset)

Deprecated. Use unparse(InfosetInputter, WritableByteChannel). Since 2.0.0.

Unparse a JDOM2 infoset

Parameters:

output - the byte channel to write the data to

infoset - the infoset to unparse, as a jdom event cursor

Returns:

an object with contains the result and/or diagnostic information

withDebugger

public DataProcessor withDebugger(org.apache.daffodil.debugger.Debugger dbg)

Obtain a new DataProcessor with a specified debugger.

Parameters:

dbg - debugger

Returns:

(undocumented)

withDebuggerRunner

public DataProcessor withDebuggerRunner(DebuggerRunner dr)

Obtain a new DataProcessor with a specified debugger runner.

Parameters:

dr - debugger runner

Returns:

(undocumented)

withDebugging

public DataProcessor withDebugging(boolean flag)

Obtain a new DataProcessor instance with debugging enabled or disabled.

Before enabling, withDebugger(Debugger) or withDebuggerRunner(DebuggerRunner) must be called to obtain a DataProcessor with a non-null debugger.

Parameters:

flag - true to enable debugging, false to disabled

Returns:

(undocumented)

withExternalVariables

public DataProcessor withExternalVariables(java.io.File extVars)
                                    throws ExternalVariableException

Obtain a new DataProcessor with external variables read from a Daffodil configuration file

Parameters:

extVars - file to read DFDL variables from.

Returns:

(undocumented)

Throws:

ExternalVariableException - if an error occurs while setting an external variable

See Also:

Daffodil Configuration File - Daffodil configuration file format

withExternalVariables

public DataProcessor withExternalVariables(scala.collection.immutable.Map<java.lang.String,java.lang.String> extVars)
                                    throws ExternalVariableException

Deprecated. Use withExternalVariables that accepts a Java AbstractMap. Since 3.0.

Obtain a new DataProcessor with multiple DFDL variables set.

Parameters:

extVars - a map 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. If not preceded by anything, then Daffodil will figure out the namespace.

Returns:

(undocumented)

Throws:

ExternalVariableException - if an error occurs while setting an external variable

withExternalVariables

public DataProcessor withExternalVariables(java.util.AbstractMap<java.lang.String,java.lang.String> extVars)
                                    throws ExternalVariableException

Obtain a new DataProcessor with multiple DFDL variables set.

Parameters:

extVars - a map 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. If not preceded by anything, then Daffodil will figure out the namespace.

Returns:

(undocumented)

Throws:

ExternalVariableException - if an error occurs while setting an external variable

withValidationMode

public DataProcessor withValidationMode(ValidationMode mode)
                                 throws InvalidUsageException

Obtain a new DataProcessor having a specific validation mode

Parameters:

mode - mode to control validation

Returns:

(undocumented)

Throws:

InvalidUsageException - if mode is not a valid ValidateMode value

withValidator

public DataProcessor withValidator(org.apache.daffodil.api.Validator validator)

Obtain a new DataProcessor having a specific validator

Parameters:

validator - validator instance

Returns:

(undocumented)