Class

edu.illinois.ncsa.daffodil.sapi

ParseResult

Related Doc: package sapi

Permalink

class ParseResult extends WithDiagnostics

Result of calling DataProcessor#parse(input:java\.nio\.channels\.ReadableByteChannel,output:edu\.illinois\.ncsa\.daffodil\.sapi\.infoset\.InfosetOutputter)*, containing any diagnostic information, and the final data location

Linear Supertypes
WithDiagnostics, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParseResult
  2. WithDiagnostics
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def getDiagnostics: Seq[Diagnostic]

    Permalink

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

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

    returns

    list of Diagnostic's. May contain errors or warnings, and so may be non-empty even if WithDiagnostics#isError is false.

    Definition Classes
    WithDiagnostics
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. def isError(): Boolean

    Permalink

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

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

    returns

    true if no errors occurred, false otherwise

    Definition Classes
    WithDiagnostics
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def isProcessingError(): Boolean

    Permalink

    Determine if any processing errors occurred.

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

    returns

    true if any processing errors occured, false otherwise.

  15. def isValidationError(): Boolean

    Permalink

    Determine if all validation checks passed based on the validation mode of the DataProcessor.

    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.

  16. def location(): DataLocation

    Permalink

    Get the DataLocation where the parse completed

    Get the DataLocation where the parse completed

    returns

    the data location where the parse completed

  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def canProceed(): Boolean

    Permalink

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

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

    returns

    true it is safe to proceed, false otherwise

    Definition Classes
    WithDiagnostics
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use !isError() to determine if it is safe to proceed

  2. def result(): Node

    Permalink

    Get the resulting infoset as a scala.xml.Node

    Get the resulting infoset as a scala.xml.Node

    returns

    a scala.xml.Node representing the DFDL infoset for the parsed data

    Annotations
    @deprecated @throws( classOf[InvalidUsageException] )
    Deprecated

    (Since version 2.0.0) ParseResult carrying the infoset representation is deprecated. Intead, use parse(ReadableByteChannel, InfosetInputter) to parse the data and get the infoset representation from the InfosetOutputter

    Exceptions thrown

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

Inherited from WithDiagnostics

Inherited from AnyRef

Inherited from Any

Ungrouped