edu.illinois.ncsa.daffodil.japi

Class ParseResult

java.lang.Object

edu.illinois.ncsa.daffodil.japi.WithDiagnostics

edu.illinois.ncsa.daffodil.japi.ParseResult

public class ParseResult
extends WithDiagnostics

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

Constructor Summary

Constructors

Constructor and Description
ParseResult(edu.illinois.ncsa.daffodil.processors.ParseResult pr, edu.illinois.ncsa.daffodil.util.Maybe<JDOMInfosetOutputter> deprecatedOutput)

Method Summary

Modifier and Type	Method and Description
boolean	isProcessingError() Determine if any processing errors occurred.
boolean	isValidationError() Determine if all validation checks passed based on the validation mode of the DataProcessor.
DataLocation	location() Get the DataLocation where the parse completed
org.jdom2.Document	result() Deprecated. Use parse(ReadableByteChannel, InfosetInputter) to parse the data and get the infoset representation from the InfosetOutputter. Since 2.0.0.

Methods inherited from class edu.illinois.ncsa.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

ParseResult

public ParseResult(edu.illinois.ncsa.daffodil.processors.ParseResult pr,
                   edu.illinois.ncsa.daffodil.util.Maybe<JDOMInfosetOutputter> deprecatedOutput)

Method Detail

result

public org.jdom2.Document result()
                          throws InvalidUsageException

Deprecated. Use parse(ReadableByteChannel, InfosetInputter) to parse the data and get the infoset representation from the InfosetOutputter. Since 2.0.0.

Get the resulting infoset as a jdom2 Document

Returns:

a jdom2 Document representing the DFDL infoset for the parsed data

Throws:

InvalidUsageException - if you call this when isError is true because in that case there is no result document.

location

public DataLocation location()

Get the DataLocation where the parse completed

Returns:

the data location where the parse completed

isProcessingError

public boolean isProcessingError()

Determine if any processing errors occurred. isError() will always return true if this returns true.

Returns:

true if any processing errors occured, false otherwise.

isValidationError

public boolean isValidationError()

Determine if all validation checks passed based on the validation mode of the DataProcessor. If validation mode is Off, this will always return false. This is only meaningful when isProcessingError() is false. isError() will always return true if this return true.

Returns:

true if any validation errors occurred, false otherwise.