Class

longevity.model

PType

Related Doc: package model

Permalink

abstract class PType[P] extends AnyRef

a type class for a persistent object

P

the persistent type

Source
PType.scala
Linear Supertypes
Known Subclasses
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PType
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PType()(implicit arg0: TypeKey[P])

    Permalink

Abstract Value Members

  1. abstract def keySet: Set[Key[P]]

    Permalink

    the keys for this persistent type

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from PType[P] to any2stringadd[PType[P]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PType[P], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from PType[P] to ArrowAssoc[PType[P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def emptyKeySet: Set[Key[P]]

    Permalink

    an empty key set.

    an empty key set. this is a convenience method for people using Scala 2.11 who wish to declare an empty key set. you can always do it by hand with Set.empty, but you will have to declare the element type of the set yourself, like so:

    import longevity.model.ptype.Key
    @perstent(keySet = Set.empty[Key[Foo]])
  9. def ensuring(cond: (PType[P]) ⇒ Boolean, msg: ⇒ Any): PType[P]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PType[P] to Ensuring[PType[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (PType[P]) ⇒ Boolean): PType[P]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PType[P] to Ensuring[PType[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): PType[P]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PType[P] to Ensuring[PType[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): PType[P]

    Permalink
    Implicit information
    This member is added by an implicit conversion from PType[P] to Ensuring[PType[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from PType[P] to StringFormat[PType[P]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  19. def index(propsHead: Prop[P, _], propsTail: Prop[P, _]*): Index[P]

    Permalink

    constructs an index for this persistent type based on the supplied set of index props

    constructs an index for this persistent type based on the supplied set of index props

    propsHead

    the first of the properties that define this index

    propsTail

    any remaining properties that define this index

  20. def indexSet: Set[Index[P]]

    Permalink

    the indexes for this persistent type.

    the indexes for this persistent type. defaults to the empty set

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def key[V <: KeyVal[P]](keyValProp: Prop[P, V])(implicit arg0: TypeKey[V]): Key[P]

    Permalink

    constructs a key for this persistent type

    constructs a key for this persistent type

    V

    the type of the key value

    keyValProp

    a property for the key

  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. val pTypeKey: TypeKey[P]

    Permalink

    the type key for the persistent type

  27. def partition(props: Prop[P, _]*): Partition[P]

    Permalink

    a series of properties that determines the partitioning used by the underlying database to distribute data across multiple nodes.

    a series of properties that determines the partitioning used by the underlying database to distribute data across multiple nodes. used to form a primary key

    props

    the properties that determine the partition

  28. def primaryKey[V <: KeyVal[P]](keyValProp: Prop[P, V], partition: Partition[P])(implicit arg0: TypeKey[V]): Key[P]

    Permalink

    constructs a primary key for this persistent type

    constructs a primary key for this persistent type

    V

    the type of the key value

    keyValProp

    a property for the primary key

    partition

    describes the portion of the key value to use to determine which node in the partition the data belongs to. this must form a prefix of the keyValProp

  29. def primaryKey[V <: KeyVal[P]](keyValProp: Prop[P, V], hashed: Boolean = false)(implicit arg0: TypeKey[V]): Key[P]

    Permalink

    constructs a primary key for this persistent type.

    constructs a primary key for this persistent type. the full key value is used to determine the partition

    V

    the type of the key value

    keyValProp

    a property for the primary key

    hashed

    if true, then used a hashed partition (as opposed to a ranged partition) when possible. defaults to false.

  30. lazy val primaryKey: Option[PrimaryKey[P]]

    Permalink

    the optional primary key for this persistent type

  31. def prop[A](path: String)(implicit arg0: TypeKey[A]): Prop[P, A]

    Permalink

    constructs a Prop of type A from the provided property path.

    constructs a Prop of type A from the provided property path.

    the provided type A should match the type of the actual member in the persistent class. type A should not contain any collections, or terminate with polymorphic component. violations will cause an exception to be thrown on DomainModel construction.

    A

    the type of the property

    path

    the property path

  32. lazy val propSet: Set[Prop[P, _]]

    Permalink

    the [Prop properties] for this persistent type

  33. lazy val queryDsl: QueryDsl[P]

    Permalink

    contains implicit imports to make the query DSL work

  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  35. def toString(): String

    Permalink
    Definition Classes
    PType → AnyRef → Any
  36. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. def [B](y: B): (PType[P], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from PType[P] to ArrowAssoc[PType[P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from PType[P] to any2stringadd[PType[P]]

Inherited by implicit conversion StringFormat from PType[P] to StringFormat[PType[P]]

Inherited by implicit conversion Ensuring from PType[P] to Ensuring[PType[P]]

Inherited by implicit conversion ArrowAssoc from PType[P] to ArrowAssoc[PType[P]]

Ungrouped