org.openmrs.api.db.hibernate.search

Class SearchQuery<T>

java.lang.Object

org.openmrs.api.db.hibernate.search.SearchQuery<T>

Direct Known Subclasses:

LuceneQuery

public abstract class SearchQuery<T>
extends Object

Wraps around a query to provide common result methods.

Since:

1.11

Constructor Summary

Constructors

Constructor and Description
SearchQuery(org.hibernate.Session session, Class<T> type)

Method Summary

Modifier and Type	Method and Description
protected org.hibernate.Session	getSession()
protected Class<T>	getType()
abstract List<T>	list() Runs the query returning a list with all results.
ListPart<T>	listPart(Integer firstResult, Integer maxResults)
abstract ListPart<T>	listPart(Long firstResult, Long maxResults) Runs the query returning a partial results list.
abstract long	resultSize()
abstract T	uniqueResult() Runs the query returning a unique result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchQuery

public SearchQuery(org.hibernate.Session session,
                   Class<T> type)

Method Detail

getType

protected Class<T> getType()

Returns:

the type

getSession

protected org.hibernate.Session getSession()

uniqueResult

public abstract T uniqueResult()
                        throws org.hibernate.HibernateException

Runs the query returning a unique result.

Returns:

the unique result or null

Throws:

org.hibernate.HibernateException - if more than one result

list

public abstract List<T> list()

Runs the query returning a list with all results.

Returns:

the list

listPart

public abstract ListPart<T> listPart(Long firstResult,
                                     Long maxResults)

Runs the query returning a partial results list.

Parameters:

firstResult - position of the first result to return, optional

maxResults - maximum number of results, optional

Returns:

the partial list

resultSize

public abstract long resultSize()

listPart

public ListPart<T> listPart(Integer firstResult,
                            Integer maxResults)