Molecule0.24.0 < Back

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 DomainStructure 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.

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

object Community extends Domain { // "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 DomainStructure {

  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
      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

mapString

Companion trait mapString

object mapString extends mapString

Source: DomainStructure.scala

Linear Supertypes

mapString, stringOptions[mapString, Map[String, String]], Options[mapString, Map[String, String], String], Requierable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

mapString
mapString
stringOptions
Options
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 alias(altAttrName: String): mapString
Alias to non-compatible attribute name like type or first-name etc.
Alias to non-compatible attribute name like type or first-name etc.
Molecule then creates an alias to the special name in the schema so that queries will match both the attribute name and the alias.

Definition Classes
Options
def allowedValues(vs: Seq[String], failureMsg: String): mapString

Definition Classes
Options
def allowedValues(v: String, vs: String*): mapString

Definition Classes
Options
def apply(description: String): mapString

Definition Classes
Options
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): mapString
Description of attribute
Description of attribute

Definition Classes
Options
def email(msg: String): mapString

Definition Classes
stringOptions
val email: mapString

Definition Classes
stringOptions
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()
lazy val index: mapString
Index option (defaults to true).
Index option (defaults to true).

Generated index for this attribute.

Definition Classes
Options
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
lazy val mandatory: mapString

Definition Classes
Options
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()
def regex(expr: String, msg: String = ""): mapString

Definition Classes
stringOptions
def require(attrs: Requierable*): mapString

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
lazy val unique: mapString
Unique value option.
Unique value option.

Attribute value is unique to each entity.

Attempts to insert a duplicate value for a different entity id will fail.

Definition Classes
Options
val value: Map[String, String]

Definition Classes
Options
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

mapString

Companion trait mapString

object mapString extends mapString

Value Members

Deprecated Value Members

Inherited from mapString

Inherited from stringOptions[mapString, Map[String, String]]

Inherited from Options[mapString, Map[String, String], String]

Inherited from Requierable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

mapString 

Companion trait mapString

object mapString extends mapString

Value Members

Deprecated Value Members

Inherited from mapString

Inherited from stringOptions[mapString, Map[String, String]]

Inherited from Options[mapString, Map[String, String], String]

Inherited from Requierable

Inherited from AnyRef

Inherited from Any

Ungrouped

mapString