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
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) Set the debugger runer
void	setDebugging(boolean flag) Enable/disable debugging.
void	setExternalVariables(java.io.File extVars) Read external variables from a Daffodil configuration file
void	setExternalVariables(scala.collection.immutable.Map<java.lang.String,java.lang.String> extVars) Set the value of multiple DFDL variables
void	setValidationMode(ValidationMode mode) Set validation mode
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.

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

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).

Parameters:

output - the byte channel to write the DataProcessor to

setDebugger

public void setDebugger(DebuggerRunner dr)

Set the debugger runer

Parameters:

dr - debugger runner

setDebugging

public void setDebugging(boolean flag)

Enable/disable debugging.

Before enabling, setDebugger(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)

Read external variables from a Daffodil configuration file

Parameters:

extVars - file to read DFDL variables from.

See Also:

Daffodil Configuration File - Daffodil configuration file format

setExternalVariables

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

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.

setValidationMode

public void setValidationMode(ValidationMode mode)
                       throws InvalidUsageException

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