entitytled.RelationshipComponent

ToManyWithIncludes

Related Doc: package RelationshipComponent

class ToManyWithIncludes[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, Seq]

Wraps a 'to many' 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, Seq], (RelationshipComponent.this)#Relationship[From, To, E, I, T, Seq], (RelationshipComponent.this)#Includable[From, E], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ToManyWithIncludes
  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 ToManyWithIncludes(relationship: (RelationshipComponent.this)#Relationship[From, To, E, I, T, Seq], includes: Seq[(RelationshipComponent.this)#Includable[To, T]])

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

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

    relationship

    The 'to many' 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: 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. def actionFor(id: I)(implicit ec: ExecutionContext): slick.driver.JdbcProfile.API.DBIOAction[Seq[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
    ToManyWithIncludes → WrappingRelationship → Relationship

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  6. def clone(): AnyRef

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

  7. val emptyValue: Seq[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
    WrappingRelationship → Relationship

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

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. def include(includables: (RelationshipComponent.this)#Includable[To, T]*): (RelationshipComponent.this)#ToManyWithIncludes[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
    ToManyWithIncludes → WrappingRelationship → Relationship

  14. 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
    Relationship → Includable

  15. val includes: Seq[(RelationshipComponent.this)#Includable[To, T]]

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

  16. def inclusionActionFor(query: slick.driver.JdbcProfile.API.Query[From, E, Seq])(implicit ec: ExecutionContext): slick.driver.JdbcProfile.API.DBIOAction[Map[E, Seq[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
    ToManyWithIncludes → WrappingRelationship → Relationship

  17. val inclusionKey: (RelationshipComponent.this)#Relationship[From, To, E, I, T, Seq]

    Definition Classes
    WrappingRelationship → Relationship

  18. def inclusionQueryFor(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
    WrappingRelationship → Relationship

  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  23. 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
    WrappingRelationship → Relationship

  24. val relationship: (RelationshipComponent.this)#Relationship[From, To, E, I, T, Seq]

    The wrapped relationship.

    The wrapped relationship.

    Definition Classes
    WrappingRelationship

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

    Definition Classes
    AnyRef

  26. def toString(): String

    Definition Classes
    AnyRef → Any

  27. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped