entitytled.EntityCompanionComponent

EntityCompanion

abstract class EntityCompanion[T <: (EntityCompanionComponent.this)#EntityTable[E, I], E <: (EntityCompanionComponent.this)#Entity[E, I], I] extends (EntityCompanionComponent.this)#EntityRepository[T, E, I]

Base class for entity companion objects.

Extend this class with an object with the same name as the associated entity to define an entity companion object. Provides entity retrieval and persistance operations, as well as helpers for defining entity relationships.

T

The entity's table type.

E

The entity type.

I

The entity's ID type.

Linear Supertypes
(EntityCompanionComponent.this)#EntityRepository[T, E, I], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EntityCompanion
  2. EntityRepository
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EntityCompanion()(implicit ev: slick.driver.JdbcProfile.API.BaseColumnType[I], tqp: (EntityCompanionComponent.this)#TableQueryProvider[T, E])

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def afterDelete(id: I): slick.driver.JdbcProfile.API.DBIO[Unit]

    May be overriden to specify actions that should be taken after deleting an entity.

    May be overriden to specify actions that should be taken after deleting an entity.

    id

    The ID of entity instance that was deleted.

    Attributes
    protected
    Definition Classes
    EntityRepository
  7. def afterInsert(id: I, instance: E): slick.driver.JdbcProfile.API.DBIO[Unit]

    May be overriden to specify actions that should be taken after inserting a new entity.

    May be overriden to specify actions that should be taken after inserting a new entity.

    id

    The ID of entity instance that was inserted.

    instance

    The entity instance that was inserted.

    Attributes
    protected
    Definition Classes
    EntityRepository
  8. def afterSave(id: I, instance: E): slick.driver.JdbcProfile.API.DBIO[Unit]

    May be overriden to specify actions that should be taken either after inserting, or after updating an entity.

    May be overriden to specify actions that should be taken either after inserting, or after updating an entity.

    id

    The ID of entity instance that was saved.

    instance

    The entity instance that was saved.

    Attributes
    protected
    Definition Classes
    EntityRepository
  9. def afterUpdate(id: I, instance: E): slick.driver.JdbcProfile.API.DBIO[Unit]

    May be overriden to specify actions that should be taken after updating an entity.

    May be overriden to specify actions that should be taken after updating an entity.

    id

    The ID of entity instance that was updated.

    instance

    The entity instance that was updated.

    Attributes
    protected
    Definition Classes
    EntityRepository
  10. val all: slick.driver.JdbcProfile.API.Query[T, E, Seq]

    Definition Classes
    EntityRepository
  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def beforeDelete(id: I): slick.driver.JdbcProfile.API.DBIO[Unit]

    May be overriden to specify actions that should be taken before deleting an entity.

    May be overriden to specify actions that should be taken before deleting an entity.

    id

    The ID of entity instance that is to be deleted.

    Attributes
    protected
    Definition Classes
    EntityRepository
  13. def beforeInsert(instance: E): slick.driver.JdbcProfile.API.DBIO[E]

    May be overriden to specify actions that should be taken before inserting a new entity.

    May be overriden to specify actions that should be taken before inserting a new entity.

    instance

    The entity instance that is to be insterted.

    Attributes
    protected
    Definition Classes
    EntityRepository
  14. def beforeSave(instance: E): slick.driver.JdbcProfile.API.DBIO[E]

    May be overriden to specify actions that should be taken either before inserting, or before updating an entity.

    May be overriden to specify actions that should be taken either before inserting, or before updating an entity.

    instance

    The entity instance that is to be saved.

    Attributes
    protected
    Definition Classes
    EntityRepository
  15. def beforeUpdate(instance: E): slick.driver.JdbcProfile.API.DBIO[E]

    May be overriden to specify actions that should be taken before updating an entity.

    May be overriden to specify actions that should be taken before updating an entity.

    instance

    The entity instance that is to be updated.

    Attributes
    protected
    Definition Classes
    EntityRepository
  16. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. implicit val defaultIncludes: (EntityCompanionComponent.this)#Includes[E]

    The default set of included relationship values to be included on associated entity instances.

  18. def delete(id: I)(implicit ec: ExecutionContext): slick.driver.JdbcProfile.API.DBIO[Unit]

    Returns a database action for deleteing the entity with the given ID from the database.

    Returns a database action for deleteing the entity with the given ID from the database.

    id

    The ID of the entity to be deleted.

    ec

    The execution context in which the action is to be build.

    Definition Classes
    EntityRepository
  19. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  24. def insert(instance: E)(implicit ec: ExecutionContext): slick.driver.JdbcProfile.API.DBIO[I]

    Returns a database action for inserting the given entity instance into the database.

    Returns a database action for inserting the given entity instance into the database.

    instance

    The entity instance to be inserted.

    ec

    The execution context in which the action is to be build.

    Definition Classes
    EntityRepository
  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  29. def one(id: I): (EntityCompanionComponent.this)#EntityInstanceActionBuilder[T, E]

    Definition Classes
    EntityRepository
  30. val query: slick.driver.JdbcProfile.API.Query[T, E, Seq]

    Definition Classes
    EntityRepository
  31. val result: FixedSqlStreamingAction[Seq[E], E, Read]

    Definition Classes
    EntityRepository
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  33. def toMany[To <: slick.driver.JdbcProfile.API.Table[M], M](implicit tqp: (EntityCompanionComponent.this)#TableQueryProvider[To, M], jcp: (EntityCompanionComponent.this)#DirectJoinConditionProvider[T, To]): (EntityCompanionComponent.this)#ToMany[T, To, E, I, M]

    Creates a new direct (without a join-table) 'to many' relationship.

    Creates a new direct (without a join-table) 'to many' relationship.

    This overload attempts to infer both the toQuery and the joinCondition parameter at compile time. If it fails to do so for either parameter, you may explicitly provide the parameter to resolve this.

    To

    The relationship's target table type.

    M

    The target table's element type.

    Attributes
    protected
  34. def toMany[To <: slick.driver.JdbcProfile.API.Table[M], M](toQuery: slick.driver.JdbcProfile.API.Query[To, M, Seq])(implicit provider: (EntityCompanionComponent.this)#DirectJoinConditionProvider[T, To]): (EntityCompanionComponent.this)#ToMany[T, To, E, I, M]

    Creates a new direct (without a join-table) 'to many' relationship.

    Creates a new direct (without a join-table) 'to many' relationship.

    This overload attempts to infer the joinCondition parameter at compile time. If it fails to do so, you may explicitly provide a joinCondition to resolve this.

    To

    The relationship's target table type.

    M

    The target table's element type.

    toQuery

    The query defining the set of possibly related rows.

    Attributes
    protected
  35. def toMany[To <: slick.driver.JdbcProfile.API.Table[M], M](joinCondition: (T, To) ⇒ slick.driver.JdbcProfile.API.Rep[Boolean])(implicit provider: (EntityCompanionComponent.this)#TableQueryProvider[To, M]): (EntityCompanionComponent.this)#ToMany[T, To, E, I, M]

    Creates a new direct (without a join-table) 'to many' relationship.

    Creates a new direct (without a join-table) 'to many' relationship.

    This overload attempts to infer the toQuery parameter at compile time. If it fails to do so, you may explicitly provide a toQuery to resolve this.

    To

    The relationship's target table type.

    M

    The target table's element type.

    joinCondition

    The condition on which the entity query and the toQuery are to be joined.

    Attributes
    protected
  36. def toMany[To <: slick.driver.JdbcProfile.API.Table[M], M](toQuery: slick.driver.JdbcProfile.API.Query[To, M, Seq], joinCondition: (T, To) ⇒ slick.driver.JdbcProfile.API.Rep[Boolean]): (EntityCompanionComponent.this)#ToMany[T, To, E, I, M]

    Creates a new direct (without a join-table) 'to many' relationship.

    Creates a new direct (without a join-table) 'to many' relationship.

    To

    The relationship's target table type.

    M

    The target table's element type.

    toQuery

    The query defining the set of possibly related rows.

    joinCondition

    The condition on which the entity query and the toQuery are to be joined.

    Attributes
    protected
  37. def toManyThrough[To <: slick.driver.JdbcProfile.API.Table[M], Through <: slick.driver.JdbcProfile.API.Table[_], M](implicit tqp: (EntityCompanionComponent.this)#IndirectToQueryProvider[To, Through, M], jcp: (EntityCompanionComponent.this)#IndirectJoinConditionProvider[T, Through, To]): (EntityCompanionComponent.this)#ToManyThrough[T, Through, To, E, I, M]

    Creates a new indirect (with a join-table) 'to many' relationship.

    Creates a new indirect (with a join-table) 'to many' relationship.

    This overload attempts to infer both the toQuery and the joinCondition parameter at compile time. If it fails to do so for either parameter, you may explicitly provide the parameter to resolve this.

    To

    The relationship's target table type.

    Through

    The joining table's type.

    M

    The target table's element type.

    Attributes
    protected
  38. def toManyThrough[To <: slick.driver.JdbcProfile.API.Table[M], Through <: slick.driver.JdbcProfile.API.Table[_], M](toQuery: slick.driver.JdbcProfile.API.Query[(Through, To), _ <: Tuple2[_, M], Seq])(implicit provider: (EntityCompanionComponent.this)#IndirectJoinConditionProvider[T, Through, To]): (EntityCompanionComponent.this)#ToManyThrough[T, Through, To, E, I, M]

    Creates a new indirect (with a join-table) 'to many' relationship.

    Creates a new indirect (with a join-table) 'to many' relationship.

    This overload attempts to infer the joinCondition parameter at compile time. If it fails to do so, you may explicitly provide a joinCondition to resolve this.

    To

    The relationship's target table type.

    Through

    The joining table's type.

    M

    The target table's element type.

    toQuery

    The query defining the set of possibly related rows.

    Attributes
    protected
  39. def toManyThrough[To <: slick.driver.JdbcProfile.API.Table[M], Through <: slick.driver.JdbcProfile.API.Table[_], M](joinCondition: (T, (Through, To)) ⇒ slick.driver.JdbcProfile.API.Rep[Boolean])(implicit provider: (EntityCompanionComponent.this)#IndirectToQueryProvider[To, Through, M]): (EntityCompanionComponent.this)#ToManyThrough[T, Through, To, E, I, M]

    Creates a new indirect (with a join-table) 'to many' relationship.

    Creates a new indirect (with a join-table) 'to many' relationship.

    This overload attempts to infer the toQuery parameter at compile time. If it fails to do so, you may explicitly provide a toQuery to resolve this.

    To

    The relationship's target table type.

    Through

    The joining table's type.

    M

    The target table's element type.

    joinCondition

    The condition on which the entity query and the toQuery are to be joined.

    Attributes
    protected
  40. def toManyThrough[To <: slick.driver.JdbcProfile.API.Table[M], Through <: slick.driver.JdbcProfile.API.Table[_], M](toQuery: slick.driver.JdbcProfile.API.Query[(Through, To), _ <: Tuple2[_, M], Seq], joinCondition: (T, (Through, To)) ⇒ slick.driver.JdbcProfile.API.Rep[Boolean]): (EntityCompanionComponent.this)#ToManyThrough[T, Through, To, E, I, M]

    Creates a new indirect (with a join-table) 'to many' relationship.

    Creates a new indirect (with a join-table) 'to many' relationship.

    To

    The relationship's target table type.

    Through

    The joining table's type.

    M

    The target table's element type.

    toQuery

    The query defining the set of possibly related rows.

    joinCondition

    The condition on which the entity query and the toQuery are to be joined.

    Attributes
    protected
  41. def toOne[To <: slick.driver.JdbcProfile.API.Table[M], M](implicit tqp: (EntityCompanionComponent.this)#TableQueryProvider[To, M], jcp: (EntityCompanionComponent.this)#DirectJoinConditionProvider[T, To]): (EntityCompanionComponent.this)#ToOne[T, To, E, I, M]

    Creates a new direct (without a join-table) 'to one' relationship.

    Creates a new direct (without a join-table) 'to one' relationship.

    This overload attempts to infer both the toQuery and the joinCondition parameter at compile time. If it fails to do so for either parameter, you may explicitly provide the parameter to resolve this.

    To

    The relationship's target table type.

    M

    The target table's element type.

    Attributes
    protected
  42. def toOne[To <: slick.driver.JdbcProfile.API.Table[M], M](toQuery: slick.driver.JdbcProfile.API.Query[To, M, Seq])(implicit provider: (EntityCompanionComponent.this)#DirectJoinConditionProvider[T, To]): (EntityCompanionComponent.this)#ToOne[T, To, E, I, M]

    Creates a new direct (without a join-table) 'to one' relationship.

    Creates a new direct (without a join-table) 'to one' relationship.

    This overload attempts to infer the joinCondition parameter at compile time. If it fails to do so, you may explicitly provide a joinCondition to resolve this.

    To

    The relationship's target table type.

    M

    The target table's element type.

    toQuery

    The query defining the set of possibly related rows.

    Attributes
    protected
  43. def toOne[To <: slick.driver.JdbcProfile.API.Table[M], M](joinCondition: (T, To) ⇒ slick.driver.JdbcProfile.API.Rep[Boolean])(implicit provider: (EntityCompanionComponent.this)#TableQueryProvider[To, M]): (EntityCompanionComponent.this)#ToOne[T, To, E, I, M]

    Creates a new direct (without a join-table) 'to one' relationship.

    Creates a new direct (without a join-table) 'to one' relationship.

    This overload attempts to infer the toQuery parameter at compile time. If it fails to do so, you may explicitly provide a toQuery to resolve this.

    To

    The relationship's target table type.

    M

    The target table's element type.

    joinCondition

    The condition on which the entity query and the toQuery are to be joined.

    Attributes
    protected
  44. def toOne[To <: slick.driver.JdbcProfile.API.Table[M], M](toQuery: slick.driver.JdbcProfile.API.Query[To, M, Seq], joinCondition: (T, To) ⇒ slick.driver.JdbcProfile.API.Rep[Boolean]): (EntityCompanionComponent.this)#ToOne[T, To, E, I, M]

    Creates a new direct (without a join-table) 'to one' relationship.

    Creates a new direct (without a join-table) 'to one' relationship.

    To

    The relationship's target table type.

    M

    The target table's element type.

    toQuery

    The query defining the set of possibly related rows.

    joinCondition

    The condition on which the entity query and the toQuery are to be joined.

    Attributes
    protected
  45. def toOneThrough[To <: slick.driver.JdbcProfile.API.Table[M], Through <: slick.driver.JdbcProfile.API.Table[_], M](implicit tqp: (EntityCompanionComponent.this)#IndirectToQueryProvider[To, Through, M], jcp: (EntityCompanionComponent.this)#IndirectJoinConditionProvider[T, Through, To]): (EntityCompanionComponent.this)#ToOneThrough[T, Through, To, E, I, M]

    Creates a new indirect (with a join-table) 'to one' relationship.

    Creates a new indirect (with a join-table) 'to one' relationship.

    This overload attempts to infer both the toQuery and the joinCondition parameter at compile time. If it fails to do so for either parameter, you may explicitly provide the parameter to resolve this.

    To

    The relationship's target table type.

    Through

    The joining table's type.

    M

    The target table's element type.

    Attributes
    protected
  46. def toOneThrough[To <: slick.driver.JdbcProfile.API.Table[M], Through <: slick.driver.JdbcProfile.API.Table[_], M](toQuery: slick.driver.JdbcProfile.API.Query[(Through, To), _ <: Tuple2[_, M], Seq])(implicit provider: (EntityCompanionComponent.this)#IndirectJoinConditionProvider[T, Through, To]): (EntityCompanionComponent.this)#ToOneThrough[T, Through, To, E, I, M]

    Creates a new indirect (with a join-table) 'to one' relationship.

    Creates a new indirect (with a join-table) 'to one' relationship.

    This overload attempts to infer the joinCondition parameter at compile time. If it fails to do so, you may explicitly provide a joinCondition to resolve this.

    To

    The relationship's target table type.

    Through

    The joining table's type.

    M

    The target table's element type.

    toQuery

    The query defining the set of possibly related rows.

    Attributes
    protected
  47. def toOneThrough[To <: slick.driver.JdbcProfile.API.Table[M], Through <: slick.driver.JdbcProfile.API.Table[_], M](joinCondition: (T, (Through, To)) ⇒ slick.driver.JdbcProfile.API.Rep[Boolean])(implicit provider: (EntityCompanionComponent.this)#IndirectToQueryProvider[To, Through, M]): (EntityCompanionComponent.this)#ToOneThrough[T, Through, To, E, I, M]

    Creates a new indirect (with a join-table) 'to one' relationship.

    Creates a new indirect (with a join-table) 'to one' relationship.

    This overload attempts to infer the toQuery parameter at compile time. If it fails to do so, you may explicitly provide a toQuery to resolve this.

    To

    The relationship's target table type.

    Through

    The joining table's type.

    M

    The target table's element type.

    joinCondition

    The condition on which the entity query and the toQuery are to be joined.

    Attributes
    protected
  48. def toOneThrough[To <: slick.driver.JdbcProfile.API.Table[M], Through <: slick.driver.JdbcProfile.API.Table[_], M](toQuery: slick.driver.JdbcProfile.API.Query[(Through, To), _ <: Tuple2[_, M], Seq], joinCondition: (T, (Through, To)) ⇒ slick.driver.JdbcProfile.API.Rep[Boolean]): (EntityCompanionComponent.this)#ToOneThrough[T, Through, To, E, I, M]

    Creates a new indirect (with a join-table) 'to one' relationship.

    Creates a new indirect (with a join-table) 'to one' relationship.

    To

    The relationship's target table type.

    Through

    The joining table's type.

    M

    The target table's element type.

    toQuery

    The query defining the set of possibly related rows.

    joinCondition

    The condition on which the entity query and the toQuery are to be joined.

    Attributes
    protected
  49. def toString(): String

    Definition Classes
    AnyRef → Any
  50. def update(instance: E)(implicit ec: ExecutionContext): slick.driver.JdbcProfile.API.DBIO[Unit]

    Returns a database action for updating the database record for the given entity instance.

    Returns a database action for updating the database record for the given entity instance.

    instance

    The entity instance to be updated.

    ec

    The execution context in which the action is to be build.

    Definition Classes
    EntityRepository
  51. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from (EntityCompanionComponent.this)#EntityRepository[T, E, I]

Inherited from AnyRef

Inherited from Any

Ungrouped