Package com.blazebit.persistence.criteria

Interface BlazeFrom<Z,​X>

Type Parameters:
Z - The source type
X - The target type
All Superinterfaces:
BlazeExpression<X>, BlazeFetchParent<Z,​X>, BlazePath<X>, Expression<X>, FetchParent<Z,​X>, From<Z,​X>, Path<X>, Selection<X>, TupleElement<X>
All Known Subinterfaces:
BlazeCollectionJoin<Z,​E>, BlazeJoin<Z,​X>, BlazeListJoin<Z,​E>, BlazeMapJoin<Z,​K,​V>, BlazeRoot<X>, BlazeSetJoin<Z,​E>
public interface BlazeFrom<Z,​X>
extends From<Z,​X>, BlazeFetchParent<Z,​X>, BlazePath<X>
An extended version of From.
Since:
1.2.0
Author:
Christian Beikov

  • Method Details

    • getBlazeJoins

      Set<BlazeJoin<X,​?>> getBlazeJoins()
      Returns all joins including fetches since fetches are just joins with the fetch flag set to true.
      Returns:
      All joins

    • join

      <Y> BlazeJoin<X,​Y> join​(javax.persistence.metamodel.SingularAttribute<? super X,​Y> attribute, String alias)
      Like From.join(SingularAttribute) but allows to set the alias of the BlazeJoin.
      Type Parameters:
      Y - The join target type
      Parameters:
      attribute - The target of the join
      alias - The alias for the BlazeJoin
      Returns:
      The resulting join

    • join

      <Y> BlazeJoin<X,​Y> join​(javax.persistence.metamodel.SingularAttribute<? super X,​Y> attribute, String alias, JoinType joinType)
      Like From.join(SingularAttribute, JoinType) but allows to set the alias of the BlazeJoin.
      Type Parameters:
      Y - The join target type
      Parameters:
      attribute - The target of the join
      alias - The alias for the BlazeJoin
      joinType - The join type
      Returns:
      The resulting join

    • join

      <Y> BlazeCollectionJoin<X,​Y> join​(javax.persistence.metamodel.CollectionAttribute<? super X,​Y> collection, String alias)
      Like From.join(CollectionAttribute) but allows to set the alias of the BlazeCollectionJoin.
      Type Parameters:
      Y - The join target type
      Parameters:
      collection - The target of the join
      alias - The alias for the BlazeCollectionJoin
      Returns:
      The resulting join

    • join

      <Y> BlazeSetJoin<X,​Y> join​(javax.persistence.metamodel.SetAttribute<? super X,​Y> set, String alias)
      Like From.join(SetAttribute) but allows to set the alias of the BlazeSetJoin.
      Type Parameters:
      Y - The join target type
      Parameters:
      set - The target of the join
      alias - The alias for the BlazeSetJoin
      Returns:
      The resulting join

    • join

      <Y> BlazeListJoin<X,​Y> join​(javax.persistence.metamodel.ListAttribute<? super X,​Y> list, String alias)
      Like From.join(ListAttribute) but allows to set the alias of the BlazeListJoin.
      Type Parameters:
      Y - The join target type
      Parameters:
      list - The target of the join
      alias - The alias for the BlazeListJoin
      Returns:
      The resulting join

    • join

      <K,​ V> BlazeMapJoin<X,​K,​V> join​(javax.persistence.metamodel.MapAttribute<? super X,​K,​V> map, String alias)
      Like From.join(MapAttribute) but allows to set the alias of the BlazeMapJoin.
      Type Parameters:
      K - The join target key type
      V - The join target value type
      Parameters:
      map - The target of the join
      alias - The alias for the BlazeMapJoin
      Returns:
      The resulting join

    • join

      <Y> BlazeCollectionJoin<X,​Y> join​(javax.persistence.metamodel.CollectionAttribute<? super X,​Y> collection, String alias, JoinType joinType)
      Like From.join(CollectionAttribute, JoinType) but allows to set the alias of the BlazeCollectionJoin.
      Type Parameters:
      Y - The join target type
      Parameters:
      collection - The target of the join
      alias - The alias for the BlazeCollectionJoin
      joinType - The join type
      Returns:
      The resulting join

    • join

      <Y> BlazeSetJoin<X,​Y> join​(javax.persistence.metamodel.SetAttribute<? super X,​Y> set, String alias, JoinType joinType)
      Like From.join(SetAttribute, JoinType) but allows to set the alias of the BlazeSetJoin.
      Type Parameters:
      Y - The join target type
      Parameters:
      set - The target of the join
      alias - The alias for the BlazeSetJoin
      joinType - The join type
      Returns:
      The resulting join

    • join

      <Y> BlazeListJoin<X,​Y> join​(javax.persistence.metamodel.ListAttribute<? super X,​Y> list, String alias, JoinType joinType)
      Like From.join(ListAttribute, JoinType) but allows to set the alias of the BlazeListJoin.
      Type Parameters:
      Y - The join target type
      Parameters:
      list - The target of the join
      alias - The alias for the BlazeListJoin
      joinType - The join type
      Returns:
      The resulting join

    • join

      <K,​ V> BlazeMapJoin<X,​K,​V> join​(javax.persistence.metamodel.MapAttribute<? super X,​K,​V> map, String alias, JoinType joinType)
      Like From.join(MapAttribute, JoinType) but allows to set the alias of the BlazeMapJoin.
      Type Parameters:
      K - The join target key type
      V - The join target value type
      Parameters:
      map - The target of the join
      alias - The alias for the BlazeMapJoin
      joinType - The join type
      Returns:
      The resulting join

    • join

      <X,​ Y> BlazeJoin<X,​Y> join​(String attributeName, String alias)
      Like From.join(String) but allows to set the alias of the BlazeJoin.
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      alias - The alias for the BlazeJoin
      Returns:
      The resulting join

    • join

      <Y> BlazeJoin<X,​Y> join​(javax.persistence.metamodel.EntityType<Y> entityType, String alias)
      Like join(EntityType) but allows to set the alias of the BlazeJoin.
      Type Parameters:
      Y - The joined entity type
      Parameters:
      entityType - The entity type to join
      alias - The alias for the BlazeJoin
      Returns:
      The resulting join
      Since:
      1.3.0

    • join

      <Y> BlazeJoin<X,​Y> join​(Class<Y> entityTypeClass, String alias)
      Gets the entity type by the given entity type class and delegates to join(EntityType, String).
      Type Parameters:
      Y - The joined entity type
      Parameters:
      entityTypeClass - The entity type class to join
      alias - The alias for the BlazeJoin
      Returns:
      The resulting join
      Since:
      1.3.0

    • joinCollection

      <X,​ Y> BlazeCollectionJoin<X,​Y> joinCollection​(String attributeName, String alias)
      Like From.joinCollection(String) but allows to set the alias of the BlazeCollectionJoin.
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      alias - The alias for the BlazeCollectionJoin
      Returns:
      The resulting join

    • joinSet

      <X,​ Y> BlazeSetJoin<X,​Y> joinSet​(String attributeName, String alias)
      Like From.joinSet(String) but allows to set the alias of the BlazeSetJoin.
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      alias - The alias for the BlazeSetJoin
      Returns:
      The resulting join

    • joinList

      <X,​ Y> BlazeListJoin<X,​Y> joinList​(String attributeName, String alias)
      Like From.joinList(String) but allows to set the alias of the BlazeListJoin.
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      alias - The alias for the BlazeListJoin
      Returns:
      The resulting join

    • joinMap

      <X,​ K,​ V> BlazeMapJoin<X,​K,​V> joinMap​(String attributeName, String alias)
      Like From.joinMap(String) but allows to set the alias of the BlazeMapJoin.
      Type Parameters:
      X - The join source type
      K - The join target key type
      V - The join target value type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      alias - The alias for the BlazeMapJoin
      Returns:
      The resulting join

    • join

      <X,​ Y> BlazeJoin<X,​Y> join​(String attributeName, String alias, JoinType joinType)
      Like From.join(String, JoinType) but allows to set the alias of the BlazeJoin.
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      alias - The alias for the BlazeJoin
      joinType - The join type
      Returns:
      The resulting join

    • join

      <Y> BlazeJoin<X,​Y> join​(javax.persistence.metamodel.EntityType<Y> entityType, String alias, JoinType joinType)
      Like join(EntityType, JoinType) but allows to set the alias of the BlazeJoin.
      Type Parameters:
      Y - The joined entity type
      Parameters:
      entityType - The entity type to join
      alias - The alias for the BlazeJoin
      joinType - The join type
      Returns:
      The resulting join
      Since:
      1.3.0

    • join

      <Y> BlazeJoin<X,​Y> join​(Class<Y> entityTypeClass, String alias, JoinType joinType)
      Gets the entity type by the given entity type class and delegates to join(EntityType, String, JoinType).
      Type Parameters:
      Y - The joined entity type
      Parameters:
      entityTypeClass - The entity type class to join
      alias - The alias for the BlazeJoin
      joinType - The join type
      Returns:
      The resulting join
      Since:
      1.3.0

    • joinCollection

      <X,​ Y> BlazeCollectionJoin<X,​Y> joinCollection​(String attributeName, String alias, JoinType joinType)
      Like From.joinCollection(String, JoinType) but allows to set the alias of the BlazeCollectionJoin.
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      alias - The alias for the BlazeCollectionJoin
      joinType - The join type
      Returns:
      The resulting join

    • joinSet

      <X,​ Y> BlazeSetJoin<X,​Y> joinSet​(String attributeName, String alias, JoinType joinType)
      Like From.joinSet(String, JoinType) but allows to set the alias of the BlazeSetJoin.
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      alias - The alias for the BlazeSetJoin
      joinType - The join type
      Returns:
      The resulting join

    • joinList

      <X,​ Y> BlazeListJoin<X,​Y> joinList​(String attributeName, String alias, JoinType joinType)
      Like From.joinList(String, JoinType) but allows to set the alias of the BlazeListJoin.
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      alias - The alias for the BlazeListJoin
      joinType - The join type
      Returns:
      The resulting join

    • joinMap

      <X,​ K,​ V> BlazeMapJoin<X,​K,​V> joinMap​(String attributeName, String alias, JoinType joinType)
      Like From.joinMap(String, JoinType) but allows to set the alias of the BlazeMapJoin.
      Type Parameters:
      X - The join source type
      K - The join target key type
      V - The join target value type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      alias - The alias for the BlazeMapJoin
      joinType - The join type
      Returns:
      The resulting join

    • getCorrelationParent

      BlazeFrom<Z,​X> getCorrelationParent()
      Like From.getCorrelationParent() but returns the subtype BlazeFrom instead.
      Specified by:
      getCorrelationParent in interface From<Z,​X>
      Returns:
      The parent of the correlated From object

    • join

      <Y> BlazeJoin<X,​Y> join​(javax.persistence.metamodel.SingularAttribute<? super X,​Y> attribute)
      Like From.join(SingularAttribute) but returns the subtype BlazeJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      Y - The join target type
      Parameters:
      attribute - The target of the join
      Returns:
      The resulting join

    • join

      <Y> BlazeJoin<X,​Y> join​(javax.persistence.metamodel.SingularAttribute<? super X,​Y> attribute, JoinType joinType)
      Like From.join(SingularAttribute, JoinType) but returns the subtype BlazeJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      Y - The join target type
      Parameters:
      attribute - The target of the join
      joinType - The join type
      Returns:
      The resulting join

    • join

      <Y> BlazeCollectionJoin<X,​Y> join​(javax.persistence.metamodel.CollectionAttribute<? super X,​Y> collection)
      Like From.join(CollectionAttribute) but returns the subtype BlazeCollectionJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      Y - The join target type
      Parameters:
      collection - The target of the join
      Returns:
      The resulting join

    • join

      <Y> BlazeSetJoin<X,​Y> join​(javax.persistence.metamodel.SetAttribute<? super X,​Y> set)
      Like From.join(SetAttribute) but returns the subtype BlazeSetJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      Y - The join target type
      Parameters:
      set - The target of the join
      Returns:
      The resulting join

    • join

      <Y> BlazeListJoin<X,​Y> join​(javax.persistence.metamodel.ListAttribute<? super X,​Y> list)
      Like From.join(ListAttribute) but returns the subtype BlazeListJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      Y - The join target type
      Parameters:
      list - The target of the join
      Returns:
      The resulting join

    • join

      <K,​ V> BlazeMapJoin<X,​K,​V> join​(javax.persistence.metamodel.MapAttribute<? super X,​K,​V> map)
      Like From.join(MapAttribute) but returns the subtype BlazeMapJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      K - The join target key type
      V - The join target value type
      Parameters:
      map - The target of the join
      Returns:
      The resulting join

    • join

      <Y> BlazeCollectionJoin<X,​Y> join​(javax.persistence.metamodel.CollectionAttribute<? super X,​Y> collection, JoinType joinType)
      Like From.join(CollectionAttribute, JoinType) but returns the subtype BlazeCollectionJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      Y - The join target type
      Parameters:
      collection - The target of the join
      joinType - The join type
      Returns:
      The resulting join

    • join

      <Y> BlazeSetJoin<X,​Y> join​(javax.persistence.metamodel.SetAttribute<? super X,​Y> set, JoinType joinType)
      Like From.join(SetAttribute, JoinType) but returns the subtype BlazeSetJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      Y - The join target type
      Parameters:
      set - The target of the join
      joinType - The join type
      Returns:
      The resulting join

    • join

      <Y> BlazeListJoin<X,​Y> join​(javax.persistence.metamodel.ListAttribute<? super X,​Y> list, JoinType joinType)
      Like From.join(ListAttribute, JoinType) but returns the subtype BlazeListJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      Y - The join target type
      Parameters:
      list - The target of the join
      joinType - The join type
      Returns:
      The resulting join

    • join

      <K,​ V> BlazeMapJoin<X,​K,​V> join​(javax.persistence.metamodel.MapAttribute<? super X,​K,​V> map, JoinType joinType)
      Like From.join(MapAttribute, JoinType) but returns the subtype BlazeMapJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      K - The join target key type
      V - The join target value type
      Parameters:
      map - The target of the join
      joinType - The join type
      Returns:
      The resulting join

    • join

      <X,​ Y> BlazeJoin<X,​Y> join​(String attributeName)
      Like From.join(String) but returns the subtype BlazeJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      Returns:
      The resulting join

    • join

      <Y> BlazeJoin<X,​Y> join​(javax.persistence.metamodel.EntityType<Y> entityType)
      Creates an inner join to the specified entity type.
      Type Parameters:
      Y - The joined entity type
      Parameters:
      entityType - The entity type to join
      Returns:
      The resulting join
      Since:
      1.3.0

    • join

      <Y> BlazeJoin<X,​Y> join​(Class<Y> entityTypeClass)
      Gets the entity type by the given entity type class and delegates to join(EntityType).
      Type Parameters:
      Y - The joined entity type
      Parameters:
      entityTypeClass - The entity type class to join
      Returns:
      The resulting join
      Since:
      1.3.0

    • joinCollection

      <X,​ Y> BlazeCollectionJoin<X,​Y> joinCollection​(String attributeName)
      Like From.joinCollection(String) but returns the subtype BlazeCollectionJoin instead.
      Specified by:
      joinCollection in interface From<Z,​X>
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      Returns:
      The resulting join

    • joinSet

      <X,​ Y> BlazeSetJoin<X,​Y> joinSet​(String attributeName)
      Like From.joinSet(String) but returns the subtype BlazeSetJoin instead.
      Specified by:
      joinSet in interface From<Z,​X>
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      Returns:
      The resulting join

    • joinList

      <X,​ Y> BlazeListJoin<X,​Y> joinList​(String attributeName)
      Like From.joinList(String) but returns the subtype BlazeListJoin instead.
      Specified by:
      joinList in interface From<Z,​X>
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      Returns:
      The resulting join

    • joinMap

      <X,​ K,​ V> BlazeMapJoin<X,​K,​V> joinMap​(String attributeName)
      Like From.joinMap(String) but returns the subtype BlazeMapJoin instead.
      Specified by:
      joinMap in interface From<Z,​X>
      Type Parameters:
      X - The join source type
      K - The join target key type
      V - The join target value type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      Returns:
      The resulting join

    • join

      <X,​ Y> BlazeJoin<X,​Y> join​(String attributeName, JoinType joinType)
      Like From.join(String, JoinType) but returns the subtype BlazeJoin instead.
      Specified by:
      join in interface From<Z,​X>
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      joinType - The join type
      Returns:
      The resulting join

    • join

      <Y> BlazeJoin<X,​Y> join​(javax.persistence.metamodel.EntityType<Y> entityType, JoinType joinType)
      Creates a join of the specified join type to the specified entity type.
      Type Parameters:
      Y - The joined entity type
      Parameters:
      entityType - The entity type to join
      joinType - The join type
      Returns:
      The resulting join
      Since:
      1.3.0

    • join

      <Y> BlazeJoin<X,​Y> join​(Class<Y> entityTypeClass, JoinType joinType)
      Gets the entity type by the given entity type class and delegates to join(EntityType, JoinType).
      Type Parameters:
      Y - The joined entity type
      Parameters:
      entityTypeClass - The entity type class to join
      joinType - The join type
      Returns:
      The resulting join
      Since:
      1.3.0

    • joinCollection

      <X,​ Y> BlazeCollectionJoin<X,​Y> joinCollection​(String attributeName, JoinType joinType)
      Like From.joinCollection(String, JoinType) but returns the subtype BlazeCollectionJoin instead.
      Specified by:
      joinCollection in interface From<Z,​X>
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      joinType - The join type
      Returns:
      The resulting join

    • joinSet

      <X,​ Y> BlazeSetJoin<X,​Y> joinSet​(String attributeName, JoinType joinType)
      Like From.joinSet(String, JoinType) but returns the subtype BlazeSetJoin instead.
      Specified by:
      joinSet in interface From<Z,​X>
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      joinType - The join type
      Returns:
      The resulting join

    • joinList

      <X,​ Y> BlazeListJoin<X,​Y> joinList​(String attributeName, JoinType joinType)
      Like From.joinList(String, JoinType) but returns the subtype BlazeListJoin instead.
      Specified by:
      joinList in interface From<Z,​X>
      Type Parameters:
      X - The join source type
      Y - The join target type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      joinType - The join type
      Returns:
      The resulting join

    • joinMap

      <X,​ K,​ V> BlazeMapJoin<X,​K,​V> joinMap​(String attributeName, JoinType joinType)
      Like From.joinMap(String, JoinType) but returns the subtype BlazeMapJoin instead.
      Specified by:
      joinMap in interface From<Z,​X>
      Type Parameters:
      X - The join source type
      K - The join target key type
      V - The join target value type
      Parameters:
      attributeName - The name of the attribute for the target of the join
      joinType - The join type
      Returns:
      The resulting join