com.querydsl.lucene3

Class AbstractLuceneQuery<T,Q extends AbstractLuceneQuery<T,Q>>

java.lang.Object

com.querydsl.lucene3.AbstractLuceneQuery<T,Q>

Type Parameters:

T - projection type

Q - concrete subtype of query

All Implemented Interfaces:

Fetchable<T>, FilteredClause<Q>, SimpleQuery<Q>

Direct Known Subclasses:

LuceneQuery, TypedQuery

public abstract class AbstractLuceneQuery<T,Q extends AbstractLuceneQuery<T,Q>>
extends java.lang.Object
implements SimpleQuery<Q>, Fetchable<T>

AbstractLuceneQuery is an abstract super class for Lucene query implementations

Author:

tiwe

Constructor Summary

Constructors

Constructor and Description
AbstractLuceneQuery(org.apache.lucene.search.IndexSearcher searcher, java.util.function.Function<org.apache.lucene.document.Document,T> transformer)
AbstractLuceneQuery(LuceneSerializer serializer, org.apache.lucene.search.IndexSearcher searcher, java.util.function.Function<org.apache.lucene.document.Document,T> transformer)

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.Filter	asFilter() Create a filter for constraints defined in this query
protected org.apache.lucene.search.Query	createQuery()
Q	distinct() Set the Query to return distinct results
Q	distinct(Path<?> property) Add a DuplicateFilter for the field of the given property path
java.util.List<T>	fetch() Get the projection as a typed List
long	fetchCount() Get the count of matched elements Note: not all QueryDSL modules might optimize fetchCount using a count query.
T	fetchFirst() Get the first result of Get the projection or null if no result is found
T	fetchOne() Get the projection as a unique result or null if no result is found
QueryResults<T>	fetchResults() Get the projection in QueryResults form.
Q	filter(org.apache.lucene.search.Filter filter) Apply the given Lucene filter to the search results
com.mysema.commons.lang.CloseableIterator<T>	iterate() Get the projection as a typed closeable Iterator
Q	limit(long limit) Set the limit / max results for the query results
Q	load(FieldSelector fieldSelector) Set the given FieldSelector to the query
Q	load(Path<?>... paths) Load only the fields of the given paths
Q	offset(long offset) Set the offset for the query results
Q	orderBy(OrderSpecifier<?>... o) Add order expressions
Q	orderBy(OrderSpecifier<?> o)
Q	restrict(QueryModifiers modifiers) Set both limit and offset of the query results
<P> Q	set(ParamExpression<P> param, P value) Set the given parameter to the given value
Q	sort(org.apache.lucene.search.Sort sort)
java.lang.String	toString()
Q	where(Predicate... e) Adds the given filter conditions
Q	where(Predicate e)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.querydsl.core.Fetchable

stream

Constructor Detail

AbstractLuceneQuery

public AbstractLuceneQuery(LuceneSerializer serializer,
                           org.apache.lucene.search.IndexSearcher searcher,
                           java.util.function.Function<org.apache.lucene.document.Document,T> transformer)

AbstractLuceneQuery

public AbstractLuceneQuery(org.apache.lucene.search.IndexSearcher searcher,
                           java.util.function.Function<org.apache.lucene.document.Document,T> transformer)

Method Detail

fetchCount

public long fetchCount()

Description copied from interface: Fetchable

Get the count of matched elements Note: not all QueryDSL modules might optimize fetchCount using a count query. An implementation is allowed to fall back to fetch().size().

Specified by:

fetchCount in interface Fetchable<T>

Returns:

row count

createQuery

protected org.apache.lucene.search.Query createQuery()

asFilter

public org.apache.lucene.search.Filter asFilter()

Create a filter for constraints defined in this query

Returns:

filter

distinct

public Q distinct()

Description copied from interface: SimpleQuery

Set the Query to return distinct results

Specified by:

distinct in interface SimpleQuery<Q extends AbstractLuceneQuery<T,Q>>

Returns:

the current object

distinct

public Q distinct(Path<?> property)

Add a DuplicateFilter for the field of the given property path

Parameters:

property - distinct property

Returns:

the current object

filter

public Q filter(org.apache.lucene.search.Filter filter)

Apply the given Lucene filter to the search results

Parameters:

filter - filter

Returns:

the current object

limit

public Q limit(long limit)

Description copied from interface: SimpleQuery

Set the limit / max results for the query results

Specified by:

limit in interface SimpleQuery<Q extends AbstractLuceneQuery<T,Q>>

Parameters:

limit - max rows

Returns:

the current object

iterate

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

Description copied from interface: Fetchable

Get the projection as a typed closeable Iterator

Specified by:

iterate in interface Fetchable<T>

Returns:

closeable iterator

fetch

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

Description copied from interface: Fetchable

Get the projection as a typed List

Specified by:

fetch in interface Fetchable<T>

Returns:

results in list form

load

public Q load(FieldSelector fieldSelector)

Set the given FieldSelector to the query

Parameters:

fieldSelector - field selector

Returns:

the current object

load

public Q load(Path<?>... paths)

Load only the fields of the given paths

Parameters:

paths - fields to load

Returns:

the current object

fetchResults

public QueryResults<T> fetchResults()

Description copied from interface: Fetchable

Get the projection in QueryResults form. Make sure to use Fetchable.fetch() instead if you do not rely on the QueryResults.getOffset() or QueryResults.getLimit(), because it will be more performant. Also, count queries cannot be properly generated for all dialects. For example: in JPA count queries can't be generated for queries that have multiple group by expressions or a having clause. Get the projection in QueryResults form. Use Fetchable.fetch() instead if you do not need the total count of rows in the query result.

Specified by:

fetchResults in interface Fetchable<T>

Returns:

results

See Also:

Fetchable.fetch()

offset

public Q offset(long offset)

Description copied from interface: SimpleQuery

Set the offset for the query results

Specified by:

offset in interface SimpleQuery<Q extends AbstractLuceneQuery<T,Q>>

Parameters:

offset - row offset

Returns:

the current object

orderBy

public Q orderBy(OrderSpecifier<?> o)

orderBy

public Q orderBy(OrderSpecifier<?>... o)

Description copied from interface: SimpleQuery

Add order expressions

Specified by:

orderBy in interface SimpleQuery<Q extends AbstractLuceneQuery<T,Q>>

Parameters:

o - order

Returns:

the current object

restrict

public Q restrict(QueryModifiers modifiers)

Description copied from interface: SimpleQuery

Set both limit and offset of the query results

Specified by:

restrict in interface SimpleQuery<Q extends AbstractLuceneQuery<T,Q>>

Parameters:

modifiers - query modifiers

Returns:

the current object

set

public <P> Q 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<Q extends AbstractLuceneQuery<T,Q>>

Parameters:

param - param

value - binding

Returns:

the current object

sort

public Q sort(org.apache.lucene.search.Sort sort)

fetchFirst

public T fetchFirst()

Description copied from interface: Fetchable

Get the first result of Get the projection or null if no result is found

Specified by:

fetchFirst in interface Fetchable<T>

Returns:

first result or null

fetchOne

public T fetchOne()
           throws NonUniqueResultException

Description copied from interface: Fetchable

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

Specified by:

fetchOne in interface Fetchable<T>

Returns:

first result or null

Throws:

NonUniqueResultException - if there is more than one matching result

where

public Q where(Predicate e)

where

public Q where(Predicate... e)

Description copied from interface: FilteredClause

Adds the given filter conditions

Skips null arguments

Specified by:

where in interface FilteredClause<Q extends AbstractLuceneQuery<T,Q>>

Parameters:

e - filter conditions to be added

Returns:

the current object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object