datomisca

Attribute

Related Docs: object Attribute | package datomisca

final case class Attribute[DD, Card <: Cardinality](ident: Keyword, valueType: SchemaType[DD], cardinality: Card, doc: Option[String] = None, unique: Option[Unique] = None, index: Option[Boolean] = None, fulltext: Option[Boolean] = None, isComponent: Option[Boolean] = None, noHistory: Option[Boolean] = None) extends TxData with KeywordIdentified with Product with Serializable

The representation of Datomic attributes

Source
Attribute.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, KeywordIdentified, TxData, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Attribute
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. KeywordIdentified
  7. TxData
  8. AnyRef
  9. Any
Implicitly
  1. by RichAttribute
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Attribute(ident: Keyword, valueType: SchemaType[DD], cardinality: Card, doc: Option[String] = None, unique: Option[Unique] = None, index: Option[Boolean] = None, fulltext: Option[Boolean] = None, isComponent: Option[Boolean] = None, noHistory: Option[Boolean] = None)

    construct an attribute out of an ident, valueType, cardinality, and other optional components

Value Members

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

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to any2stringadd[Attribute[DD, Card]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Attribute[DD, Card], B)

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to ArrowAssoc[Attribute[DD, Card]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. val attribute: Attribute[DD, Card]

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to RichAttribute[DD, Card] performed by method RichAttribute in datomisca. This conversion will take place only if DD is a subclass of AnyRef (DD <: AnyRef) and at the same time Card is a subclass of Cardinality (Card <: Cardinality).
    Definition Classes
    RichAttribute

  8. val cardinality: Card

  9. def clone(): AnyRef

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

  10. val doc: Option[String]

  11. def ensuring(cond: (Attribute[DD, Card]) ⇒ Boolean, msg: ⇒ Any): Attribute[DD, Card]

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to Ensuring[Attribute[DD, Card]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (Attribute[DD, Card]) ⇒ Boolean): Attribute[DD, Card]

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to Ensuring[Attribute[DD, Card]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean, msg: ⇒ Any): Attribute[DD, Card]

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to Ensuring[Attribute[DD, Card]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): Attribute[DD, Card]

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to Ensuring[Attribute[DD, Card]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  16. def finalize(): Unit

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

  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to StringFormat[Attribute[DD, Card]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. val fulltext: Option[Boolean]

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  20. val id: TempId

  21. val ident: Keyword

    Definition Classes
    Attribute → KeywordIdentified

  22. val index: Option[Boolean]

  23. val isComponent: Option[Boolean]

  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  26. val noHistory: Option[Boolean]

  27. final def notify(): Unit

    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  29. def read[A](implicit ev: Attribute2EntityReaderCast[DD, Card, A]): EntityReader[A]

    Returns an entity reader that reads entities with this attribute.

    Returns an entity reader that reads entities with this attribute.

    returns

    an entity reader that reads entities with this attribute.

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to RichAttribute[DD, Card] performed by method RichAttribute in datomisca. This conversion will take place only if DD is a subclass of AnyRef (DD <: AnyRef) and at the same time Card is a subclass of Cardinality (Card <: Cardinality).
    Definition Classes
    RichAttribute
    Note

    The return type must be explicitly specified, and the implicit ensures that it is a valid pairing with the Datomic data type specified by the attribute.

    See also

    EntityReader

  30. def readOpt[A](implicit ev: Attribute2EntityReaderCast[DD, Card, A]): EntityReader[Option[A]]

    Returns an entity reader that optionally reads entities with this attribute, or a default value if the attribute is not contained in the entity.

    Returns an entity reader that optionally reads entities with this attribute, or a default value if the attribute is not contained in the entity.

    returns

    an entity reader that optionally reads entities with this attribute.

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to RichAttribute[DD, Card] performed by method RichAttribute in datomisca. This conversion will take place only if DD is a subclass of AnyRef (DD <: AnyRef) and at the same time Card is a subclass of Cardinality (Card <: Cardinality).
    Definition Classes
    RichAttribute
    Note

    The return type must be explicitly specified, and the implicit ensures that it is a valid pairing with the Datomic data type specified by the attribute.

    See also

    EntityReader

  31. def readOrElse[A](default: ⇒ A)(implicit ev: Attribute2EntityReaderCast[DD, Card, A]): EntityReader[A]

    Returns an entity reader that reads entities with this attribute, or a default value if the attribute is not contained in the entity.

    Returns an entity reader that reads entities with this attribute, or a default value if the attribute is not contained in the entity.

    default

    a computation that yields a default value in case the attribute is not found in the entity.

    returns

    an entity reader that reads entities with this attribute.

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to RichAttribute[DD, Card] performed by method RichAttribute in datomisca. This conversion will take place only if DD is a subclass of AnyRef (DD <: AnyRef) and at the same time Card is a subclass of Cardinality (Card <: Cardinality).
    Definition Classes
    RichAttribute
    Note

    The return type must be explicitly specified, and the implicit ensures that it is a valid pairing with the Datomic data type specified by the attribute.

    See also

    EntityReader

  32. def reverse(implicit ev: =:=[DatomicRef.type, DD]): Attribute[DatomicRef.type, many.type]

    Construct the reverse attribute, if this is a reference attribute

  33. def reverseComponent(implicit ev: =:=[DatomicRef.type, DD]): Attribute[DatomicRef.type, one.type]

    Construct the reverse attribute, if this is a component reference attribute

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

    Definition Classes
    AnyRef

  35. lazy val toAddOps: AddEntity

  36. def toEDNString: String

    Construct the EDN representation of this attribute

  37. def toString(): String

    the keyword ident of the attribute as a string

    the keyword ident of the attribute as a string

    Definition Classes
    Attribute → AnyRef → Any

  38. def toTxData: AnyRef

    Definition Classes
    Attribute → TxData

  39. val unique: Option[Unique]

  40. val valueType: SchemaType[DD]

  41. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  42. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  43. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  44. def withDoc(str: String): Attribute[DD, Card]

    Extend this attribute with a documentation string.

  45. def withFullText(b: Boolean): Attribute[DD, Card]

    Extend this attribute with a full text indexing property

  46. def withIndex(b: Boolean): Attribute[DD, Card]

    Extend this attribute with an indexing property

  47. def withIsComponent(b: Boolean): Attribute[DD, Card]

    Extend this attribute with a component relationship constraint.

  48. def withNoHistory(b: Boolean): Attribute[DD, Card]

    Extend this attribute with a no history property

  49. def withUnique(u: Unique): Attribute[DD, Card]

    Extend this attribute with a uniqueness constraint.

  50. def write[A](implicit ev: Attribute2PartialAddEntityWriter[DD, Card, A]): PartialAddEntityWriter[A]

    Returns an entity writer that writes entities with this attribute.

    Returns an entity writer that writes entities with this attribute.

    returns

    an entity writer that writes entities with this attribute.

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to RichAttribute[DD, Card] performed by method RichAttribute in datomisca. This conversion will take place only if DD is a subclass of AnyRef (DD <: AnyRef) and at the same time Card is a subclass of Cardinality (Card <: Cardinality).
    Definition Classes
    RichAttribute
    Note

    The return type must be explicitly specified, and the implicit ensures that it is a valid pairing with the Datomic data type specified by the attribute.

    See also

    PartialAddEntityWriter

  51. def writeOpt[A](implicit ev: Attribute2PartialAddEntityWriter[DD, Card, A]): PartialAddEntityWriter[Option[A]]

    Returns an entity writer that optionally writes entities with this attribute.

    Returns an entity writer that optionally writes entities with this attribute.

    returns

    an entity writer that optionally writes entities with this attribute.

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to RichAttribute[DD, Card] performed by method RichAttribute in datomisca. This conversion will take place only if DD is a subclass of AnyRef (DD <: AnyRef) and at the same time Card is a subclass of Cardinality (Card <: Cardinality).
    Definition Classes
    RichAttribute
    Note

    The return type must be explicitly specified, and the implicit ensures that it is a valid pairing with the Datomic data type specified by the attribute.

    See also

    PartialAddEntityWriter

  52. def →[B](y: B): (Attribute[DD, Card], B)

    Implicit information
    This member is added by an implicit conversion from Attribute[DD, Card] to ArrowAssoc[Attribute[DD, Card]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from KeywordIdentified

Inherited from TxData

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion RichAttribute from Attribute[DD, Card] to RichAttribute[DD, Card]

Inherited by implicit conversion any2stringadd from Attribute[DD, Card] to any2stringadd[Attribute[DD, Card]]

Inherited by implicit conversion StringFormat from Attribute[DD, Card] to StringFormat[Attribute[DD, Card]]

Inherited by implicit conversion Ensuring from Attribute[DD, Card] to Ensuring[Attribute[DD, Card]]

Inherited by implicit conversion ArrowAssoc from Attribute[DD, Card] to ArrowAssoc[Attribute[DD, Card]]

Ungrouped