net.sf.mmm.util.query.api.feature

Interface FeatureFetch<E>

Type Parameters:

E - the generic type of the entity to fetch.

All Superinterfaces:

StatementFeature

All Known Subinterfaces:

JpqlSelectStatement<E>, OrientDbSelectStatement<E>, SelectStatement<E,SELF>

All Known Implementing Classes:

AbstractSelectStatement, JpqlSelectStatementImpl, OrientDbSelectStatementImpl

public interface FeatureFetch<E>
extends StatementFeature

A FeatureFetch is for a regular SelectStatement to fetch and retrieve results.

Since:

8.0.0

Author:

hohwille

See Also:

SelectStatement

Method Summary

Modifier and Type	Method and Description
default List<E>	fetch() Executes this query to fetch all matching results.
default long	fetchCount() Executes queryCount() and returns the result.
default E	fetchFirst() Executes queryFirst() and returns the result.
default E	fetchFirstRequired() Executes queryFirst() and returns the result.
default E	fetchOne() Executes queryOne() and returns the result.
default E	fetchOneRequired() Executes this query to fetch a unique result.
ListQuery<E>	query()
NumberQuery<Long>	queryCount()
SingleQuery<E>	queryFirst()
SingleQuery<E>	queryOne()

Method Detail

query

ListQuery<E> query()

Returns:

a ListQuery to fetch all matching results with a regular SELECT.

fetch

default List<E> fetch()

Executes this query to fetch all matching results.

Returns:

the List with all matching results. Will be an empty List if no results are found.

queryFirst

SingleQuery<E> queryFirst()

Returns:

a SingleQuery to fetch the first matching results with a SELECT.

fetchFirst

default E fetchFirst()

Executes queryFirst() and returns the result.

Returns:

the first matching result or null if no result is found.

fetchFirstRequired

default E fetchFirstRequired()
                      throws ObjectNotFoundException

Executes queryFirst() and returns the result.

Returns:

the first matching result.

Throws:

ObjectNotFoundException - if the query had no match.

queryOne

SingleQuery<E> queryOne()

Returns:

a SingleQuery to fetch a single unique matching result with a SELECT. The Query execution will fail with an exception if it matches multiple result objects. It can only have a single or an empty (null) result.

fetchOne

default E fetchOne()

Executes queryOne() and returns the result.

Returns:

the unique result or null if no result is found.

fetchOneRequired

default E fetchOneRequired()
                    throws ObjectNotFoundException

Executes this query to fetch a unique result.

Returns:

the unique result.

Throws:

ObjectNotFoundException - if the query had no match.

queryCount

NumberQuery<Long> queryCount()

Returns:

a NumberQuery to fetch the number of matching objects with a SELECT COUNT.

fetchCount

default long fetchCount()

Executes queryCount() and returns the result.

Returns:

the number of objects (rows) matching this query.