AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep (ToPIA

java.lang.Object
- org.nuiton.topia.persistence.internal.AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep<E>

All Implemented Interfaces:

TopiaQueryBuilderRunQueryStep<E>, TopiaQueryBuilderRunQueryWithUniqueResultStep<E>

Enclosing class:

AbstractTopiaDao<E extends TopiaEntity>
```
public static class AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
extends Object
implements TopiaQueryBuilderRunQueryStep<E>
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`fromHql`
`protected String`	`hql`
`protected String`	`hqlForFetchStep1`
`protected String`	`hqlForFetchStep2`
`protected Map<String,Object>`	`hqlParameters`
`protected AbstractTopiaDao<E>`	`topiaDao`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep(AbstractTopiaDao<E> topiaDao, boolean fromHql, String hql, Map<String,Object> hqlParameters)`
`protected`	`AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep(AbstractTopiaDao<E> topiaDao, boolean fromHql, String hql, Map<String,Object> hqlParameters, String hqlForFetchStep1, String hqlForFetchStep2)`

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`count()` This method is equivalent as calling `Collection.size()` after doing a `TopiaQueryBuilderRunQueryStep.findAll()` but it may be faster.
`boolean`	`exists()`
`List<E>`	`find(int startIndex, int endIndex)` Get the elements with the given bounds.
`List<E>`	`find(org.nuiton.util.pagination.PaginationParameter page)` Get the elements according to the given `PaginationParameter`.
`List<E>`	`findAll()` Get all the elements of the result set.
`List<String>`	`findAllIds()` Get all the elements identifiers of the result set.
`Iterable<E>`	`findAllLazy()` Get all the elements in a lazy loading list.
`Iterable<E>`	`findAllLazy(int batchSize)` Get all the elements in a lazy loading list.
`E`	`findAny()` Get the an element of the non-empty result set.
`E`	`findAnyOrNull()` Get the an element of the result set or null if query result is empty.
`E`	`findFirst()` Get the first element of the non-empty result set.
`E`	`findFirstOrNull()` Get the first element of the result set or null if query result is empty.
`List<String>`	`findIds(int startIndex, int endIndex)` Get the elements identifiers with the given bounds.
`List<String>`	`findIds(org.nuiton.util.pagination.PaginationParameter page)` Get the elements identifiers according to the given `PaginationParameter`.
`org.nuiton.util.pagination.PaginationResult<String>`	`findIdsPage(org.nuiton.util.pagination.PaginationParameter page)` Get the elements identifiers according to the given `PaginationParameter`.
`org.nuiton.util.pagination.PaginationResult<E>`	`findPage(org.nuiton.util.pagination.PaginationParameter page)` Get the elements according to the given `PaginationParameter`.
`E`	`findUnique()` Get the first element of a single-element result set.
`E`	`findUniqueOrNull()` Get the first element of a single-element result set or null if query result is empty.
`protected <O extends TopiaEntity> List<O>`	`sortAccordingToIds(List<O> entities, List<String> idsList)` This method can be used when it is not possible to sort entities in SQL/HQL.
`com.google.common.base.Optional<E>`	`tryFindAny()` Get the an element of the result set.
`com.google.common.base.Optional<E>`	`tryFindFirst()` Get the first element of the result set.
`com.google.common.base.Optional<E>`	`tryFindUnique()` Get the first element of a single-element result set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - hql
```
protected final String hql
```
  - hqlParameters
```
protected final Map<String,Object> hqlParameters
```
  - topiaDao
```
protected final AbstractTopiaDao<E extends TopiaEntity> topiaDao
```
  - fromHql
```
protected final boolean fromHql
```
  - hqlForFetchStep1
```
protected final String hqlForFetchStep1
```
  - hqlForFetchStep2
```
protected final String hqlForFetchStep2
```
- Constructor Detail
  - AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep
```
protected AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep(AbstractTopiaDao<E> topiaDao,
                                                   boolean fromHql,
                                                   String hql,
                                                   Map<String,Object> hqlParameters)
```
  - AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep
```
protected AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep(AbstractTopiaDao<E> topiaDao,
                                                   boolean fromHql,
                                                   String hql,
                                                   Map<String,Object> hqlParameters,
                                                   String hqlForFetchStep1,
                                                   String hqlForFetchStep2)
```
- Method Detail
  - exists
```
public boolean exists()
```
    Specified by:
    
    exists in interface TopiaQueryBuilderRunQueryWithUniqueResultStep<E extends TopiaEntity>
    
    Returns:
    true if the query returns at least one element
  - count
```
public long count()
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    This method is equivalent as calling Collection.size() after doing a TopiaQueryBuilderRunQueryStep.findAll() but it may be faster.
    
    Specified by:
    
    count in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Returns:
    the number of that the query would have returned, if executed
  - findUnique
```
public E findUnique()
                                 throws TopiaNoResultException,
                                        TopiaNonUniqueResultException
```
    Description copied from interface: TopiaQueryBuilderRunQueryWithUniqueResultStep
    
    Get the first element of a single-element result set.
    
    Specified by:
    
    findUnique in interface TopiaQueryBuilderRunQueryWithUniqueResultStep<E extends TopiaEntity>
    
    Returns:
    the first value from the set of result. Returned value can't be null
    
    Throws:
    
    TopiaNoResultException - if the query does not return any result.
    
    TopiaNonUniqueResultException - if the query returns more than one element.
  - findUniqueOrNull
```
public E findUniqueOrNull()
                                       throws TopiaNonUniqueResultException
```
    Description copied from interface: TopiaQueryBuilderRunQueryWithUniqueResultStep
    
    Get the first element of a single-element result set or null if query result is empty.
    This method duplicates TopiaQueryBuilderRunQueryWithUniqueResultStep.tryFindUnique() but allows you to prevent using Guava in you project.
    
    Specified by:
    
    findUniqueOrNull in interface TopiaQueryBuilderRunQueryWithUniqueResultStep<E extends TopiaEntity>
    
    Returns:
    the first value from the set of result, or null of result set for given query is empty.
    
    Throws:
    
    TopiaNonUniqueResultException - if the query returns more than one element.
  - tryFindUnique
```
public com.google.common.base.Optional<E> tryFindUnique()
                                                                     throws TopiaNonUniqueResultException
```
    Description copied from interface: TopiaQueryBuilderRunQueryWithUniqueResultStep
    
    Get the first element of a single-element result set.
    If the call must return a result, prefer TopiaQueryBuilderRunQueryWithUniqueResultStep.findUnique()
    
    Specified by:
    
    tryFindUnique in interface TopiaQueryBuilderRunQueryWithUniqueResultStep<E extends TopiaEntity>
    
    Returns:
    the first value from the set of result. It's an optional because the query may return no result.
    
    Throws:
    
    TopiaNonUniqueResultException - if the query returns more than one element.
  - findFirst
```
public E findFirst()
                                throws QueryMissingOrderException,
                                       TopiaNoResultException
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the first element of the non-empty result set.
    
    Specified by:
    
    findFirst in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Returns:
    the first value from the set of result, according to given order. Returned value can't be null
    
    Throws:
    
    QueryMissingOrderException - if you the query misses an order clause
    
    TopiaNoResultException - if the query does not return any result
  - findFirstOrNull
```
public E findFirstOrNull()
                                      throws QueryMissingOrderException
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the first element of the result set or null if query result is empty.
    This method duplicates TopiaQueryBuilderRunQueryStep.tryFindFirst() but allows you to prevent using Guava in you project.
    
    Specified by:
    
    findFirstOrNull in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Returns:
    the first value from the set of result, according to given order, or null of result set for given query is empty
    
    Throws:
    
    QueryMissingOrderException - if you the query misses an order clause
  - tryFindFirst
```
public com.google.common.base.Optional<E> tryFindFirst()
                                                                    throws QueryMissingOrderException
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the first element of the result set.
    If the call must return a result, prefer TopiaQueryBuilderRunQueryStep.findFirst()
    
    Specified by:
    
    tryFindFirst in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Returns:
    the first value from the set of result, according to given order. It's an optional because the query may return no result.
    
    Throws:
    
    QueryMissingOrderException - if you the query misses an order clause
  - findAny
```
public E findAny()
                              throws TopiaNoResultException
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the an element of the non-empty result set.
    This method does not guarantee any order as no ordering clause is mandatory
    
    Specified by:
    
    findAny in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Returns:
    the first value from the set of result, without any order guarantee. Returned value can't be null
    
    Throws:
    
    TopiaNoResultException - if the query does not return any result
  - findAnyOrNull
```
public E findAnyOrNull()
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the an element of the result set or null if query result is empty.
    This method does not guarantee any order as no ordering clause is mandatory.
    This method duplicates TopiaQueryBuilderRunQueryStep.tryFindAny() but allows you to prevent using Guava in you project.
    
    Specified by:
    
    findAnyOrNull in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Returns:
    the first value from the set of result, without any order guarantee. Returned value can be null
  - tryFindAny
```
public com.google.common.base.Optional<E> tryFindAny()
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the an element of the result set.
    This method does not guarantee any order as no ordering clause is mandatory.
    If the call must return a result, prefer TopiaQueryBuilderRunQueryStep.findAny()
    
    Specified by:
    
    tryFindAny in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Returns:
    the first value from the set of result, without any order guarantee. It's an optional because the query may return no result.
  - findAll
```
public List<E> findAll()
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get all the elements of the result set.
    
    Specified by:
    
    findAll in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Returns:
    the full list of results.
  - findAllLazy
```
public Iterable<E> findAllLazy()
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get all the elements in a lazy loading list. The entities will be loaded gradually when the returned Iterable is iterated.
    If you wish to specify a batch size, use TopiaQueryBuilderRunQueryStep.findAllLazy(int)
    
    Specified by:
    
    findAllLazy in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Returns:
    the full list of results which will be loaded gradually.
  - findAllLazy
```
public Iterable<E> findAllLazy(int batchSize)
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get all the elements in a lazy loading list. The entities will be loaded gradually when the returned Iterable is iterated.
    If you do not need to specify a batch size, use TopiaQueryBuilderRunQueryStep.findAllLazy()
    
    Specified by:
    
    findAllLazy in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Parameters:
    batchSize - the number of elements to load per request
    
    Returns:
    the full list of results which will be loaded gradually.
  - find
```
public List<E> find(int startIndex,
           int endIndex)
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the elements with the given bounds.
    
    Specified by:
    
    find in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Parameters:
    startIndex - inclusive index of the first element to return. This value is 0-based
    endIndex - inclusive index of the last element to return. A value lower than 0 means infinite upper bound.
    
    Returns:
    the list of loaded results.
  - find
```
public List<E> find(org.nuiton.util.pagination.PaginationParameter page)
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the elements according to the given PaginationParameter.
    Use TopiaQueryBuilderRunQueryStep.findPage(PaginationParameter) to get a PaginationResult instead of a list.
    
    Specified by:
    
    find in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Parameters:
    page - information about the page to load.
    
    Returns:
    the list of loaded results.
    See Also:
    PaginationParameter
  - findPage
```
public org.nuiton.util.pagination.PaginationResult<E> findPage(org.nuiton.util.pagination.PaginationParameter page)
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the elements according to the given PaginationParameter.
    Use TopiaQueryBuilderRunQueryStep.find(PaginationParameter) to get a list instead of PaginationResult.
    Note: compared to TopiaQueryBuilderRunQueryStep.find(PaginationParameter), this method performs an additional statement to get the total elements count.
    
    Specified by:
    
    findPage in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Parameters:
    page - information about the page to load.
    
    Returns:
    the list of loaded results.
    See Also:
    PaginationParameter, PaginationResult
  - sortAccordingToIds
```
protected <O extends TopiaEntity> List<O> sortAccordingToIds(List<O> entities,
                                                 List<String> idsList)
```
    This method can be used when it is not possible to sort entities in SQL/HQL. The list of entities will be sorted according to the given list of topiaId.
    
    Type Parameters:
    O - must be a TopiaEntity
    Parameters:
    entities - the list en entities (unsorted)
    idsList - the list of ids (sorted)
  - findAllIds
```
public List<String> findAllIds()
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get all the elements identifiers of the result set.
    Note: compared to TopiaQueryBuilderRunQueryStep.findAll(), this method will not load entities, only its identifier.
    
    Specified by:
    
    findAllIds in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Returns:
    the full list of results ids.
  - findIds
```
public List<String> findIds(int startIndex,
                   int endIndex)
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the elements identifiers with the given bounds.
    Note: compared to TopiaQueryBuilderRunQueryStep.find(int, int), this method will not load entities, only its identifier.
    
    Specified by:
    
    findIds in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Parameters:
    startIndex - inclusive index of the first element to return. This value is 0-based
    endIndex - inclusive index of the last element to return. A value lower than 0 means infinite upper bound.
    
    Returns:
    the list of loaded results ids.
  - findIds
```
public List<String> findIds(org.nuiton.util.pagination.PaginationParameter page)
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the elements identifiers according to the given PaginationParameter.
    Use TopiaQueryBuilderRunQueryStep.findIdsPage(PaginationParameter) to get a PaginationResult instead of a list.
    Note: compared to TopiaQueryBuilderRunQueryStep.find(PaginationParameter), this method will not load entities, only its identifier.
    
    Specified by:
    
    findIds in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Parameters:
    page - information about the page to load.
    
    Returns:
    the list of loaded results ids.
    See Also:
    PaginationParameter
  - findIdsPage
```
public org.nuiton.util.pagination.PaginationResult<String> findIdsPage(org.nuiton.util.pagination.PaginationParameter page)
```
    Description copied from interface: TopiaQueryBuilderRunQueryStep
    
    Get the elements identifiers according to the given PaginationParameter.
    Use TopiaQueryBuilderRunQueryStep.findIds(PaginationParameter) to get a list instead of PaginationResult.
    Note: compared to TopiaQueryBuilderRunQueryStep.findIds(PaginationParameter), this method performs an additional statement to get the total elements identifiers count.
    Note: compared to TopiaQueryBuilderRunQueryStep.findPage(PaginationParameter), this method will not load entities, only its identifier
    
    Specified by:
    
    findIdsPage in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>
    
    Parameters:
    page - information about the page to load.
    
    Returns:
    the list of loaded results.
    See Also:
    PaginationParameter, PaginationResult

Class AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

hql

hqlParameters

topiaDao

fromHql

hqlForFetchStep1

hqlForFetchStep2

Constructor Detail

AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep

AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep

Method Detail

exists

count

findUnique

findUniqueOrNull

tryFindUnique

findFirst

findFirstOrNull

tryFindFirst

findAny

findAnyOrNull

tryFindAny

findAll

findAllLazy

findAllLazy

find

find

findPage

sortAccordingToIds

findAllIds

findIds

findIds

findIdsPage