Packages

  • package root

    Documentation/API for the Molecule library - a meta DSL for the Datomic database.

    Manual | scalamolecule.org | Github | Forum

    Definition Classes
    root
  • package molecule

    Molecule library - a Scala meta-DSL for the Datomic database.

    Molecule library - a Scala meta-DSL for the Datomic database.

    See api package for various api imports to start using Molecule.

    Sub-packages

    api Molecule API.
    ast Internal Molecule ASTs.
    boilerplate Internal interfaces for auto-generated DSL boilerplate code.
    composition    Builder methods to compose molecules.
    exceptions Exceptions thrown by Molecule.
    expression Attribute expressions and operations.
    facade Molecule facades to Datomic.
    factory Implicit macro methods `m` to instantiate molecules from custom DSL molecule constructs.
    input Input molecules awaiting input.
    macros Internal macros generating molecule code from custom DSL molecule constructs.
    generic Interfaces to generic information about datoms and Datomic database.
    ops Internal operational helpers for transforming DSL to molecule.
    schema Schema definition DSL.
    transform Internal transformers from DSL to Model/Query/Transaction.
    util Internal Java database functions for Datomic.

    Definition Classes
    root
  • package input

    Input molecules awaiting input.

    Input molecules awaiting input.

    Input molecules are molecules that awaits one or more inputs at runtime. When input value is applied, the input molecule is resolved and a standard molecule is returned that we can then call actions on.

    Input molecule queries are cached by Datomic. So there is a runtime performance gain in using input molecules. Furthermore, input molecules are a good fit for re-use for queries where only a few parameters change.

    Input molecules can await 1, 2 or 3 inputs and are constructed by applying the ? marker to attributes. If one marker is applied, we get a InputMolecule_1, 2 inputs creates an InputMolecule_2 and 3 an InputMolecule_3.

    The three input molecule interfaces come in arity-versions corresponding to the number of non-?-marked attributes in the input molecule. Let's see a simple example:

    // Sample data
Person.name.age insert List(("Ben", 42), ("Liz", 34))

// Input molecule created at compile time. Awaits a name of type String
val ageOfPersons: InputMolecule_1.InputMolecule_1_01[String, Int] = m(Person.name_(?).age)

// Resolved molecule. "Ben" input is matched against name attribute
val ageOfPersonsNamedBen: Molecule.Molecule01[Int] = ageOfPersons.apply("Ben")

// Calling action on resolved molecule.
// (Only age is returned since name was marked as tacit with the underscore notation)
ageOfPersonsNamedBen.get === List(42)

// Or we can re-use the input molecule straight away
ageOfPersons("Liz").get === List(34)
    Definition Classes
    molecule
  • package exception
    Definition Classes
    input
  • InputMolecule
  • InputMolecule_1
  • InputMolecule_2
  • InputMolecule_3
t

molecule.input

InputMolecule

trait InputMolecule extends MoleculeBase

Shared interface of all input molecules.

Input molecules are molecules that awaits one or more inputs at runtime. When input value is applied, the input molecule is resolved and a standard molecule is returned that we can then call actions on.

Input molecule queries are cached by Datomic. So there is a runtime performance gain in using input molecules. Furthermore, input molecules are a good fit for re-use for queries where only a few parameters change.

Input molecules can await 1, 2 or 3 inputs and are constructed by applying the ? marker to attributes. If one marker is applied, we get a InputMolecule_1, 2 inputs creates an InputMolecule_3 and 3 an InputMolecule_3.

The three input molecule interfaces come in arity-versions corresponding to the number of non-?-marked attributes in the input molecule. Let's see a simple example:

// Sample data
Person.name.age insert List(
  ("Joe", 42),
  ("Liz", 34)
)

// Input molecule created at compile time. Awaits a name of type String
val ageOfPersons: InputMolecule_1.InputMolecule_1_01[String, Int] = m(Person.name_(?).age)

// Resolved molecule. "Joe" input is matched against name attribute
val ageOfPersonsNamedJoe: Molecule.Molecule01[Int] = ageOfPersons.apply("Joe")

// Calling action on resolved molecule.
// (Only age is returned since name was marked as tacit with the underscore notation)
ageOfPersonsNamedJoe.get === List(42)

// Or we can re-use the input molecule straight away
ageOfPersons("Liz").get === List(34)
Source
InputMolecule.scala
See also

Manual

Linear Supertypes
MoleculeBase, AnyRef, Any
Known Subclasses
InputMolecule_1, InputMolecule_1_01, InputMolecule_1_02, InputMolecule_1_03, InputMolecule_1_04, InputMolecule_1_05, InputMolecule_1_06, InputMolecule_1_07, InputMolecule_1_08, InputMolecule_1_09, InputMolecule_1_10, InputMolecule_1_11, InputMolecule_1_12, InputMolecule_1_13, InputMolecule_1_14, InputMolecule_1_15, InputMolecule_1_16, InputMolecule_1_17, InputMolecule_1_18, InputMolecule_1_19, InputMolecule_1_20, InputMolecule_1_21, InputMolecule_1_22, InputMolecule_2, InputMolecule_2_01, InputMolecule_2_02, InputMolecule_2_03, InputMolecule_2_04, InputMolecule_2_05, InputMolecule_2_06, InputMolecule_2_07, InputMolecule_2_08, InputMolecule_2_09, InputMolecule_2_10, InputMolecule_2_11, InputMolecule_2_12, InputMolecule_2_13, InputMolecule_2_14, InputMolecule_2_15, InputMolecule_2_16, InputMolecule_2_17, InputMolecule_2_18, InputMolecule_2_19, InputMolecule_2_20, InputMolecule_2_21, InputMolecule_2_22, InputMolecule_3, InputMolecule_3_01, InputMolecule_3_02, InputMolecule_3_03, InputMolecule_3_04, InputMolecule_3_05, InputMolecule_3_06, InputMolecule_3_07, InputMolecule_3_08, InputMolecule_3_09, InputMolecule_3_10, InputMolecule_3_11, InputMolecule_3_12, InputMolecule_3_13, InputMolecule_3_14, InputMolecule_3_15, InputMolecule_3_16, InputMolecule_3_17, InputMolecule_3_18, InputMolecule_3_19, InputMolecule_3_20, InputMolecule_3_21, InputMolecule_3_22
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. InputMolecule
  2. MoleculeBase
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract val _model: Model

    Internal Model representation of molecule.

    Internal Model representation of molecule.

    Molecule transforms custom boilerplate DSL constructs to Datomic queries in 3 steps:

    Custom DSL molecule --> Model --> Query --> Datomic query string

    Definition Classes
    MoleculeBase
  2. abstract val _nestedQuery: Option[Query]

    Internal optional Query representation of nested molecule with added entity search for each level.

    Internal optional Query representation of nested molecule with added entity search for each level.

    Molecule transforms custom boilerplate DSL constructs to Datomic queries in 3 steps:

    Custom DSL molecule --> Model --> Query --> Datomic query string

    Definition Classes
    MoleculeBase
  3. abstract val _query: Query

    Internal Query representation of molecule.

    Internal Query representation of molecule.

    Molecule transforms custom boilerplate DSL constructs to Datomic queries in 3 steps:

    Custom DSL molecule --> Model --> Query --> Datomic query string

    Definition Classes
    MoleculeBase
  4. abstract val _rawNestedQuery: Option[Query]

    Internal un-optimized optional Query representation of nested molecule with added entity search for each level.

    Internal un-optimized optional Query representation of nested molecule with added entity search for each level.

    Molecule transforms custom boilerplate DSL constructs to Datomic queries in 3 steps:

    Custom DSL molecule --> Model --> Query --> Datomic query string

    Definition Classes
    MoleculeBase
  5. abstract val _rawQuery: Query

    Internal un-optimized Query representation molecule.

    Internal un-optimized Query representation molecule.

    Molecule transforms custom boilerplate DSL constructs to Datomic queries in 3 steps:

    Custom DSL molecule --> Model --> Query --> Datomic query string

    Definition Classes
    MoleculeBase

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addNilClause(clauses: Seq[Clause], e: Var, kw: KW, v0: Var): Seq[Clause]
    Attributes
    protected
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def cardinality(nsFull: String, attr: String): Int
    Attributes
    protected
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def dataClause(e: String, kw: KW, enumPrefix: Option[String], arg: Any, i: Int): Seq[Clause]
    Attributes
    protected
  9. def deepNil(args: Seq[Any]): Boolean
    Attributes
    protected
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def isExpression(nsFull: String, attr: String): Boolean
    Attributes
    protected
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def isTacit(nsFull: String, attr: String): Boolean
    Attributes
    protected
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def pre[T](enumPrefix: Option[String], arg: T): Any
    Attributes
    protected
  22. def resolveInput[T](query: Query, ph: Placeholder, inputs: Seq[T], ruleName: String = "rule1", unifyRule: Boolean = false): Query
    Attributes
    protected
  23. def resolveOr[I1](or: Or[I1]): Seq[I1]
    Attributes
    protected
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. def valueClauses[TT](e: String, kw: KW, enumPrefix: Option[String], args: TT): Seq[Clause]
    Attributes
    protected
  27. def varsAndPrefixes(query: Query): Seq[(Var, String)]
    Attributes
    protected
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MoleculeBase

Inherited from AnyRef

Inherited from Any

internal

Ungrouped