FromBuilder (Blazebit Persistence Core API 1.4.0-Alpha1 API)

Type Parameters:

X - The concrete builder type

All Superinterfaces:

FromBaseBuilder<X>, FromProvider

All Known Subinterfaces:

BaseCriteriaBuilder<T,X>, BaseCTECriteriaBuilder<X>, BaseInsertCriteriaBuilder<T,X>, BaseQueryBuilder<T,X>, BaseSubqueryBuilder<X>, CorrelationQueryBuilder<X>, CriteriaBuilder<T>, FullQueryBuilder<T,X>, FullSelectCTECriteriaBuilder<X>, InsertCriteriaBuilder<T>, LeafOngoingSetOperationCriteriaBuilder<X>, LeafOngoingSetOperationCTECriteriaBuilder<X>, LeafOngoingSetOperationSubqueryBuilder<X>, OngoingSetOperationCriteriaBuilder<T,Y>, OngoingSetOperationCTECriteriaBuilder<T,Y>, OngoingSetOperationSubqueryBuilder<T,Y>, PaginatedCriteriaBuilder<T>, QueryBuilder<T,X>, ReturningInsertCriteriaBuilder<T,X>, SelectBaseCTECriteriaBuilder<X>, SelectCTECriteriaBuilder<X>, SelectRecursiveCTECriteriaBuilder<X>, StartOngoingSetOperationCriteriaBuilder<X,Y>, StartOngoingSetOperationCTECriteriaBuilder<X,Y>, StartOngoingSetOperationSubqueryBuilder<X,Y>, SubqueryBuilder<T>
```
public interface FromBuilder<X extends FromBuilder<X>>
extends FromBaseBuilder<X>, FromProvider
```
An interface for builders that support the from clause.

Since:

1.1.0

Author:

Christian Beikov

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`X`	`from(Class<?> entityClass)`	Like `FromBaseBuilder.from(Class, String)` with the alias equivalent to the camel cased result of what `Class.getSimpleName()` of the entity class returns.
`X`	`from(Class<?> entityClass, String alias)`	Sets the entity class on which the query should be based on with the given alias.
`X`	`from(javax.persistence.metamodel.EntityType<?> entityType)`	Like `FromBaseBuilder.from(EntityType, String)` with the alias equivalent to the camel cased result of what `EntityType.getName()` of the entity class returns.
`X`	`from(javax.persistence.metamodel.EntityType<?> entityType, String alias)`	Sets the entity class on which the query should be based on with the given alias.
`X`	`fromIdentifiableValues(Class<?> valueClass, String alias, int valueCount)`	Add a VALUES clause for values of the given value class to the from clause.
`<T> X`	`fromIdentifiableValues(Class<T> valueClass, String alias, Collection<T> values)`	Like `FromBaseBuilder.fromIdentifiableValues(Class, String, int)` but passes the collection size as valueCount and directly binds the collection as parameter via `ParameterHolder.setParameter(String, Object)`.
`X`	`fromNew(Class<?> entityClass)`	Like `FromBaseBuilder.from(Class)` but explicitly queries the data after any side effects happen because of CTEs.
`X`	`fromNew(Class<?> entityClass, String alias)`	Like `FromBaseBuilder.from(Class, String)` but explicitly queries the data after any side effects happen because of CTEs.
`X`	`fromOld(Class<?> entityClass)`	Like `FromBaseBuilder.from(Class)` but explicitly queries the data before any side effects happen because of CTEs.
`X`	`fromOld(Class<?> entityClass, String alias)`	Like `FromBaseBuilder.from(Class, String)` but explicitly queries the data before any side effects happen because of CTEs.
`X`	`fromValues(Class<?> valueClass, String alias, int valueCount)`	Add a VALUES clause for values of the given value class to the from clause.
`X`	`fromValues(Class<?> entityBaseClass, String attributeName, String alias, int valueCount)`	Add a VALUES clause for values of the type as determined by the given entity attribute to the from clause.
`X`	`fromValues(Class<?> entityBaseClass, String attributeName, String alias, Collection<?> values)`	Like `FromBaseBuilder.fromValues(Class, String, String, int)` but passes the collection size as valueCount and directly binds the collection as parameter via `ParameterHolder.setParameter(String, Object)`.
`<T> X`	`fromValues(Class<T> valueClass, String alias, Collection<T> values)`	Like `FromBaseBuilder.fromValues(Class, String, int)` but passes the collection size as valueCount and directly binds the collection as parameter via `ParameterHolder.setParameter(String, Object)`.
`From`	`getFrom(String alias)`	Returns the from element for the given alias or null.
`From`	`getFromByPath(String path)`	Returns the from element for the given path, creating it if necessary.
`Path`	`getPath(String path)`	Returns the path object for the given path string, creating it if necessary.
`Set<From>`	`getRoots()`	Returns the query roots.
`X`	`innerJoin(String path, String alias)`	Like `join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.INNER`.
`X`	`innerJoinDefault(String path, String alias)`	Like `joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.INNER`.
`JoinOnBuilder<X>`	`innerJoinDefaultOn(String path, String alias)`	Like `joinDefaultOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.INNER`.
`JoinOnBuilder<X>`	`innerJoinOn(Class<?> entityClass, String alias)`	Like `joinOn(java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.INNER`.
`JoinOnBuilder<X>`	`innerJoinOn(String base, Class<?> entityClass, String alias)`	Like `joinOn(java.lang.String, java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.INNER`.
`JoinOnBuilder<X>`	`innerJoinOn(String path, String alias)`	Like `joinOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.INNER`.
`JoinOnBuilder<X>`	`innerJoinOn(String base, javax.persistence.metamodel.EntityType<?> entityType, String alias)`	Like `joinOn(java.lang.String, javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.INNER`.
`JoinOnBuilder<X>`	`innerJoinOn(javax.persistence.metamodel.EntityType<?> entityType, String alias)`	Like `joinOn(javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.INNER`.
`X`	`join(String path, String alias, JoinType type)`	Adds a join to the query, possibly specializing implicit joins, and giving the joined element an alias.
`X`	`joinDefault(String path, String alias, JoinType type)`	Adds a join to the query, possibly specializing implicit joins, and giving the joined element an alias.
`JoinOnBuilder<X>`	`joinDefaultOn(String path, String alias, JoinType type)`	Adds a join with an on-clause to the query, possibly specializing implicit joins, and giving the joined element an alias.
`JoinOnBuilder<X>`	`joinOn(Class<?> entityClass, String alias, JoinType type)`	Like `joinOn(java.lang.String, java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType)` but with the query root assumed as base.
`JoinOnBuilder<X>`	`joinOn(String base, Class<?> entityClass, String alias, JoinType type)`	Adds an entity join with an on-clause to the query and giving the joined element an alias.
`JoinOnBuilder<X>`	`joinOn(String path, String alias, JoinType type)`	Adds a join with an on-clause to the query, possibly specializing implicit joins, and giving the joined element an alias.
`JoinOnBuilder<X>`	`joinOn(String base, javax.persistence.metamodel.EntityType<?> entityType, String alias, JoinType type)`	Adds an entity join with an on-clause to the query and giving the joined element an alias.
`JoinOnBuilder<X>`	`joinOn(javax.persistence.metamodel.EntityType<?> entityType, String alias, JoinType type)`	Like `joinOn(java.lang.String, javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType)` but with the query root assumed as base.
`X`	`leftJoin(String path, String alias)`	Like `join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.LEFT`.
`X`	`leftJoinDefault(String path, String alias)`	Like `joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.LEFT`.
`JoinOnBuilder<X>`	`leftJoinDefaultOn(String path, String alias)`	Like `joinDefaultOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.LEFT`.
`JoinOnBuilder<X>`	`leftJoinOn(Class<?> entityClass, String alias)`	Like `joinOn(java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.LEFT`.
`JoinOnBuilder<X>`	`leftJoinOn(String base, Class<?> entityClass, String alias)`	Like `joinOn(java.lang.String, java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.LEFT`.
`JoinOnBuilder<X>`	`leftJoinOn(String path, String alias)`	Like `joinOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.LEFT`.
`JoinOnBuilder<X>`	`leftJoinOn(String base, javax.persistence.metamodel.EntityType<?> entityType, String alias)`	Like `joinOn(java.lang.String, javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.LEFT`.
`JoinOnBuilder<X>`	`leftJoinOn(javax.persistence.metamodel.EntityType<?> entityType, String alias)`	Like `joinOn(javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.LEFT`.
`X`	`rightJoin(String path, String alias)`	Like `join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.RIGHT`.
`X`	`rightJoinDefault(String path, String alias)`	Like `joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.RIGHT`.
`JoinOnBuilder<X>`	`rightJoinDefaultOn(String path, String alias)`	Like `joinDefaultOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.RIGHT`.
`JoinOnBuilder<X>`	`rightJoinOn(Class<?> entityClass, String alias)`	Like `joinOn(java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.RIGHT`.
`JoinOnBuilder<X>`	`rightJoinOn(String base, Class<?> entityClass, String alias)`	Like `joinOn(java.lang.String, java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.RIGHT`.
`JoinOnBuilder<X>`	`rightJoinOn(String path, String alias)`	Like `joinOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.RIGHT`.
`JoinOnBuilder<X>`	`rightJoinOn(String base, javax.persistence.metamodel.EntityType<?> entityType, String alias)`	Like `joinOn(java.lang.String, javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.RIGHT`.
`JoinOnBuilder<X>`	`rightJoinOn(javax.persistence.metamodel.EntityType<?> entityType, String alias)`	Like `joinOn(javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType)` but with `JoinType.RIGHT`.

- Method Detail
  - getRoots
```
Set<From> getRoots()
```
    Returns the query roots.
    
    Specified by:
    
    getRoots in interface FromProvider
    
    Returns:
    
    The roots of this query
    
    Since:
    
    1.2.0
  - getFrom
```
From getFrom(String alias)
```
    Returns the from element for the given alias or null.
    
    Specified by:
    
    getFrom in interface FromProvider
    
    Parameters:
    
    alias - The alias of the from element
    
    Returns:
    
    The from element of this query or null if not found
    
    Since:
    
    1.2.0
  - getFromByPath
```
From getFromByPath(String path)
```
    Returns the from element for the given path, creating it if necessary.
    
    Specified by:
    
    getFromByPath in interface FromProvider
    
    Parameters:
    
    path - The path to the from element
    
    Returns:
    
    The from element of this query
    
    Since:
    
    1.2.0
  - getPath
```
Path getPath(String path)
```
    Returns the path object for the given path string, creating it if necessary.
    
    Specified by:
    
    getPath in interface FromProvider
    
    Parameters:
    
    path - The path string
    
    Returns:
    
    The path object for this query
    
    Since:
    
    1.2.1
  - from
```
X from(Class<?> entityClass)
```
    Description copied from interface: FromBaseBuilder
    
    Like FromBaseBuilder.from(Class, String) with the alias equivalent to the camel cased result of what Class.getSimpleName() of the entity class returns.
    
    Specified by:
    
    from in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    entityClass - The entity class which should be queried
    
    Returns:
    
    The query builder for chaining calls
  - from
```
X from(Class<?> entityClass,
       String alias)
```
    Description copied from interface: FromBaseBuilder
    
    Sets the entity class on which the query should be based on with the given alias.
    
    Specified by:
    
    from in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    entityClass - The entity class which should be queried
    
    alias - The alias for the entity
    
    Returns:
    
    The query builder for chaining calls
  - from
```
X from(javax.persistence.metamodel.EntityType<?> entityType)
```
    Description copied from interface: FromBaseBuilder
    
    Like FromBaseBuilder.from(EntityType, String) with the alias equivalent to the camel cased result of what EntityType.getName() of the entity class returns.
    
    Specified by:
    
    from in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    entityType - The entity type which should be queried
    
    Returns:
    
    The query builder for chaining calls
  - from
```
X from(javax.persistence.metamodel.EntityType<?> entityType,
       String alias)
```
    Description copied from interface: FromBaseBuilder
    
    Sets the entity class on which the query should be based on with the given alias.
    
    Specified by:
    
    from in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    entityType - The entity type which should be queried
    
    alias - The alias for the entity
    
    Returns:
    
    The query builder for chaining calls
  - fromOld
```
X fromOld(Class<?> entityClass)
```
    Description copied from interface: FromBaseBuilder
    
    Like FromBaseBuilder.from(Class) but explicitly queries the data before any side effects happen because of CTEs.
    
    Specified by:
    
    fromOld in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    entityClass - The entity class which should be queried
    
    Returns:
    
    The query builder for chaining calls
  - fromOld
```
X fromOld(Class<?> entityClass,
          String alias)
```
    Description copied from interface: FromBaseBuilder
    
    Like FromBaseBuilder.from(Class, String) but explicitly queries the data before any side effects happen because of CTEs.
    
    Specified by:
    
    fromOld in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    entityClass - The entity class which should be queried
    
    alias - The alias for the entity
    
    Returns:
    
    The query builder for chaining calls
  - fromNew
```
X fromNew(Class<?> entityClass)
```
    Description copied from interface: FromBaseBuilder
    
    Like FromBaseBuilder.from(Class) but explicitly queries the data after any side effects happen because of CTEs.
    
    Specified by:
    
    fromNew in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    entityClass - The entity class which should be queried
    
    Returns:
    
    The query builder for chaining calls
  - fromNew
```
X fromNew(Class<?> entityClass,
          String alias)
```
    Description copied from interface: FromBaseBuilder
    
    Like FromBaseBuilder.from(Class, String) but explicitly queries the data after any side effects happen because of CTEs.
    
    Specified by:
    
    fromNew in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    entityClass - The entity class which should be queried
    
    alias - The alias for the entity
    
    Returns:
    
    The query builder for chaining calls
  - fromValues
```
X fromValues(Class<?> valueClass,
             String alias,
             int valueCount)
```
    Description copied from interface: FromBaseBuilder
    
    Add a VALUES clause for values of the given value class to the from clause. This introduces a parameter named like the given alias. To set the values invoke ParameterHolder.setParameter(String, Object) or Query.setParameter(String, Object) with the alias and a collection.
    
    Specified by:
    
    fromValues in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    valueClass - The class of the basic or managed type for which to create a VALUES clause
    
    alias - The alias for the entity
    
    valueCount - The number of values to use for the values clause
    
    Returns:
    
    The query builder for chaining calls
  - fromValues
```
X fromValues(Class<?> entityBaseClass,
             String attributeName,
             String alias,
             int valueCount)
```
    Description copied from interface: FromBaseBuilder
    
    Add a VALUES clause for values of the type as determined by the given entity attribute to the from clause. This introduces a parameter named like the given alias. To set the values invoke ParameterHolder.setParameter(String, Object) or Query.setParameter(String, Object) with the alias and a collection.
    
    Specified by:
    
    fromValues in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    entityBaseClass - The entity class on which the attribute is located
    
    attributeName - The attribute name within the entity class which to use for determining the values type
    
    alias - The alias for the entity
    
    valueCount - The number of values to use for the values clause
    
    Returns:
    
    The query builder for chaining calls
  - fromIdentifiableValues
```
X fromIdentifiableValues(Class<?> valueClass,
                         String alias,
                         int valueCount)
```
    Description copied from interface: FromBaseBuilder
    
    Add a VALUES clause for values of the given value class to the from clause. This introduces a parameter named like the given alias. In contrast to FromBaseBuilder.fromValues(Class, String, int) this will only bind the id attribute. To set the values invoke ParameterHolder.setParameter(String, Object) or Query.setParameter(String, Object) with the alias and a collection.
    
    Specified by:
    
    fromIdentifiableValues in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    valueClass - The class of the identifiable type for which to create a VALUES clause
    
    alias - The alias for the entity
    
    valueCount - The number of values to use for the values clause
    
    Returns:
    
    The query builder for chaining calls
  - fromValues
```
<T> X fromValues(Class<T> valueClass,
                 String alias,
                 Collection<T> values)
```
    Description copied from interface: FromBaseBuilder
    
    Like FromBaseBuilder.fromValues(Class, String, int) but passes the collection size as valueCount and directly binds the collection as parameter via ParameterHolder.setParameter(String, Object).
    
    Specified by:
    
    fromValues in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Type Parameters:
    
    T - The type of the values
    
    Parameters:
    
    valueClass - The class of the basic or managed type for which to create a VALUES clause
    
    alias - The alias for the entity
    
    values - The values to use for the values clause
    
    Returns:
    
    The query builder for chaining calls
  - fromValues
```
X fromValues(Class<?> entityBaseClass,
             String attributeName,
             String alias,
             Collection<?> values)
```
    Description copied from interface: FromBaseBuilder
    
    Like FromBaseBuilder.fromValues(Class, String, String, int) but passes the collection size as valueCount and directly binds the collection as parameter via ParameterHolder.setParameter(String, Object).
    
    Specified by:
    
    fromValues in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Parameters:
    
    entityBaseClass - The entity class on which the attribute is located
    
    attributeName - The attribute name within the entity class which to use for determining the values type
    
    alias - The alias for the entity
    
    values - The values to use for the values clause
    
    Returns:
    
    The query builder for chaining calls
  - fromIdentifiableValues
```
<T> X fromIdentifiableValues(Class<T> valueClass,
                             String alias,
                             Collection<T> values)
```
    Description copied from interface: FromBaseBuilder
    
    Like FromBaseBuilder.fromIdentifiableValues(Class, String, int) but passes the collection size as valueCount and directly binds the collection as parameter via ParameterHolder.setParameter(String, Object).
    
    Specified by:
    
    fromIdentifiableValues in interface FromBaseBuilder<X extends FromBuilder<X>>
    
    Type Parameters:
    
    T - The type of the values
    
    Parameters:
    
    valueClass - The class of the identifiable type for which to create a VALUES clause
    
    alias - The alias for the entity
    
    values - The values to use for the values clause
    
    Returns:
    
    The query builder for chaining calls
  - join
```
X join(String path,
       String alias,
       JoinType type)
```
    Adds a join to the query, possibly specializing implicit joins, and giving the joined element an alias. The resulting join is different from a default join because it can only be referred to via it's alias.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    type - The join type
    
    Returns:
    
    The query builder for chaining calls
  - joinDefault
```
X joinDefault(String path,
              String alias,
              JoinType type)
```
    Adds a join to the query, possibly specializing implicit joins, and giving the joined element an alias. The resulting join will be the default join meaning that expressions which use the absolute path will refer to this join.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    type - The join type
    
    Returns:
    
    The query builder for chaining calls
  - joinOn
```
JoinOnBuilder<X> joinOn(String path,
                        String alias,
                        JoinType type)
```
    Adds a join with an on-clause to the query, possibly specializing implicit joins, and giving the joined element an alias.
    The resulting join is different from a default join because it can only be referred to via it's alias. The absolute path can only be used if the joined path is a map and the on-clause contains a EQ predicate with the KEY on the left hand side.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    type - The join type
    
    Returns:
    
    The restriction builder for the on-clause
  - joinDefaultOn
```
JoinOnBuilder<X> joinDefaultOn(String path,
                               String alias,
                               JoinType type)
```
    Adds a join with an on-clause to the query, possibly specializing implicit joins, and giving the joined element an alias. The resulting join will be the default join meaning that expressions which use the absolute path will refer to this join.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    type - The join type
    
    Returns:
    
    The restriction builder for the on-clause
  - joinOn
```
JoinOnBuilder<X> joinOn(Class<?> entityClass,
                        String alias,
                        JoinType type)
```
    Like joinOn(java.lang.String, java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType) but with the query root assumed as base.
    
    Parameters:
    
    entityClass - The entity class to join
    
    alias - The alias for the joined element
    
    type - The join type
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.2.0
  - joinOn
```
JoinOnBuilder<X> joinOn(String base,
                        Class<?> entityClass,
                        String alias,
                        JoinType type)
```
    Adds an entity join with an on-clause to the query and giving the joined element an alias.
    
    Parameters:
    
    base - The base node on which to join
    
    entityClass - The entity class to join
    
    alias - The alias for the joined element
    
    type - The join type
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.2.0
  - joinOn
```
JoinOnBuilder<X> joinOn(javax.persistence.metamodel.EntityType<?> entityType,
                        String alias,
                        JoinType type)
```
    Like joinOn(java.lang.String, javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType) but with the query root assumed as base.
    
    Parameters:
    
    entityType - The entity type to join
    
    alias - The alias for the joined element
    
    type - The join type
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.3.0
  - joinOn
```
JoinOnBuilder<X> joinOn(String base,
                        javax.persistence.metamodel.EntityType<?> entityType,
                        String alias,
                        JoinType type)
```
    Adds an entity join with an on-clause to the query and giving the joined element an alias.
    
    Parameters:
    
    base - The base node on which to join
    
    entityType - The entity type to join
    
    alias - The alias for the joined element
    
    type - The join type
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.3.0
  - innerJoin
```
X innerJoin(String path,
            String alias)
```
    Like join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.INNER.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The query builder for chaining calls
  - innerJoinDefault
```
X innerJoinDefault(String path,
                   String alias)
```
    Like joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.INNER.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The query builder for chaining calls
  - innerJoinOn
```
JoinOnBuilder<X> innerJoinOn(String path,
                             String alias)
```
    Like joinOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.INNER.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
  - innerJoinDefaultOn
```
JoinOnBuilder<X> innerJoinDefaultOn(String path,
                                    String alias)
```
    Like joinDefaultOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.INNER.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
  - innerJoinOn
```
JoinOnBuilder<X> innerJoinOn(Class<?> entityClass,
                             String alias)
```
    Like joinOn(java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.INNER.
    
    Parameters:
    
    entityClass - The entity class to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.2.0
  - innerJoinOn
```
JoinOnBuilder<X> innerJoinOn(String base,
                             Class<?> entityClass,
                             String alias)
```
    Like joinOn(java.lang.String, java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.INNER.
    
    Parameters:
    
    base - The base node on which to join
    
    entityClass - The entity class to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.2.0
  - innerJoinOn
```
JoinOnBuilder<X> innerJoinOn(javax.persistence.metamodel.EntityType<?> entityType,
                             String alias)
```
    Like joinOn(javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.INNER.
    
    Parameters:
    
    entityType - The entity type to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.3.0
  - innerJoinOn
```
JoinOnBuilder<X> innerJoinOn(String base,
                             javax.persistence.metamodel.EntityType<?> entityType,
                             String alias)
```
    Like joinOn(java.lang.String, javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.INNER.
    
    Parameters:
    
    base - The base node on which to join
    
    entityType - The entity type to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.3.0
  - leftJoin
```
X leftJoin(String path,
           String alias)
```
    Like join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.LEFT.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The query builder for chaining calls
  - leftJoinDefault
```
X leftJoinDefault(String path,
                  String alias)
```
    Like joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.LEFT.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The query builder for chaining calls
  - leftJoinOn
```
JoinOnBuilder<X> leftJoinOn(String path,
                            String alias)
```
    Like joinOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.LEFT.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
  - leftJoinDefaultOn
```
JoinOnBuilder<X> leftJoinDefaultOn(String path,
                                   String alias)
```
    Like joinDefaultOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.LEFT.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
  - leftJoinOn
```
JoinOnBuilder<X> leftJoinOn(Class<?> entityClass,
                            String alias)
```
    Like joinOn(java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.LEFT.
    
    Parameters:
    
    entityClass - The entity class to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.2.0
  - leftJoinOn
```
JoinOnBuilder<X> leftJoinOn(String base,
                            Class<?> entityClass,
                            String alias)
```
    Like joinOn(java.lang.String, java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.LEFT.
    
    Parameters:
    
    base - The base node on which to join
    
    entityClass - The entity class to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.2.0
  - leftJoinOn
```
JoinOnBuilder<X> leftJoinOn(javax.persistence.metamodel.EntityType<?> entityType,
                            String alias)
```
    Like joinOn(javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.LEFT.
    
    Parameters:
    
    entityType - The entity type to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.3.0
  - leftJoinOn
```
JoinOnBuilder<X> leftJoinOn(String base,
                            javax.persistence.metamodel.EntityType<?> entityType,
                            String alias)
```
    Like joinOn(java.lang.String, javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.LEFT.
    
    Parameters:
    
    base - The base node on which to join
    
    entityType - The entity type to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.3.0
  - rightJoin
```
X rightJoin(String path,
            String alias)
```
    Like join(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.RIGHT.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The query builder for chaining calls
  - rightJoinDefault
```
X rightJoinDefault(String path,
                   String alias)
```
    Like joinDefault(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.RIGHT.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The query builder for chaining calls
  - rightJoinOn
```
JoinOnBuilder<X> rightJoinOn(String path,
                             String alias)
```
    Like joinOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.RIGHT.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
  - rightJoinDefaultOn
```
JoinOnBuilder<X> rightJoinDefaultOn(String path,
                                    String alias)
```
    Like joinDefaultOn(java.lang.String, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.RIGHT.
    
    Parameters:
    
    path - The path to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
  - rightJoinOn
```
JoinOnBuilder<X> rightJoinOn(Class<?> entityClass,
                             String alias)
```
    Like joinOn(java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.RIGHT.
    
    Parameters:
    
    entityClass - The entity class to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.2.0
  - rightJoinOn
```
JoinOnBuilder<X> rightJoinOn(String base,
                             Class<?> entityClass,
                             String alias)
```
    Like joinOn(java.lang.String, java.lang.Class, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.RIGHT.
    
    Parameters:
    
    base - The base node on which to join
    
    entityClass - The entity class to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.2.0
  - rightJoinOn
```
JoinOnBuilder<X> rightJoinOn(javax.persistence.metamodel.EntityType<?> entityType,
                             String alias)
```
    Like joinOn(javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.RIGHT.
    
    Parameters:
    
    entityType - The entity type to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.3.0
  - rightJoinOn
```
JoinOnBuilder<X> rightJoinOn(String base,
                             javax.persistence.metamodel.EntityType<?> entityType,
                             String alias)
```
    Like joinOn(java.lang.String, javax.persistence.metamodel.EntityType, java.lang.String, com.blazebit.persistence.JoinType) but with JoinType.RIGHT.
    
    Parameters:
    
    base - The base node on which to join
    
    entityType - The entity type to join
    
    alias - The alias for the joined element
    
    Returns:
    
    The restriction builder for the on-clause
    
    Since:
    
    1.3.0

Interface FromBuilder<X extends FromBuilder<X>>

Method Summary

Method Detail

getRoots

getFrom

getFromByPath

getPath

from

from

from

from

fromOld

fromOld

fromNew

fromNew

fromValues

fromValues

fromIdentifiableValues

fromValues

fromValues

fromIdentifiableValues

join

joinDefault

joinOn

joinDefaultOn

joinOn

joinOn

joinOn

joinOn

innerJoin

innerJoinDefault

innerJoinOn

innerJoinDefaultOn

innerJoinOn

innerJoinOn

innerJoinOn

innerJoinOn

leftJoin

leftJoinDefault

leftJoinOn

leftJoinDefaultOn

leftJoinOn

leftJoinOn

leftJoinOn

leftJoinOn

rightJoin

rightJoinDefault

rightJoinOn

rightJoinDefaultOn

rightJoinOn

rightJoinOn

rightJoinOn

rightJoinOn