com.opendatagroup.hadrian.ast

EngineConfig

case class EngineConfig(name: String, method: Method, inputPlaceholder: AvroPlaceholder, outputPlaceholder: AvroPlaceholder, begin: Seq[Expression], action: Seq[Expression], end: Seq[Expression], fcns: Map[String, FcnDef], zero: Option[String], merge: Option[Seq[Expression]], cells: Map[String, Cell], pools: Map[String, Pool], randseed: Option[Long], doc: Option[String], version: Option[Int], metadata: Map[String, String], options: Map[String, JsonNode], pos: Option[String] = scala.None) extends Ast with Product with Serializable

Abstract syntax tree for a whole PFA document.

name

name of the PFA engine (may be auto-generated)

method

execution method ("map", "emit", or "fold")

inputPlaceholder

input type as a placeholder (so it can exist before type resolution)

outputPlaceholder

output type as a placeholder (so it can exist before type resolution)

begin

"begin" algorithm

action

"action" algorithm

end

"end" algorithm

fcns

user-defined functions

zero

initial value for "fold" tally

merge

"merge" algorithm for "fold"

cells

"cell" definitions

pools

"pool" definitions

randseed

random number seed

doc

optional documentation string

version

optional version number

metadata

computer-readable documentation

options

implementation options

pos

source file location from the locator mark

Linear Supertypes
Serializable, Serializable, Product, Equals, Ast, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EngineConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Ast
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EngineConfig(name: String, method: Method, inputPlaceholder: AvroPlaceholder, outputPlaceholder: AvroPlaceholder, begin: Seq[Expression], action: Seq[Expression], end: Seq[Expression], fcns: Map[String, FcnDef], zero: Option[String], merge: Option[Seq[Expression]], cells: Map[String, Cell], pools: Map[String, Pool], randseed: Option[Long], doc: Option[String], version: Option[Int], metadata: Map[String, String], options: Map[String, JsonNode], pos: Option[String] = scala.None)

    name

    name of the PFA engine (may be auto-generated)

    method

    execution method ("map", "emit", or "fold")

    inputPlaceholder

    input type as a placeholder (so it can exist before type resolution)

    outputPlaceholder

    output type as a placeholder (so it can exist before type resolution)

    begin

    "begin" algorithm

    action

    "action" algorithm

    end

    "end" algorithm

    fcns

    user-defined functions

    zero

    initial value for "fold" tally

    merge

    "merge" algorithm for "fold"

    cells

    "cell" definitions

    pools

    "pool" definitions

    randseed

    random number seed

    doc

    optional documentation string

    version

    optional version number

    metadata

    computer-readable documentation

    options

    implementation options

    pos

    source file location from the locator mark

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. val action: Seq[Expression]

    "action" algorithm

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. val begin: Seq[Expression]

    "begin" algorithm

  9. val cells: Map[String, Cell]

    "cell" definitions

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def collect[X](pf: PartialFunction[Ast, X]): Seq[X]

    Walk over tree applying a partial function, returning a list of results in its domain.

    Walk over tree applying a partial function, returning a list of results in its domain.

    pf

    partial function that takes any Ast as an argument, returning anything

    returns

    a result for each abstract syntax tree node in the pf function's domain

    Definition Classes
    EngineConfigAst
  12. val doc: Option[String]

    optional documentation string

  13. val end: Seq[Expression]

    "end" algorithm

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(other: Any): Boolean

    Check equality for all fields except pos.

    Check equality for all fields except pos.

    Definition Classes
    EngineConfig → Equals → Ast → AnyRef → Any
  16. val fcns: Map[String, FcnDef]

    user-defined functions

  17. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Compute hash code for all fields except pos.

    Compute hash code for all fields except pos.

    Definition Classes
    EngineConfigAst → AnyRef → Any
  20. def input: AvroType

    Input type after type resolution.

  21. val inputPlaceholder: AvroPlaceholder

    input type as a placeholder (so it can exist before type resolution)

  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. def jsonNode(lineNumbers: Boolean, memo: Set[String]): JsonNode

    Convert this abstract syntax tree into a Jackson node

    Convert this abstract syntax tree into a Jackson node

    lineNumbers

    if true, include locator marks at the beginning of each JSON object

    memo

    used to avoid recursion; provide an empty set if unsure

    returns

    Jackson representation of the JSON

    Definition Classes
    EngineConfigAst
  24. val merge: Option[Seq[Expression]]

    "merge" algorithm for "fold"

  25. val metadata: Map[String, String]

    computer-readable documentation

  26. val method: Method

    execution method ("map", "emit", or "fold")

  27. val name: String

    name of the PFA engine (may be auto-generated)

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

    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  31. val options: Map[String, JsonNode]

    implementation options

  32. def output: AvroType

    Output type after type resolution.

  33. val outputPlaceholder: AvroPlaceholder

    output type as a placeholder (so it can exist before type resolution)

  34. val pools: Map[String, Pool]

    "pool" definitions

  35. val pos: Option[String]

    source file location from the locator mark

    source file location from the locator mark

    Definition Classes
    EngineConfigAst
  36. val randseed: Option[Long]

    random number seed

  37. def replace(pf: PartialFunction[Ast, Ast]): Ast

    Walk over tree applying a partial function, returning a transformed copy of the tree.

    Walk over tree applying a partial function, returning a transformed copy of the tree.

    pf

    partial function that takes any Ast as an argument, returning a replacement Ast

    returns

    tree with nodes in the pf function's domain transformed; everything else left as-is

    Definition Classes
    EngineConfigAst
  38. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  39. def toJson(lineNumbers: Boolean = true): String

    Serialize this abstract syntax tree as a JSON string.

    Serialize this abstract syntax tree as a JSON string.

    lineNumbers

    if true, include locator marks at the beginning of each JSON object

    returns

    JSON string

    Definition Classes
    Ast
  40. def toString(): String

    Calls toJson(false).

    Calls toJson(false).

    Definition Classes
    Ast → AnyRef → Any
  41. val version: Option[Int]

    optional version number

  42. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. def walk(task: Task, symbolTable: SymbolTable, functionTable: FunctionTable, engineOptions: EngineOptions, pfaVersion: PFAVersion): (AstContext, TaskResult)

    Walk over tree applying a Task while checking for semantic errors.

    Walk over tree applying a Task while checking for semantic errors.

    This is how Java is generated from an abstract syntax tree: the Task in that case is JVMCompiler.

    task

    generic task to perform on this abstract syntax tree node's context

    symbolTable

    used to look up symbols, cells, and pools

    functionTable

    used to look up functions

    engineOptions

    implementation options

    returns

    (information about this abstract syntax tree node after type-checking, result of the generic task)

    Definition Classes
    EngineConfigAst
  46. def walk(task: Task, version: PFAVersion): TaskResult

    Walk with a blank symbolTable, a blank functionTable, and empty engineOptions

    Walk with a blank symbolTable, a blank functionTable, and empty engineOptions

    Definition Classes
    Ast
  47. val zero: Option[String]

    initial value for "fold" tally

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Ast

Inherited from AnyRef

Inherited from Any

Ungrouped