entitytled.RelationshipComponent

ToOneWithIncludes

class ToOneWithIncludes[From <: (RelationshipComponent.this)#EntityTable[E, I], To <: slick.driver.JdbcProfile.API.Table[T], E <: (RelationshipComponent.this)#Entity[E, I], I, T] extends (RelationshipComponent.this)#WrappingRelationship[From, To, E, I, T, Option]

Wraps a 'to one' relationship and one or more includes which will be eager-loaded onto any actions generated for this relationship.

Linear Supertypes
(RelationshipComponent.this)#WrappingRelationship[From, To, E, I, T, Option], (RelationshipComponent.this)#Relationship[From, To, E, I, T, Option], (RelationshipComponent.this)#Includable[From, E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ToOneWithIncludes
  2. WrappingRelationship
  3. Relationship
  4. Includable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ToOneWithIncludes(relationship: (RelationshipComponent.this)#Relationship[From, To, E, I, T, Option], includes: Seq[(RelationshipComponent.this)#Includable[To, T]])

    Creates a new 'to one' relationship with includes which will be eager-loaded onto any actions generated for this relationship.

    Creates a new 'to one' relationship with includes which will be eager-loaded onto any actions generated for this relationship.

    relationship

    The 'to one' relationship into which the includes are to be eager-loaded.

    includes

    The includables that are to be eager-loaded onto the relationship.

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 actionFor(id: I)(implicit ec: ExecutionContext): slick.driver.JdbcProfile.API.DBIOAction[Option[T], slick.driver.JdbcProfile.API.NoStream, Read]

    Returns a database action for retrieving the owned relations belong to the owner entity with the given ID.

    Returns a database action for retrieving the owned relations belong to the owner entity with the given ID.

    id

    The ID of the owner entity to build the action for.

    ec

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

    Definition Classes
    ToOneWithIncludesWrappingRelationshipRelationship
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val emptyValue: Option[T]

    Value to be used when the owner entity does not own any target relations.

    Value to be used when the owner entity does not own any target relations.

    Definition Classes
    WrappingRelationshipRelationship
  10. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  12. def expandJoin[W <: slick.driver.JdbcProfile.API.Table[O], O](query: slick.driver.JdbcProfile.API.Query[(W, From), (O, E), Seq]): slick.driver.JdbcProfile.API.Query[(W, To), (O, T), Seq]

    Expands a join query from an origin relation to the owner relation, into a join query from that origin relation to the target relation.

    Expands a join query from an origin relation to the owner relation, into a join query from that origin relation to the target relation.

    W

    The origin relation's table type.

    O

    The origin relation's row type.

    query

    A join query from the origin relation to the owner relation.

    Definition Classes
    WrappingRelationshipRelationship
  13. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  16. def include(includables: (RelationshipComponent.this)#Includable[To, T]*): (RelationshipComponent.this)#ToOneWithIncludes[From, To, E, I, T]

    Modifies actions build for this relationship to include (eager-load) the given includables on the owned relations.

    Modifies actions build for this relationship to include (eager-load) the given includables on the owned relations.

    includables

    The includables to be included on database actions.

    Definition Classes
    ToOneWithIncludesWrappingRelationshipRelationship
  17. def includeOn[F[_]](action: slick.driver.JdbcProfile.API.DBIOAction[F[E], slick.driver.JdbcProfile.API.NoStream, Read], query: slick.driver.JdbcProfile.API.Query[From, E, Seq])(implicit arg0: Functor[F], ec: ExecutionContext): slick.driver.JdbcProfile.API.DBIOAction[F[E], slick.driver.JdbcProfile.API.NoStream, Read]

    Includes this relationship on a database action.

    Includes this relationship on a database action.

    F

    The type of the functor that contains the owner entity instance(s).

    action

    The entity action the relationship is to be included on.

    query

    The query that produced the database action the relationship is to be included on.

    ec

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

    returns

    The database action, modified to include this relationship on the resulting owner instance(s).

    Definition Classes
    RelationshipIncludable
  18. val includes: Seq[(RelationshipComponent.this)#Includable[To, T]]

    The includables that are to be eager-loaded onto the relationship.

  19. def inclusionActionFor(query: slick.driver.JdbcProfile.API.Query[From, E, Seq])(implicit ec: ExecutionContext): slick.driver.JdbcProfile.API.DBIOAction[Map[E, Option[T]], slick.driver.JdbcProfile.API.NoStream, Read]

    Returns a database action that will result in a map of owner entities to their owned values for this relationship.

    Returns a database action that will result in a map of owner entities to their owned values for this relationship.

    The resulting map only includes owner entities for which the relationship is not empty.

    query

    The query for the relevant owner entities.

    ec

    The execution context this action is to be build in.

    Definition Classes
    ToOneWithIncludesWrappingRelationshipRelationship
  20. val inclusionKey: (RelationshipComponent.this)#Relationship[From, To, E, I, T, Option]

    Definition Classes
    WrappingRelationshipRelationship
  21. def innerJoinFor(query: slick.driver.JdbcProfile.API.Query[From, E, Seq]): slick.driver.JdbcProfile.API.Query[(From, To), (E, T), Seq]

    Returns a query for the inner product of the given owner entity query with the respective owned relations.

    Returns a query for the inner product of the given owner entity query with the respective owned relations.

    query

    Query for owner entities on which the set of owned relations is to be joined.

    Definition Classes
    WrappingRelationshipRelationship
  22. final def isInstanceOf[T0]: Boolean

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

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

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

    Definition Classes
    AnyRef
  26. def queryFor(query: slick.driver.JdbcProfile.API.Query[From, E, Seq]): slick.driver.JdbcProfile.API.Query[To, T, Seq]

    Returns a query for all the owned relations belonging all the owner entities with retrieved by the given query.

    Returns a query for all the owned relations belonging all the owner entities with retrieved by the given query.

    query

    The query for owner entities for which to build a query for the owned relations.

    Definition Classes
    WrappingRelationshipRelationship
  27. def queryFor(id: I): slick.driver.JdbcProfile.API.Query[To, T, Seq]

    Returns a query for the owned relations belonging the owner entity with the given ID.

    Returns a query for the owned relations belonging the owner entity with the given ID.

    id

    The ID of the owner entity to build the query for.

    Definition Classes
    WrappingRelationshipRelationship
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  29. def toString(): String

    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from (RelationshipComponent.this)#WrappingRelationship[From, To, E, I, T, Option]

Inherited from (RelationshipComponent.this)#Relationship[From, To, E, I, T, Option]

Inherited from (RelationshipComponent.this)#Includable[From, E]

Inherited from AnyRef

Inherited from Any

Ungrouped