AbstractLuceneQuery (Querydsl 4.0.4 API)

java.lang.Object
- com.querydsl.lucene4.AbstractLuceneQuery<T,Q>

Type Parameters:

T - projection type

Q - concrete subtype of querydsl

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 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, com.google.common.base.Function<org.apache.lucene.document.Document,T> transformer)`
`AbstractLuceneQuery(LuceneSerializer serializer, org.apache.lucene.search.IndexSearcher searcher, com.google.common.base.Function<org.apache.lucene.document.Document,T> transformer)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.apache.lucene.search.Filter`	`asFilter()` Create a filter for constraints defined in this querydsl
`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
`List<T>`	`fetch()` Get the projection as a typed List
`long`	`fetchCount()` Get the count of matched elements
`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(Path<?>... paths)` Load only the fields of the given paths
`Q`	`load(Set<String> fieldsToLoad)` Set the given fields to load
`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)`
`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

- Constructor Detail
  - AbstractLuceneQuery
```
public AbstractLuceneQuery(LuceneSerializer serializer,
                           org.apache.lucene.search.IndexSearcher searcher,
                           com.google.common.base.Function<org.apache.lucene.document.Document,T> transformer)
```
  - AbstractLuceneQuery
```
public AbstractLuceneQuery(org.apache.lucene.search.IndexSearcher searcher,
                           com.google.common.base.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
    
    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 querydsl
    
    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 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(Set<String> fieldsToLoad)
```
    Set the given fields to load
    
    Parameters:
    
    fieldsToLoad - fields to load
    
    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
    
    Specified by:
    
    fetchResults in interface Fetchable<T>
    
    Returns:
    
    results
  - 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()
```
    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
  - 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 String toString()
```
    Overrides:
    
    toString in class Object

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractLuceneQuery

AbstractLuceneQuery

Method Detail

fetchCount

createQuery

asFilter

distinct

distinct

filter

limit

iterate

fetch

load

load

fetchResults

offset

orderBy

orderBy

restrict

set

sort

fetchFirst

fetchOne

where

where

toString