Packages

package root

Definition Classes: root

package molecule

Definition Classes: root

abstract class DomainStructure extends AnyRef

Domain structure definition

Define a Domain structure to be handled by Molecule in an object that extends this Domain class.

A domain structure consists of traits describing real world entities. Each entity/trait is given a name and defines a list of attributes that are the relevant properties of the entity.

A maxArity number is applied to Domain to tell Molecule how many Attributes it should create boilerplate code for, or how many attribute values are expected at most to be returned from molecule queries. This is to generate a minimum of boilerplate code.

package path.to.your.project
import molecule.Domain

object Community extends Domain(8) { // "Community" domain

  trait Person {          // "Person" entity
    val name = oneString  // Person "name" String attribute definition
    val age  = oneInt     // Person "age" Int attribute definition
  }

  // Additional entities...
}

For larger projects, it is recommended to organize the domain structure in segments of related entity traits within objects:

object Seattle extends Domain(15) {

  object customer { // "customer" segment
    trait Person {
      val name    = oneString
      val age     = oneInt
      val address = one[Address]         // Cardinality-one relationship to Address
      val bought  = many[products.Item]  // Cardinality-many relationship to products.Item
    }
    trait Address {
      val street = oneString.fulltext
      val city   = oneInt
    }
    // ..more entities in the `customer` segment
  }

  object products { // "products" segment
    trait Item {
      val title   = oneString
      val inStock = oneInt
    }
    // ..more entities in the `products` segment
  }

  // Additional segments...
}

Definition Classes: molecule

Options

Requierable

Validations

arrayByte

enumConstructor

many

mapBigDecimal

mapBigInt

mapBoolean

mapByte

mapChar

mapDate

mapDouble

mapDuration

mapFloat

mapInstant

mapInt

mapLocalDate

mapLocalDateTime

mapLocalTime

mapLong

mapOffsetDateTime

mapOffsetTime

mapShort

mapString

mapURI

mapUUID

mapZonedDateTime

one

oneBigDecimal

oneBigInt

oneBoolean

oneByte

oneChar

oneDate

oneDouble

oneDuration

oneEnum

oneFloat

oneInstant

oneInt

oneLocalDate

oneLocalDateTime

oneLocalTime

oneLong

oneOffsetDateTime

oneOffsetTime

oneShort

oneString

oneURI

oneUUID

oneZonedDateTime

refOptions

seqBigDecimal

seqBigInt

seqBoolean

seqChar

seqDate

seqDouble

seqDuration

seqEnum

seqFloat

seqInstant

seqInt

seqLocalDate

seqLocalDateTime

seqLocalTime

seqLong

seqOffsetDateTime

seqOffsetTime

seqShort

seqString

seqURI

seqUUID

seqZonedDateTime

setBigDecimal

setBigInt

setBoolean

setByte

setChar

setDate

setDouble

setDuration

setEnum

setFloat

setInstant

setInt

setLocalDate

setLocalDateTime

setLocalTime

setLong

setOffsetDateTime

setOffsetTime

setShort

setString

setURI

setUUID

setZonedDateTime

stringOptions

molecule.DomainStructure

one

Companion object one

trait one extends refOptions[one]

Source: DomainStructure.scala

Linear Supertypes

refOptions[one], Requierable, AnyRef, Any

Known Subclasses

one

Ordering

Alphabetic
By Inheritance

Inherited

one
refOptions
Requierable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

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
def apply[Ref](description: String): refOptions[one]

Definition Classes
refOptions
def apply[Ref](implicit x: DummyImplicit): refOptions[one]
Apply entity type to reference.
Apply entity type to reference.
Ref
Ref entity type

Definition Classes
refOptions
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native() @IntrinsicCandidate()
def descr(description: String): one

Definition Classes
refOptions
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native() @IntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val mandatory: one

Definition Classes
refOptions
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native() @IntrinsicCandidate()
lazy val owner: one
Owner option.
Owner option.
This entity owns the referenced entity/entities.
- If this entity is deleted, its references are deleted too (and recursively if sub entities have owned entities!)

Definition Classes
refOptions
def require(attrs: Requierable*): one

Definition Classes
refOptions
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] ) @Deprecated
Deprecated

Packages

one

Companion object one

trait one extends refOptions[one]

Value Members

Deprecated Value Members

Inherited from refOptions[one]

Inherited from Requierable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

one 

Companion object one

trait one extends refOptions[one]

Value Members

Deprecated Value Members

Inherited from refOptions[one]

Inherited from Requierable

Inherited from AnyRef

Inherited from Any

Ungrouped

one