org.nuiton.topia.persistence

Class AbstractTopiaDao.TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

java.lang.Object

org.nuiton.topia.persistence.AbstractTopiaDao.TopiaQueryBuilderRunQueryStep<E>

All Implemented Interfaces:

TopiaQueryBuilderRunQueryStep<E>

Enclosing class:

AbstractTopiaDao<E extends TopiaEntity>

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	hql
protected Map<String,Object>	hqlParameters
protected AbstractTopiaDao<E>	topiaDAO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTopiaDao.TopiaQueryBuilderRunQueryStep(AbstractTopiaDao<E> topiaDAO, String hql, Map<String,Object> hqlParameters)

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)
List<E>	findAll()
List<String>	findAllIds()
Iterable<E>	findAllLazy()
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)
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()

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 AbstractTopiaDao<E extends TopiaEntity> topiaDAO

Constructor Detail

AbstractTopiaDao.TopiaQueryBuilderRunQueryStep

protected AbstractTopiaDao.TopiaQueryBuilderRunQueryStep(AbstractTopiaDao<E> topiaDAO,
                                              String hql,
                                              Map<String,Object> hqlParameters)

Method Detail

exists

public boolean exists()

Specified by:

exists in interface TopiaQueryBuilderRunQueryStep<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

Specified by:

findUnique in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

Throws:

TopiaNoResultException

TopiaNonUniqueResultException

findUniqueOrNull

public E findUniqueOrNull()
                                       throws TopiaNonUniqueResultException

Specified by:

findUniqueOrNull in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

Throws:

TopiaNonUniqueResultException

tryFindUnique

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

Specified by:

tryFindUnique in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

Throws:

TopiaNonUniqueResultException

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

findFirstOrNull

public E findFirstOrNull()
                                      throws QueryMissingOrderException

Description copied from interface: TopiaQueryBuilderRunQueryStep

Get the first element of the result set or null if query result was 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 was 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. This method duplicates TopiaQueryBuilderRunQueryStep.tryFindFirst() but allows you to prevent using Guava in you project. 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

Specified by:

findAny in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

Throws:

TopiaNoResultException

findAnyOrNull

public E findAnyOrNull()

Specified by:

findAnyOrNull in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

tryFindAny

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

Specified by:

tryFindAny in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

findAll

public List<E> findAll()

Specified by:

findAll in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

findAllLazy

public Iterable<E> findAllLazy()

Specified by:

findAllLazy in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

find

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

Specified by:

find in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

findAllIds

public List<String> findAllIds()

Specified by:

findAllIds in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>

findIds

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

Specified by:

findIds in interface TopiaQueryBuilderRunQueryStep<E extends TopiaEntity>