Composite_In_2_Factory2

Companion object Composite_In_2_Factory2

trait Composite_In_2_Factory2 extends AnyRef

Factory methods to create composite input molecules of arity 1-22 awaiting 2 inputs.

Molecules

Molecules are type-safe custom Scala models of data structures in a Datomic database.

Molecules are build with your custom meta-DSL that is auto-generated from your Schema Definition file. Calling m on your modelled DSL structure lets Molecule macros create a custom molecule, ready for retrieving or manipulating data in the Datomic database.

Each molecule consists of one or more attributes that can have values or expressions applied. The arity of a molecule is determined by the number of attributes that will return data when the molecule is queried against the Datomic database. Attributes returning data are called "output attributes".

Composite molecules

Composite molecules model entities with attributes from different namespaces that are not necessarily related. Each group of attributes is modelled by a molecule and these "sub-molecules" are tied together with + methods to form a composite molecule.

Composite input molecules

Composite input molecules awaiting 2 inputs have 2 attributes with ? applied to mark that it awaits inputs at runtime for those attributes. Once the input molecule has been resolved with inputs, a normal molecule is returned that we can query against the Datomic database.

For brevity, only arity 1 and 2 method signatures are shown. Arity 3-22 follow the same pattern.

Source: Composite_In_2_Factory.scala
See also: Manual | Tests

Linear Supertypes

AnyRef, Any

Known Subclasses

in2_out2, in3_out2, Composite_In_2_Factory2

Type Hierarchy

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

Composite_In_2_Factory2
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

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[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
macro def m[I1, I2, T1, T2](dsl: Composite_In_2_02[I1, I2, T1, T2]): InputMolecule_2_02[I1, I2, T1, T2]
Macro creation of composite input molecule awaiting 2 inputs from user-defined DSL with 2 output groups (arity 2).
Macro creation of composite input molecule awaiting 2 inputs from user-defined DSL with 2 output groups (arity 2).

The builder pattern is used to add one or more attributes to an initial namespace like Person from the example below. Further non-related attributes can be tied together with the + method to form "composite molecules" that is basically just attributes sharing the same entity id.

Applying the ? marker to attributes changes the semantics of the composite molecule to become a "composite input molecule" that awaits input at runtime for the attributes marked with ?.

Once the composite input molecule models the desired data structure and has been resolved with input we can call various actions on it, like get that retrieves matching data from the database.
```
// Apply `?` to `age` and `score` attributes to create composite input molecule
val personsAgeScore = m(Person.name.age_(?) + Tag.score(?))

// At runtime, `age` and `score` values are applied to get the Person's name
personsAgeScore(42, 7).get.head === ("Ben", 7)
```
Composite input molecules of arity 2 has two sub-molecules with output attribute(s). If a sub-molecule has multiple output attributes, a tuple is returned, otherwise just the single value. The two groups of either a single type or tuple are then tied together in an outer composite tuple:
```
Composite input molecule          Composite type (2 output groups)

A.a1(?)    + B.b1(?)        =>    (a1, b1)
A.a1(?)    + B.b1(?).b2     =>    (a1, (b1, b2))
A.a1.a2(?) + B.b1(?)        =>    ((a1, a2), b1)
A.a1.a2(?) + B.b1(?).b2     =>    ((a1, a2), (b1, b2)) etc...

We could even have additional non-output sub-molecules:
A.a1.a2 + B.b1(?).b2 + C.c1_(?)     =>    ((a1, a2), (b1, b2)) etc...
```
Translating into the example:
```
m(Person.name(?)     + Tag.score(?)      )("Ben", 7).get.head === ("Ben", 7)
m(Person.name(?)     + Tag.score(?).flags)("Ben", 7).get.head === ("Ben", (7, 3))
m(Person.name.age(?) + Tag.score(?)      )(42, 7)   .get.head === (("Ben", 42), 7)
m(Person.name.age(?) + Tag.score(?).flags)(42, 7)   .get.head === (("Ben", 42), (7, 3))

m(Person.name.age +
  Tag.score(?).flags +
  Cat.name_(?))(7, "pitcher").get.head === (("Ben", 42), (7, 3))
```
I1
Type of input attribute 1 (name: String or age: Int)
I2
Type of input attribute 2 (score: Int)
T1
Type of output group 1
T2
Type of output group 2
dsl
User-defined DSL structure modelling the composite input molecule awaiting 2 inputs
returns
Composite input molecule awaiting 2 inputs
macro def m[I1, I2, T1](dsl: Composite_In_2_01[I1, I2, T1]): InputMolecule_2_01[I1, I2, T1]
Macro creation of composite input molecule awaiting 2 inputs from user-defined DSL with 1 output group (arity 1).
Macro creation of composite input molecule awaiting 2 inputs from user-defined DSL with 1 output group (arity 1).

The builder pattern is used to add one or more attributes to an initial namespace like Person from the example below. Further non-related attributes can be tied together with the + method to form "composite molecules" that is basically just attributes sharing the same entity id.

Applying the ? marker to attributes changes the semantics of the composite molecule to become a "composite input molecule" that awaits input at runtime for the attributes marked with ?.

Once the composite input molecule models the desired data structure and has been resolved with input we can call various actions on it, like get that retrieves matching data from the database.
```
// Apply `?` to `age` and `score` attributes to create composite input molecule
val personsAgeScore = m(Person.name.age_(?) + Tag.score_(?))

// At runtime, `age` and `score` values are applied to get the Person's name
personsAgeScore(42, 7).get.head === "Ben"
```
Composite input molecules of arity 1 has only one sub-molecule with output attribute(s). If the sub-molecule has multiple output attributes, a tuple is returned, otherwise just the single value:
```
Composite input molecule            Composite type (1 output group)

A.a1(?)       + B.b1_(?)      =>    a1
A.a1.a2(?)    + B.b1_(?)      =>    (a1, a2)
A.a1.a2.a3(?) + B.b1_(?)      =>    (a1, a2, a3)

A.a1_(?) + B.b1(?)            =>    b1
A.a1_(?) + B.b1.b2(?)         =>    (b1, b2)
A.a1_(?) + B.b1.b2.b3(?)      =>    (b1, b2, b3)

We could even have multiple tacit sub-molecules with multiple tacit attributes
A.a1_(?).a2_ + B.b1_(?) + C.c1.c2_.c3     =>    (c1, c3)
```
So, given 2 output attributes, a tuple is returned:
```
m(Person.name.age(?) + Tag.score_(?))(42, 7).get.head === ("Ben", 42)
//  A   . a1 . a2(?) +  B .   b1_(?)                   => (  a1 , a2)
```
I1
Type of input attribute 1 (age: Int)
I2
Type of input attribute 2 (score: Int)
T1
Type of output group
dsl
User-defined DSL structure modelling the composite input molecule awaiting 2 inputs
returns
Composite input molecule awaiting 2 inputs
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
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(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

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.

Packages

Sub-packages

Composite_In_2_Factory2

Companion object Composite_In_2_Factory2

trait Composite_In_2_Factory2 extends AnyRef

Molecules

Composite molecules

Composite input molecules

Value Members

Inherited from AnyRef

Inherited from Any

composite2

Ungrouped

Packages

Sub-packages

Composite_In_2_Factory2

Companion object Composite_In_2_Factory2

trait Composite_In_2_Factory2 extends AnyRef

Molecules

Composite molecules

Composite input molecules

Value Members

Inherited from AnyRef

Inherited from Any

composite2

Ungrouped

Composite_In_2_Factory2