Evaluatable

Instance Constructors

new Evaluatable(rd: RuntimeData, qNameArg: NamedQName = null)

Type Members

type State = ParseOrUnparseState

Abstract Value Members

abstract def compute(state: State): T

Attributes
protected
abstract def getCachedOrComputeAndCache(state: State): T

Attributes
protected
abstract def runtimeDependencies: Seq[Evaluatable[AnyRef]]

Important - Evalutables MUST declare all evaluatables they depend on.
Important - Evalutables MUST declare all evaluatables they depend on. But only those they directly depend on. (Not the dependents of the dependents...)

Concrete 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 compile(): Maybe[T]
final def compile(state: CompileState): Maybe[T]

Compile an Ev to see if it is a constant at compilation time.
Compile an Ev to see if it is a constant at compilation time. This is determined by actually evaluating it, passing a special CompileState that errors out when data access to runtime-valued data is attempted.
final def constValue: T

Annotations
@inline()
def dafName(local: String): GlobalQName

Convenience method
Convenience method
Use by way of override lazy val qName = dafName("foobar")

Attributes
protected
final def ensureCompiled: Unit

Annotations
@inline()
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
final def evaluate(state: State): T
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 isCompiled: Boolean

Annotations
@inline()
final def isConstant: Boolean

Annotations
@inline()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def maybeConstant: Maybe[T]

Preferred for use in the runtime.
Preferred for use in the runtime.

Annotations
@inline()
def maybeUseUnparserMode: Maybe[EvalMode]

Override if this evaluatable needs to use a different evaluate mode for unparsing.
Override if this evaluatable needs to use a different evaluate mode for unparsing.
The only example of this (as of this comment being written) is LengthEv

Attributes
protected
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 optConstant: Option[T]

Schema compiler wants to use map call, so we need a scala option type for that.
Schema compiler wants to use map call, so we need a scala option type for that. So this variant supplies that.

Annotations
@inline()
lazy val qName: NamedQName

QName to be associated with this evaluatable.
QName to be associated with this evaluatable.
If the Evaluatable is for a DFDL property this should be dfdl:propertyName e.g., dfdl:terminator, with the prefix DFDL being the prefix associated with the DFDL namespace.
If the Evaluatable is for some other computation, e.g., for the CharsetEncoder. Then daf:encoder or other useful identifier.
This QName is used in the XML representation of these Evaluatables, if they are to be displayed, which is mostly for various debug purposes.
val rd: RuntimeData

Attributes
protected
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toBriefXML(depth: Int = 1): String
def toPseudoXML(cache: EvalCache): String

Creates an XML-like string representation.
Creates an XML-like string representation.
Looks like an attribute definition, but the value part may contain XML-element-like syntax. If so it is either escaped with CDATA bracketing (preferred), or if there are quotes in it, then it is escapified meaning " < etc.
Avoids inserting single quotes (aka apos) so that those can be used surrounding this at a higher level.
def toSDE(e: Diagnostic, state: ParseOrUnparseState): Nothing

Attributes
protected
def toString(): String

Definition Classes
Evaluatable → 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( ... )

Related Doc: package processors

abstract class Evaluatable[+T <: AnyRef] extends Serializable

Instance Constructors

new Evaluatable(rd: RuntimeData, qNameArg: NamedQName = null)

Type Members

type State = ParseOrUnparseState

Abstract Value Members

abstract def compute(state: State): T

abstract def getCachedOrComputeAndCache(state: State): T

abstract def runtimeDependencies: Seq[Evaluatable[AnyRef]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def compile(): Maybe[T]

final def compile(state: CompileState): Maybe[T]

final def constValue: T

def dafName(local: String): GlobalQName

final def ensureCompiled: Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def evaluate(state: State): T

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isCompiled: Boolean

final def isConstant: Boolean

final def isInstanceOf[T0]: Boolean

final def maybeConstant: Maybe[T]

def maybeUseUnparserMode: Maybe[EvalMode]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def optConstant: Option[T]

lazy val qName: NamedQName

val rd: RuntimeData

final def synchronized[T0](arg0: ⇒ T0): T0

def toBriefXML(depth: Int = 1): String

def toPseudoXML(cache: EvalCache): String

def toSDE(e: Diagnostic, state: ParseOrUnparseState): Nothing

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped