FromBuilder (Blazebit Persistence Core API 1.2.0-Alpha1 API)

Type Parameters:
X - The concrete builder type

All Known Subinterfaces:

BaseCriteriaBuilder<T,X>, BaseCTECriteriaBuilder<X>, BaseInsertCriteriaBuilder<T,X>, BaseQueryBuilder<T,X>, BaseSubqueryBuilder<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>>
```
An interface for builders that support the from clause.

Since:

1.1.0

Author:

Christian Beikov

Method Summary

Methods
Modifier and Type	Method and Description
`X`	`from(Class<?> entityClass)` Like `FromBuilder#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(String correlationPath)` Like `FromBuilder#from(String, String))` with the alias equivalent to the camel cased result of the class of the correlation parent.
`X`	`from(String correlationPath, String alias)` Sets the correlation path on which the query should be based on with the given alias.
`X`	`fromNew(Class<?> entityClass)` Like `FromBuilder#from(Class))` but explicitly queries the data after any side effects happen because of CTEs.
`X`	`fromNew(Class<?> entityClass, String alias)` Like `FromBuilder#from(Class, String))` but explicitly queries the data after any side effects happen because of CTEs.
`X`	`fromOld(Class<?> entityClass)` Like `FromBuilder#from(Class))` but explicitly queries the data before any side effects happen because of CTEs.
`X`	`fromOld(Class<?> entityClass, String alias)` Like `FromBuilder#from(Class, String))` but explicitly queries the data before any side effects happen because of CTEs.
`X`	`fromValues(Class<?> entityClass, String alias, int valueCount)` Add a VALUES clause for values of the given entity class to the from clause.
`<T> X`	`fromValues(Class<T> entityClass, String alias, Collection<T> values)` Like `fromValues(Class, String, int)` but passes the collection size as valueCount and directly binds the collection as parameter via `CommonQueryBuilder.setParameter(String, Object)`.
`Set<Root>`	`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`.
`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.
`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`.
`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`.

- Method Detail
  - getRoots
```
Set<Root> getRoots()
```
    Returns the query roots
    
    Returns:
    The roots of this query
    Since:
    
    1.2.0
  - from
```
X from(Class<?> entityClass)
```
    Like FromBuilder#from(Class, String)) with the alias equivalent to the camel cased result of what Class.getSimpleName() of the entity class returns.
    
    Parameters:
    entityClass - The entity class which should be queried
    
    Returns:
    The query builder for chaining calls
  - from
```
X from(Class<?> entityClass,
     String alias)
```
    Sets the entity class on which the query should be based on with the given alias.
    
    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(String correlationPath)
```
    Like FromBuilder#from(String, String)) with the alias equivalent to the camel cased result of the class of the correlation parent.
    
    Parameters:
    correlationPath - The correlation path which should be queried
    
    Returns:
    The query builder for chaining calls
    Since:
    
    1.2.0
  - from
```
X from(String correlationPath,
     String alias)
```
    Sets the correlation path on which the query should be based on with the given alias.
    
    Parameters:
    correlationPath - The correlation path which should be queried
    alias - The alias for the entity
    
    Returns:
    The query builder for chaining calls
    Since:
    
    1.2.0
  - fromOld
```
X fromOld(Class<?> entityClass)
```
    Like FromBuilder#from(Class)) but explicitly queries the data before any side effects happen because of CTEs.
    
    Parameters:
    entityClass - The entity class which should be queried
    
    Returns:
    The query builder for chaining calls
    Since:
    
    1.1.0
  - fromOld
```
X fromOld(Class<?> entityClass,
        String alias)
```
    Like FromBuilder#from(Class, String)) but explicitly queries the data before any side effects happen because of CTEs.
    
    Parameters:
    entityClass - The entity class which should be queried
    alias - The alias for the entity
    
    Returns:
    The query builder for chaining calls
    Since:
    
    1.1.0
  - fromNew
```
X fromNew(Class<?> entityClass)
```
    Like FromBuilder#from(Class)) but explicitly queries the data after any side effects happen because of CTEs.
    
    Parameters:
    entityClass - The entity class which should be queried
    
    Returns:
    The query builder for chaining calls
    Since:
    
    1.1.0
  - fromNew
```
X fromNew(Class<?> entityClass,
        String alias)
```
    Like FromBuilder#from(Class, String)) but explicitly queries the data after any side effects happen because of CTEs.
    
    Parameters:
    entityClass - The entity class which should be queried
    alias - The alias for the entity
    
    Returns:
    The query builder for chaining calls
    Since:
    
    1.1.0
  - fromValues
```
X fromValues(Class<?> entityClass,
           String alias,
           int valueCount)
```
    Add a VALUES clause for values of the given entity class to the from clause. This introduces a parameter named like the given alias To set the values invoke CommonQueryBuilder.setParameter(String, Object) with
    
    Parameters:
    entityClass - The entity class which should be queried
    alias - The alias for the entity
    valueCount - The number of values to use for the values clause
    
    Returns:
    The query builder for chaining calls
    Since:
    
    1.2.0
  - fromValues
```
<T> X fromValues(Class<T> entityClass,
               String alias,
               Collection<T> values)
```
    Like fromValues(Class, String, int) but passes the collection size as valueCount and directly binds the collection as parameter via CommonQueryBuilder.setParameter(String, Object).
    
    Parameters:
    entityClass - The entity class which should be queried
    alias - The alias for the entity
    values - The values to use for the values clause
    
    Returns:
    The query builder for chaining calls
    Since:
    
    1.2.0
  - 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
  - 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
  - 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
  - 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

Interface FromBuilder<X extends FromBuilder<X>>

Method Summary

Method Detail

getRoots

from

from

from

from

fromOld

fromOld

fromNew

fromNew

fromValues

fromValues

join

joinDefault

joinOn

joinDefaultOn

joinOn

joinOn

innerJoin

innerJoinDefault

innerJoinOn

innerJoinDefaultOn

innerJoinOn

innerJoinOn

leftJoin

leftJoinDefault

leftJoinOn

leftJoinDefaultOn

leftJoinOn

leftJoinOn

rightJoin

rightJoinDefault

rightJoinOn

rightJoinDefaultOn

rightJoinOn

rightJoinOn