org.nuiton.topia.persistence

Interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

All Known Subinterfaces:

TopiaQueryBuilderAddCriteriaOrRunQueryStep<E>

All Known Implementing Classes:

AbstractTopiaDao.InnerTopiaQueryBuilderAddCriteriaOrRunQueryStep, AbstractTopiaDao.InnerTopiaQueryBuilderRunQueryStep

public interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

This interface represents different common operations that a user may do after a query is defined (using the TopiaQueryBuilderAddCriteriaStep)

There are different methods according to the supposed existence or uniqueness of the result. Also some methods may be used only if order is defined in query.

Some methods return an Optional, but since it's not yet available in JDK, we use Guava's. If you don't want your project to require Guava dependency, we provide equivalent method named XXXOrNull() for the same purpose.

Since:

3.0

Method Summary

Methods

Modifier and Type	Method and Description
long	count() This method is equivalent as calling Collection.size() after doing a findAll() but it may be faster.
boolean	exists()
List<E>	find(int startIndex, int endIndex)
List<E>	find(TopiaPagerBean pager)
List<E>	findAll()
List<String>	findAllIds()
Iterable<E>	findAllLazy()
Iterable<E>	findAllLazy(int batchSize)
E	findAny()
E	findAnyOrNull()
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 was empty.
List<String>	findIds(int startIndex, int endIndex)
List<String>	findIds(TopiaPagerBean pager)
E	findUnique()
E	findUniqueOrNull()
com.google.common.base.Optional<E>	tryFindAny()
com.google.common.base.Optional<E>	tryFindFirst() Get the first element of the result set.
com.google.common.base.Optional<E>	tryFindUnique()

Method Detail

exists

boolean exists()

Returns:

true if the query returns at least one element

count

long count()

This method is equivalent as calling Collection.size() after doing a findAll() but it may be faster.

Returns:

the number of that the query would have returned, if executed

findUnique

E findUnique()
                                 throws TopiaNoResultException,
                                        TopiaNonUniqueResultException

Throws:

TopiaNoResultException

TopiaNonUniqueResultException

findUniqueOrNull

E findUniqueOrNull()
                                       throws TopiaNonUniqueResultException

Throws:

TopiaNonUniqueResultException

tryFindUnique

com.google.common.base.Optional<E> tryFindUnique()
                                                                     throws TopiaNonUniqueResultException

Throws:

TopiaNonUniqueResultException

findFirst

E findFirst()
                                throws QueryMissingOrderException,
                                       TopiaNoResultException

Get the first element of the non-empty result set.

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

findFirstOrNull

E findFirstOrNull()
                                      throws QueryMissingOrderException

Get the first element of the result set or null if query result was empty.

This method duplicates tryFindFirst() but allows you to prevent using Guava in you project.

Returns:

the first value from the set of result, according to given order, or null of result set for given query was empty

Throws:

QueryMissingOrderException - if you the query misses an order clause

tryFindFirst

com.google.common.base.Optional<E> tryFindFirst()
                                                                    throws QueryMissingOrderException

Get the first element of the result set.

This method duplicates tryFindFirst() but allows you to prevent using Guava in you project.

If the call must return a result, prefer findFirst()

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

E findAny()
                              throws TopiaNoResultException

Throws:

TopiaNoResultException

findAnyOrNull

E findAnyOrNull()

tryFindAny

com.google.common.base.Optional<E> tryFindAny()

findAll

List<E> findAll()

findAllLazy

Iterable<E> findAllLazy()

findAllLazy

Iterable<E> findAllLazy(int batchSize)

find

List<E> find(int startIndex,
           int endIndex)

find

List<E> find(TopiaPagerBean pager)

findAllIds

List<String> findAllIds()

findIds

List<String> findIds(int startIndex,
                   int endIndex)

findIds

List<String> findIds(TopiaPagerBean pager)