ErrorEnrichingSemantics

User-defined functions used in feature specifications can cause models to throw undesirable exceptions. This semantics mixin can allow the the exception to be caught, reformulated as a com.eharmony.aloha.semantics.SemanticsUdfException and rethrown. This has the distinct advantage of providing the caller with the exact feature specification that failed along with the features that were present and missing and the input data that caused the problem.

Example usage: Assume a we have an implementation UnsafeSemantics, implementing com.eharmony.aloha.semantics.Semantics\[Xyz\]. We can recast the errors by doing

// An object (note that because provideSemanticsUdfException = true by default, we don't need to specify it if
// we want this semantics to always enrich exceptions.
object SemanticsObjWithEnrichedErrors
    extends UnsafeSemantics
    with RethrowingSemantics[Xyz]

// Here's a way to create a class to allow the caller to specify whether he wants
// [[com.eharmony.aloha.semantics.SemanticsUdfException]]s to be provided.
case class SemanticsClsWithEnrichedErrors(override val provideSemanticsUdfException: Boolean = true)
    extends UnsafeSemantics
    with RethrowingSemantics[Xyz]

val featureSpecification = "[Some feature spec here ...]"
val xyz: Xyz = getXyz()
// Don't just call right.get in prod.
val f = SemanticsObjWithEnrichedErrors.createFunction[SomeOutputType](featureSpecification).right.get

// If the following line throws an exception, it'll throw a SemanticsUdfException which provides additional
// information.
val r = f(xyz)

A: the input type.

Linear Supertypes

Semantics[A], Closeable, AutoCloseable, AnyRef, Any

Known Subclasses

CompiledSemantics

Abstract Value Members

abstract def accessorFunctionNames: Seq[String]

Returns the string representations of all of the data "variables" used by functions created from this Semantics object.
Returns the string representations of all of the data "variables" used by functions created from this Semantics object.

Definition Classes
Semantics
abstract def close(): Unit

Definition Classes
Closeable → AutoCloseable
Annotations
@throws( classOf[java.io.IOException] )
abstract def refInfoA: RefInfo[A]

returns
a com.eharmony.aloha.reflect.RefInfo for input type A.

Definition Classes
Semantics

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( ... )
def createFunction[B](codeSpec: String, default: Option[B] = None)(implicit arg0: RefInfo[B]): Either[Seq[String], GenAggFunc[A, B]]

Create a function from A to B.
Create a function from A to B. If provideSemanticsUdfException is false or the generated function is is com.eharmony.aloha.semantics.func.EnrichedErrorGenAggFunc return the function; otherwise, return the function wrapped in an com.eharmony.aloha.semantics.func.EnrichedErrorGenAggFunc. com.eharmony.aloha.semantics.func.GenAggFunc produced by the underlying semantics.
B
The return type of the function.
codeSpec
specification for a function to be produced by this semantics.
default
a default value in the case that the function would produce an optional type.

Definition Classes
ErrorEnrichingSemantics → Semantics
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
def provideSemanticsUdfException: Boolean

Only when this function returns true will the functions produced by this semantics be wrapped in a com.eharmony.aloha.semantics.func.EnrichedErrorGenAggFunc.
Only when this function returns true will the functions produced by this semantics be wrapped in a com.eharmony.aloha.semantics.func.EnrichedErrorGenAggFunc. The default for this function is true. Therefore, when mixing in this trait override this function if we don't want to always wrap the generated functions.

Attributes
protected[this]
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( ... )

Related Doc: package semantics

trait ErrorEnrichingSemantics[A] extends Semantics[A]

Abstract Value Members

abstract def accessorFunctionNames: Seq[String]

abstract def close(): Unit

abstract def refInfoA: RefInfo[A]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def createFunction[B](codeSpec: String, default: Option[B] = None)(implicit arg0: RefInfo[B]): Either[Seq[String], GenAggFunc[A, B]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def provideSemanticsUdfException: Boolean

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Semantics[A]

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped