Packages

c

molecule

DomainStructure

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...
}
Source
DomainStructure.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. DomainStructure
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DomainStructure(maxArity: Int)

    maxArity

    Number of possible attributes in molecule output.

Type Members

  1. sealed trait Options[Self, Tpe, BaseTpe] extends Requierable

    Attribute options.

  2. trait Requierable extends AnyRef
  3. trait Validations[Self, BaseTpe] extends AnyRef
  4. trait arrayByte extends Options[arrayByte, Seq[Byte], Byte] with Validations[oneByte, Byte]
  5. trait enumConstructor extends AnyRef
  6. trait many extends refOptions[many]
  7. trait mapBigDecimal extends Options[mapBigDecimal, Map[String, BigDecimal], BigDecimal]
  8. trait mapBigInt extends Options[mapBigInt, Map[String, BigInt], BigInt]
  9. trait mapBoolean extends Options[mapBoolean, Map[String, Boolean], Boolean]
  10. trait mapByte extends Options[mapByte, Map[String, Byte], Byte]
  11. trait mapChar extends Options[mapChar, Map[String, Char], Char]
  12. trait mapDate extends Options[mapDate, Map[String, Date], Date]
  13. trait mapDouble extends Options[mapDouble, Map[String, Double], Double]
  14. trait mapDuration extends Options[mapDuration, Map[String, Duration], Duration]
  15. trait mapFloat extends Options[mapFloat, Map[String, Float], Float]
  16. trait mapInstant extends Options[mapInstant, Map[String, Instant], Instant]
  17. trait mapInt extends Options[mapInt, Map[String, Int], Int]
  18. trait mapLocalDate extends Options[mapLocalDate, Map[String, LocalDate], LocalDate]
  19. trait mapLocalDateTime extends Options[mapLocalDateTime, Map[String, LocalDateTime], LocalDateTime]
  20. trait mapLocalTime extends Options[mapLocalTime, Map[String, LocalTime], LocalTime]
  21. trait mapLong extends Options[mapLong, Map[String, Long], Long]
  22. trait mapOffsetDateTime extends Options[mapOffsetDateTime, Map[String, OffsetDateTime], OffsetDateTime]
  23. trait mapOffsetTime extends Options[mapOffsetTime, Map[String, OffsetTime], OffsetTime]
  24. trait mapShort extends Options[mapShort, Map[String, Short], Short]
  25. trait mapString extends stringOptions[mapString, Map[String, String]]
  26. trait mapURI extends Options[mapURI, Map[String, URI], URI]
  27. trait mapUUID extends Options[mapUUID, Map[String, UUID], UUID]
  28. trait mapZonedDateTime extends Options[mapZonedDateTime, Map[String, ZonedDateTime], ZonedDateTime]
  29. trait one extends refOptions[one]
  30. trait oneBigDecimal extends Options[oneBigDecimal, BigDecimal, BigDecimal] with Validations[oneBigDecimal, BigDecimal]
  31. trait oneBigInt extends Options[oneBigInt, BigInt, BigInt] with Validations[oneBigInt, BigInt]
  32. trait oneBoolean extends Options[oneBoolean, Boolean, Boolean] with Validations[oneBoolean, Boolean]
  33. trait oneByte extends Options[oneByte, Byte, Byte] with Validations[oneByte, Byte]
  34. trait oneChar extends Options[oneChar, Char, Char] with Validations[oneChar, Char]
  35. trait oneDate extends Options[oneDate, Date, Date] with Validations[oneDate, Date]
  36. trait oneDouble extends Options[oneDouble, Double, Double] with Validations[oneDouble, Double]
  37. trait oneDuration extends Options[oneDuration, Duration, Duration] with Validations[oneDuration, Duration]
  38. trait oneFloat extends Options[oneFloat, Float, Float] with Validations[oneFloat, Float]
  39. trait oneInstant extends Options[oneInstant, Instant, Instant] with Validations[oneInstant, Instant]
  40. trait oneInt extends Options[oneInt, Int, Int] with Validations[oneInt, Int]
  41. trait oneLocalDate extends Options[oneLocalDate, LocalDate, LocalDate] with Validations[oneLocalDate, LocalDate]
  42. trait oneLocalDateTime extends Options[oneLocalDateTime, LocalDateTime, LocalDateTime] with Validations[oneLocalDateTime, LocalDateTime]
  43. trait oneLocalTime extends Options[oneLocalTime, LocalTime, LocalTime] with Validations[oneLocalTime, LocalTime]
  44. trait oneLong extends Options[oneLong, Long, Long] with Validations[oneLong, Long]
  45. trait oneOffsetDateTime extends Options[oneOffsetDateTime, OffsetDateTime, OffsetDateTime] with Validations[oneOffsetDateTime, OffsetDateTime]
  46. trait oneOffsetTime extends Options[oneOffsetTime, OffsetTime, OffsetTime] with Validations[oneOffsetTime, OffsetTime]
  47. trait oneShort extends Options[oneShort, Short, Short] with Validations[oneShort, Short]
  48. trait oneString extends stringOptions[oneString, String] with Validations[oneString, String]
  49. trait oneURI extends Options[oneURI, URI, URI] with Validations[oneURI, URI]
  50. trait oneUUID extends Options[oneUUID, UUID, UUID] with Validations[oneUUID, UUID]
  51. trait oneZonedDateTime extends Options[oneZonedDateTime, ZonedDateTime, ZonedDateTime] with Validations[oneZonedDateTime, ZonedDateTime]
  52. trait refOptions[Self] extends Requierable
  53. trait seqBigDecimal extends Options[seqBigDecimal, Seq[BigDecimal], BigDecimal] with Validations[oneBigDecimal, BigDecimal]
  54. trait seqBigInt extends Options[seqBigInt, Seq[BigInt], BigInt] with Validations[oneBigInt, BigInt]
  55. trait seqBoolean extends Options[seqBoolean, Seq[Boolean], Boolean] with Validations[oneBoolean, Boolean]
  56. trait seqChar extends Options[seqChar, Seq[Char], Char] with Validations[oneChar, Char]
  57. trait seqDate extends Options[seqDate, Seq[Date], Date] with Validations[oneDate, Date]
  58. trait seqDouble extends Options[seqDouble, Seq[Double], Double] with Validations[oneDouble, Double]
  59. trait seqDuration extends Options[seqDuration, Seq[Duration], Duration] with Validations[oneDuration, Duration]
  60. trait seqFloat extends Options[seqFloat, Seq[Float], Float] with Validations[oneFloat, Float]
  61. trait seqInstant extends Options[seqInstant, Seq[Instant], Instant] with Validations[oneInstant, Instant]
  62. trait seqInt extends Options[seqInt, Seq[Int], Int] with Validations[oneInt, Int]
  63. trait seqLocalDate extends Options[seqLocalDate, Seq[LocalDate], LocalDate] with Validations[oneLocalDate, LocalDate]
  64. trait seqLocalDateTime extends Options[seqLocalDateTime, Seq[LocalDateTime], LocalDateTime] with Validations[oneLocalDateTime, LocalDateTime]
  65. trait seqLocalTime extends Options[seqLocalTime, Seq[LocalTime], LocalTime] with Validations[oneLocalTime, LocalTime]
  66. trait seqLong extends Options[seqLong, Seq[Long], Long] with Validations[oneLong, Long]
  67. trait seqOffsetDateTime extends Options[seqOffsetDateTime, Seq[OffsetDateTime], OffsetDateTime] with Validations[oneOffsetDateTime, OffsetDateTime]
  68. trait seqOffsetTime extends Options[seqOffsetTime, Seq[OffsetTime], OffsetTime] with Validations[oneOffsetTime, OffsetTime]
  69. trait seqShort extends Options[seqShort, Seq[Short], Short] with Validations[oneShort, Short]
  70. trait seqString extends stringOptions[seqString, Seq[String]] with Validations[oneString, String]
  71. trait seqURI extends Options[seqURI, Seq[URI], URI] with Validations[oneURI, URI]
  72. trait seqUUID extends Options[seqUUID, Seq[UUID], UUID] with Validations[oneUUID, UUID]
  73. trait seqZonedDateTime extends Options[seqZonedDateTime, Seq[ZonedDateTime], ZonedDateTime] with Validations[oneZonedDateTime, ZonedDateTime]
  74. trait setBigDecimal extends Options[setBigDecimal, Set[BigDecimal], BigDecimal] with Validations[oneBigDecimal, BigDecimal]
  75. trait setBigInt extends Options[setBigInt, Set[BigInt], BigInt] with Validations[oneBigInt, BigInt]
  76. trait setBoolean extends Options[setBoolean, Set[Boolean], Boolean] with Validations[oneBoolean, Boolean]
  77. trait setByte extends Options[setByte, Set[Byte], Byte] with Validations[oneByte, Byte]
  78. trait setChar extends Options[setChar, Set[Char], Char] with Validations[oneChar, Char]
  79. trait setDate extends Options[setDate, Set[Date], Date] with Validations[oneDate, Date]
  80. trait setDouble extends Options[setDouble, Set[Double], Double] with Validations[oneDouble, Double]
  81. trait setDuration extends Options[setDuration, Set[Duration], Duration] with Validations[oneDuration, Duration]
  82. trait setFloat extends Options[setFloat, Set[Float], Float] with Validations[oneFloat, Float]
  83. trait setInstant extends Options[setInstant, Set[Instant], Instant] with Validations[oneInstant, Instant]
  84. trait setInt extends Options[setInt, Set[Int], Int] with Validations[oneInt, Int]
  85. trait setLocalDate extends Options[setLocalDate, Set[LocalDate], LocalDate] with Validations[oneLocalDate, LocalDate]
  86. trait setLocalDateTime extends Options[setLocalDateTime, Set[LocalDateTime], LocalDateTime] with Validations[oneLocalDateTime, LocalDateTime]
  87. trait setLocalTime extends Options[setLocalTime, Set[LocalTime], LocalTime] with Validations[oneLocalTime, LocalTime]
  88. trait setLong extends Options[setLong, Set[Long], Long] with Validations[oneLong, Long]
  89. trait setOffsetDateTime extends Options[setOffsetDateTime, Set[OffsetDateTime], OffsetDateTime] with Validations[oneOffsetDateTime, OffsetDateTime]
  90. trait setOffsetTime extends Options[setOffsetTime, Set[OffsetTime], OffsetTime] with Validations[oneOffsetTime, OffsetTime]
  91. trait setShort extends Options[setShort, Set[Short], Short] with Validations[oneShort, Short]
  92. trait setString extends stringOptions[setString, Set[String]] with Validations[oneString, String]
  93. trait setURI extends Options[setURI, Set[URI], URI] with Validations[oneURI, URI]
  94. trait setUUID extends Options[setUUID, Set[UUID], UUID] with Validations[oneUUID, UUID]
  95. trait setZonedDateTime extends Options[setZonedDateTime, Set[ZonedDateTime], ZonedDateTime] with Validations[oneZonedDateTime, ZonedDateTime]
  96. trait stringOptions[Self, Tpe] extends Options[Self, Tpe, String]

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. object arrayByte extends arrayByte
  20. object many extends many
  21. object mapBigDecimal extends mapBigDecimal
  22. object mapBigInt extends mapBigInt
  23. object mapBoolean extends mapBoolean
  24. object mapByte extends mapByte
  25. object mapChar extends mapChar
  26. object mapDate extends mapDate
  27. object mapDouble extends mapDouble
  28. object mapDuration extends mapDuration
  29. object mapFloat extends mapFloat
  30. object mapInstant extends mapInstant
  31. object mapInt extends mapInt
  32. object mapLocalDate extends mapLocalDate
  33. object mapLocalDateTime extends mapLocalDateTime
  34. object mapLocalTime extends mapLocalTime
  35. object mapLong extends mapLong
  36. object mapOffsetDateTime extends mapOffsetDateTime
  37. object mapOffsetTime extends mapOffsetTime
  38. object mapShort extends mapShort
  39. object mapString extends mapString
  40. object mapURI extends mapURI
  41. object mapUUID extends mapUUID
  42. object mapZonedDateTime extends mapZonedDateTime
  43. object one extends one
  44. object oneBigDecimal extends oneBigDecimal
  45. object oneBigInt extends oneBigInt
  46. object oneBoolean extends oneBoolean
  47. object oneByte extends oneByte
  48. object oneChar extends oneChar
  49. object oneDate extends oneDate
  50. object oneDouble extends oneDouble
  51. object oneDuration extends oneDuration
  52. object oneEnum extends enumConstructor
  53. object oneFloat extends oneFloat
  54. object oneInstant extends oneInstant
  55. object oneInt extends oneInt
  56. object oneLocalDate extends oneLocalDate
  57. object oneLocalDateTime extends oneLocalDateTime
  58. object oneLocalTime extends oneLocalTime
  59. object oneLong extends oneLong
  60. object oneOffsetDateTime extends oneOffsetDateTime
  61. object oneOffsetTime extends oneOffsetTime
  62. object oneShort extends oneShort
  63. object oneString extends oneString
  64. object oneURI extends oneURI
  65. object oneUUID extends oneUUID
  66. object oneZonedDateTime extends oneZonedDateTime
  67. object seqBigDecimal extends seqBigDecimal
  68. object seqBigInt extends seqBigInt
  69. object seqBoolean extends seqBoolean
  70. object seqChar extends seqChar
  71. object seqDate extends seqDate
  72. object seqDouble extends seqDouble
  73. object seqDuration extends seqDuration
  74. object seqEnum extends enumConstructor
  75. object seqFloat extends seqFloat
  76. object seqInstant extends seqInstant
  77. object seqInt extends seqInt
  78. object seqLocalDate extends seqLocalDate
  79. object seqLocalDateTime extends seqLocalDateTime
  80. object seqLocalTime extends seqLocalTime
  81. object seqLong extends seqLong
  82. object seqOffsetDateTime extends seqOffsetDateTime
  83. object seqOffsetTime extends seqOffsetTime
  84. object seqShort extends seqShort
  85. object seqString extends seqString
  86. object seqURI extends seqURI
  87. object seqUUID extends seqUUID
  88. object seqZonedDateTime extends seqZonedDateTime
  89. object setBigDecimal extends setBigDecimal
  90. object setBigInt extends setBigInt
  91. object setBoolean extends setBoolean
  92. object setByte extends setByte
  93. object setChar extends setChar
  94. object setDate extends setDate
  95. object setDouble extends setDouble
  96. object setDuration extends setDuration
  97. object setEnum extends enumConstructor
  98. object setFloat extends setFloat
  99. object setInstant extends setInstant
  100. object setInt extends setInt
  101. object setLocalDate extends setLocalDate
  102. object setLocalDateTime extends setLocalDateTime
  103. object setLocalTime extends setLocalTime
  104. object setLong extends setLong
  105. object setOffsetDateTime extends setOffsetDateTime
  106. object setOffsetTime extends setOffsetTime
  107. object setShort extends setShort
  108. object setString extends setString
  109. object setURI extends setURI
  110. object setUUID extends setUUID
  111. object setZonedDateTime extends setZonedDateTime

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

opt

Ungrouped