B C D E F G I L N O P R S T V W

B

bitPos1b() - Method in class edu.illinois.ncsa.daffodil.japi.DataLocation

Get the position of the data, in bits, using 1-based indexing

bytePos1b() - Method in class edu.illinois.ncsa.daffodil.japi.DataLocation

Get the position of the data, in bytes, using 1-based indexing

C

canProceed() - Method in class edu.illinois.ncsa.daffodil.japi.WithDiagnostics

Determine if this object can be used in any future parse activities

compileFile(File) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

Compile DFDL schema file into a ProcessorFactory

Compiler - Class in edu.illinois.ncsa.daffodil.japi

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

Compiler() - Constructor for class edu.illinois.ncsa.daffodil.japi.Compiler

compiler() - Static method in class edu.illinois.ncsa.daffodil.japi.Daffodil

Create a new object used to compiled DFDL schemas

compileSource(URI) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

Compile DFDL schema source into a ProcessorFactory

ConsoleLogWriter - Class in edu.illinois.ncsa.daffodil.japi.logger

LogWriter that writes log messages to stdout

ConsoleLogWriter() - Constructor for class edu.illinois.ncsa.daffodil.japi.logger.ConsoleLogWriter

D

Daffodil - Class in edu.illinois.ncsa.daffodil.japi

API Suitable for Java programmers to use.

DataLocation - Class in edu.illinois.ncsa.daffodil.japi

Information related to a location in data

DataLocation(DataLocation) - Constructor for class edu.illinois.ncsa.daffodil.japi.DataLocation

DataProcessor - Class in edu.illinois.ncsa.daffodil.japi

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

DataProcessor(DataProcessor) - Constructor for class edu.illinois.ncsa.daffodil.japi.DataProcessor

DebuggerRunner - Class in edu.illinois.ncsa.daffodil.japi.debugger

Abstract debugger runner, which can be implemented to create a custom debugger runner

DebuggerRunner() - Constructor for class edu.illinois.ncsa.daffodil.japi.debugger.DebuggerRunner

Diagnostic - Class in edu.illinois.ncsa.daffodil.japi

Class containing diagnostic information

Diagnostic(Diagnostic) - Constructor for class edu.illinois.ncsa.daffodil.japi.Diagnostic

E

edu.illinois.ncsa.daffodil.japi - package edu.illinois.ncsa.daffodil.japi

Provides the classes necessary to compile DFDL schemas, parse and unparse files using the compiled objects, and retrieve results and parsing diagnostics

edu.illinois.ncsa.daffodil.japi.debugger - package edu.illinois.ncsa.daffodil.japi.debugger

Provides the classes necessary to perform parse tracing or create a custom debugger

edu.illinois.ncsa.daffodil.japi.logger - package edu.illinois.ncsa.daffodil.japi.logger

Provides the classes necessary to recieve logging messages from Daffodil.

F

FileLogWriter - Class in edu.illinois.ncsa.daffodil.japi.logger

LogWriter that writes all log messages to a file.

FileLogWriter(File) - Constructor for class edu.illinois.ncsa.daffodil.japi.logger.FileLogWriter

fini() - Method in class edu.illinois.ncsa.daffodil.japi.debugger.DebuggerRunner

Called once upon completion of a parse, allowing one to perform any steps necessary to clean up the debugger runner.

fini() - Method in class edu.illinois.ncsa.daffodil.japi.debugger.TraceDebuggerRunner

G

getCommand() - Method in class edu.illinois.ncsa.daffodil.japi.debugger.DebuggerRunner

Called by Daffodil when there is a pause in parsing to determine what debugger actions should be taken.

getCommand() - Method in class edu.illinois.ncsa.daffodil.japi.debugger.TraceDebuggerRunner

getDataLocations() - Method in class edu.illinois.ncsa.daffodil.japi.Diagnostic

Get data location information relevant to this diagnostic object.

getDiagnostics() - Method in class edu.illinois.ncsa.daffodil.japi.WithDiagnostics

Get the list of Diagnostic's created during the construction of the parent object

getFile() - Method in class edu.illinois.ncsa.daffodil.japi.logger.FileLogWriter

Retrieve the file the log writer writes to

getLocationsInSchemaFiles() - Method in class edu.illinois.ncsa.daffodil.japi.Diagnostic

Get schema location information relevant to this diagnostic object.

getMessage() - Method in class edu.illinois.ncsa.daffodil.japi.Diagnostic

Get the diagnostic message

getSomeCause() - Method in class edu.illinois.ncsa.daffodil.japi.Diagnostic

Positively get these things.

getSomeMessage() - Method in class edu.illinois.ncsa.daffodil.japi.Diagnostic

I

id - Variable in enum edu.illinois.ncsa.daffodil.japi.logger.LogLevel

id - Variable in enum edu.illinois.ncsa.daffodil.japi.ValidationMode

init() - Method in class edu.illinois.ncsa.daffodil.japi.debugger.DebuggerRunner

Called once at the beginning of a parse, allowing one to perform any initialization steps that may be necessary.

init() - Method in class edu.illinois.ncsa.daffodil.japi.debugger.TraceDebuggerRunner

InvalidParserException - Exception in edu.illinois.ncsa.daffodil.japi

This exception will be thrown as a result of attempting to reload a saved parser that is invalid (not a parser file, corrupt, etc.) or is not in the GZIP format.

InvalidParserException(InvalidParserException) - Constructor for exception edu.illinois.ncsa.daffodil.japi.InvalidParserException

InvalidUsageException - Exception in edu.illinois.ncsa.daffodil.japi

This exception will be thrown as a result of an invalid usage of the Daffodil API

InvalidUsageException(InvalidUsageException) - Constructor for exception edu.illinois.ncsa.daffodil.japi.InvalidUsageException

isAtEnd() - Method in class edu.illinois.ncsa.daffodil.japi.DataLocation

Determine if this data location is at the end of the input data

isError() - Method in class edu.illinois.ncsa.daffodil.japi.Diagnostic

Determine if a diagnostic object represents an error or something less serious.

isError() - Method in class edu.illinois.ncsa.daffodil.japi.WithDiagnostics

Determine if any errors occurred in the creation of the parent object.

L

lineOutput(String) - Method in class edu.illinois.ncsa.daffodil.japi.debugger.DebuggerRunner

Called by Daffodil when a debugger command has produce output.

lineOutput(String) - Method in class edu.illinois.ncsa.daffodil.japi.debugger.TraceDebuggerRunner

location() - Method in class edu.illinois.ncsa.daffodil.japi.ParseResult

Get the DataLocation where the parse completed

LocationInSchemaFile - Class in edu.illinois.ncsa.daffodil.japi

Information related to locations in DFDL schema files

LocationInSchemaFile(LocationInSchemaFile) - Constructor for class edu.illinois.ncsa.daffodil.japi.LocationInSchemaFile

log(LogLevel, String, String, List<Object>) - Method in class edu.illinois.ncsa.daffodil.japi.logger.LogWriter

Generates a log message as a string and calls the write method.

LogLevel - Enum in edu.illinois.ncsa.daffodil.japi.logger

Logging levels.

LogWriter - Class in edu.illinois.ncsa.daffodil.japi.logger

Abstract log writer, which can be overridden to create a custom log writer.

LogWriter() - Constructor for class edu.illinois.ncsa.daffodil.japi.logger.LogWriter

N

NullLogWriter - Class in edu.illinois.ncsa.daffodil.japi.logger

LogWriter that drops all log messages

NullLogWriter() - Constructor for class edu.illinois.ncsa.daffodil.japi.logger.NullLogWriter

O

onPath(String) - Method in class edu.illinois.ncsa.daffodil.japi.ProcessorFactory

Create a DataProcessor

P

parse(ReadableByteChannel, long) - Method in class edu.illinois.ncsa.daffodil.japi.DataProcessor

Parse input data with a specified length

parse(ReadableByteChannel) - Method in class edu.illinois.ncsa.daffodil.japi.DataProcessor

Parse input data without specifying a length

ParseResult - Class in edu.illinois.ncsa.daffodil.japi

Result of calling DataProcessor.parse(java.nio.channels.ReadableByteChannel, long), containing the resulting infoset, any diagnostic information, and the final data location

ParseResult(ParseResult) - Constructor for class edu.illinois.ncsa.daffodil.japi.ParseResult

prefix(LogLevel, String) - Method in class edu.illinois.ncsa.daffodil.japi.logger.LogWriter

Override to change the prefix string of the log message.

ProcessorFactory - Class in edu.illinois.ncsa.daffodil.japi

Factory to create DataProcessor's, used for parsing data

ProcessorFactory(ProcessorFactory) - Constructor for class edu.illinois.ncsa.daffodil.japi.ProcessorFactory

R

reload(File) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

Reload a saved parser from a file

reload(ReadableByteChannel) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

Reload a saved parser from a ReadableByteChannel

result() - Method in class edu.illinois.ncsa.daffodil.japi.ParseResult

Get the resulting infoset as a jdom2 Document

S

save(WritableByteChannel) - Method in class edu.illinois.ncsa.daffodil.japi.DataProcessor

Save the DataProcessor

setDebugger(DebuggerRunner) - Static method in class edu.illinois.ncsa.daffodil.japi.Daffodil

Set the debugger runer

setDebugging(boolean) - Static method in class edu.illinois.ncsa.daffodil.japi.Daffodil

Enable/disable debugging.

setDistinguishedRootNode(String, String) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

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

setDistinguishedRootNode(String, String) - Method in class edu.illinois.ncsa.daffodil.japi.ProcessorFactory

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

setExternalDFDLVariable(String, String, String) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

Set the value of a DFDL variable

setExternalDFDLVariables(AbstractMap<String, String>) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

Set the value of multiple DFDL variables

setExternalDFDLVariables(File) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

Read external variables from a Daffodil configuration file

setExternalVariables(File) - Method in class edu.illinois.ncsa.daffodil.japi.DataProcessor

Read external variables from a Daffodil configuration file

setExternalVariables(Map<String, String>) - Method in class edu.illinois.ncsa.daffodil.japi.DataProcessor

Set the value of multiple DFDL variables

setLoggingLevel(LogLevel) - Static method in class edu.illinois.ncsa.daffodil.japi.Daffodil

Set the maximum logging level

setLogWriter(LogWriter) - Static method in class edu.illinois.ncsa.daffodil.japi.Daffodil

Set the LogWriter to use to capture logging messages from Daffodil

setTunable(String, String) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

Set a Daffodil tunable parameter

setTunables(AbstractMap<String, String>) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

Set the value of multiple tunable parameters

setValidateDFDLSchemas(boolean) - Method in class edu.illinois.ncsa.daffodil.japi.Compiler

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

setValidationMode(ValidationMode) - Method in class edu.illinois.ncsa.daffodil.japi.DataProcessor

Set validation mode

suffix(LogLevel, String) - Method in class edu.illinois.ncsa.daffodil.japi.logger.LogWriter

Override to change the suffix string of the log message.

T

toString() - Method in class edu.illinois.ncsa.daffodil.japi.DataLocation

toString() - Method in class edu.illinois.ncsa.daffodil.japi.Diagnostic

toString() - Method in class edu.illinois.ncsa.daffodil.japi.LocationInSchemaFile

Get the description of the location file, for example, containing file and line number information

TraceDebuggerRunner - Class in edu.illinois.ncsa.daffodil.japi.debugger

DebuggerRunner that writes verbose information about parsing to stdout

TraceDebuggerRunner() - Constructor for class edu.illinois.ncsa.daffodil.japi.debugger.TraceDebuggerRunner

V

ValidationMode - Enum in edu.illinois.ncsa.daffodil.japi

Validation modes for validating the resulting infoset against the DFDL schema

valueOf(String) - Static method in enum edu.illinois.ncsa.daffodil.japi.logger.LogLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum edu.illinois.ncsa.daffodil.japi.ValidationMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum edu.illinois.ncsa.daffodil.japi.logger.LogLevel

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum edu.illinois.ncsa.daffodil.japi.ValidationMode

Returns an array containing the constants of this enum type, in the order they are declared.

W

WithDiagnostics - Class in edu.illinois.ncsa.daffodil.japi

Abstract class that adds diagnostic information to classes that extend it.

WithDiagnostics(WithDiagnostics) - Constructor for class edu.illinois.ncsa.daffodil.japi.WithDiagnostics

write(LogLevel, String, String) - Method in class edu.illinois.ncsa.daffodil.japi.logger.ConsoleLogWriter

write(LogLevel, String, String) - Method in class edu.illinois.ncsa.daffodil.japi.logger.FileLogWriter

write(LogLevel, String, String) - Method in class edu.illinois.ncsa.daffodil.japi.logger.LogWriter

Implement this method to determine how the log message is written.

write(LogLevel, String, String) - Method in class edu.illinois.ncsa.daffodil.japi.logger.NullLogWriter

B C D E F G I L N O P R S T V W