com.mysema.query.hibernate.search

Class SearchQuery<T>

java.lang.Object

com.mysema.query.hibernate.search.SearchQuery<T>

Type Parameters:

T -

All Implemented Interfaces:

FilteredClause<SearchQuery<T>>, SimpleProjectable<T>, SimpleQuery<SearchQuery<T>>

public class SearchQuery<T>
extends java.lang.Object
implements SimpleQuery<SearchQuery<T>>, SimpleProjectable<T>

SearchQuery is a Query implementation for Hibernate Search

Author:

tiwe

Constructor Summary

Constructors

Constructor and Description
SearchQuery(org.hibernate.search.FullTextSession session, EntityPath<T> path) Create a new SearchQuery instance
SearchQuery(org.hibernate.Session session, EntityPath<T> path)

Method Summary

Methods

Modifier and Type	Method and Description
long	count() Get the count of matched elements
SearchQuery<T>	distinct() Set the Query to return distinct results
boolean	exists()
com.mysema.commons.lang.CloseableIterator<T>	iterate() Get the projection as a typed closeable Iterator
com.mysema.commons.lang.CloseableIterator<T>	iterateDistinct()
SearchQuery<T>	limit(long limit) Set the limit / max results for the query results
java.util.List<T>	list() Get the projection as a typed List
SearchResults<T>	listResults() Get the projection in SearchResults form
boolean	notExists()
SearchQuery<T>	offset(long offset) Set the offset for the query results
SearchQuery<T>	orderBy(OrderSpecifier<?>... o) Add order expressions
SearchQuery<T>	restrict(QueryModifiers modifiers) Set both limit and offset of the query results
<P> SearchQuery<T>	set(ParamExpression<P> param, P value) Set the given parameter to the given value
T	singleResult() Get the projection as a single result or null if no result is found
T	uniqueResult() Get the projection as a unique result or null if no result is found
SearchQuery<T>	where(Predicate... e) Adds the given filter conditions

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.search.FullTextSession session,
           EntityPath<T> path)

Create a new SearchQuery instance

Parameters:

session -

path -

SearchQuery

public SearchQuery(org.hibernate.Session session,
           EntityPath<T> path)

Method Detail

exists

public boolean exists()

Specified by:

exists in interface SimpleProjectable<T>

Returns:

true, if rows matching the given criteria exist, otherwise false

notExists

public boolean notExists()

Specified by:

notExists in interface SimpleProjectable<T>

Returns:

true, if no rows matching the given criteria exist, otherwise false

count

public long count()

Description copied from interface: SimpleProjectable

Get the count of matched elements

Specified by:

count in interface SimpleProjectable<T>

Returns:

distinct

public SearchQuery<T> distinct()

Description copied from interface: SimpleQuery

Set the Query to return distinct results

Specified by:

distinct in interface SimpleQuery<SearchQuery<T>>

Returns:

iterate

public com.mysema.commons.lang.CloseableIterator<T> iterate()

Description copied from interface: SimpleProjectable

Get the projection as a typed closeable Iterator

Specified by:

iterate in interface SimpleProjectable<T>

Returns:

iterateDistinct

public com.mysema.commons.lang.CloseableIterator<T> iterateDistinct()

limit

public SearchQuery<T> limit(long limit)

Description copied from interface: SimpleQuery

Set the limit / max results for the query results

Specified by:

limit in interface SimpleQuery<SearchQuery<T>>

Returns:

list

public java.util.List<T> list()

Description copied from interface: SimpleProjectable

Get the projection as a typed List

Specified by:

list in interface SimpleProjectable<T>

Returns:

listResults

public SearchResults<T> listResults()

Description copied from interface: SimpleProjectable

Get the projection in SearchResults form

Specified by:

listResults in interface SimpleProjectable<T>

Returns:

offset

public SearchQuery<T> offset(long offset)

Description copied from interface: SimpleQuery

Set the offset for the query results

Specified by:

offset in interface SimpleQuery<SearchQuery<T>>

Returns:

orderBy

public SearchQuery<T> orderBy(OrderSpecifier<?>... o)

Description copied from interface: SimpleQuery

Add order expressions

Specified by:

orderBy in interface SimpleQuery<SearchQuery<T>>

Returns:

restrict

public SearchQuery<T> restrict(QueryModifiers modifiers)

Description copied from interface: SimpleQuery

Set both limit and offset of the query results

Specified by:

restrict in interface SimpleQuery<SearchQuery<T>>

Returns:

set

public <P> SearchQuery<T> set(ParamExpression<P> param,
                     P value)

Description copied from interface: SimpleQuery

Set the given parameter to the given value

Specified by:

set in interface SimpleQuery<SearchQuery<T>>

Returns:

singleResult

public T singleResult()

Description copied from interface: SimpleProjectable

Get the projection as a single result or null if no result is found

for multiple results only the first one is returned

Specified by:

singleResult in interface SimpleProjectable<T>

Returns:

uniqueResult

public T uniqueResult()

Description copied from interface: SimpleProjectable

Get the projection as a unique result or null if no result is found

Specified by:

uniqueResult in interface SimpleProjectable<T>

Returns:

where

public SearchQuery<T> where(Predicate... e)

Description copied from interface: FilteredClause

Adds the given filter conditions

Skips null arguments

Specified by:

where in interface FilteredClause<SearchQuery<T>>

Parameters:

e - filter conditions to be added

Returns: