Object

org.apache.daffodil.api

DFDL

Related Doc: package api

Permalink

object DFDL

APIs for DFDL Parsing and Unparsing

Assumed that applications will provide information not all at once, but will provide first:

Schema (which can be multiple schema files by way of include/import)
XML Catalog, or other means by which include/import are found.
Control settings/features for how they want the parser to behave.
Error handlers.
Root node and namespace
Externally defined variables

After that, the application will want to use one of two primary patterns:

Random access: one input source, evaluate many different paths
Bulk Parsing: one path, many different input sources

The output direction is symmetric.

So the API provides a way to set the path specially, providing for schema-aware compilation of the XPath expression in the bulk processing case.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

DFDL
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

trait Compiler extends AnyRef
trait DataProcessor extends WithDiagnostics
type Input = ReadableByteChannel
type Output = WritableByteChannel
trait ParseResult extends Result with WithDiagnostics
trait ProcessorFactory extends WithDiagnostics

The point of processor factory is to allow compilation of the path expression.
abstract class Result extends AnyRef

Interface for Parse and Unparse results
trait State extends AnyRef

Interface for Parse and Unparse states
trait UnparseResult extends Result with WithDiagnostics

Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped