org.openmrs.api.db.hibernate.search

Class LuceneQuery<T>

java.lang.Object

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

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

public abstract class LuceneQuery<T>
extends SearchQuery<T>

Performs Lucene queries.

Since:

1.11

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LuceneQuery.MatchType Normal uses a textual match algorithm for the search Soundex indicates to use a Phonetic search strategy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	adjustFullTextQuery(org.hibernate.search.FullTextQuery fullTextQuery) It is called by the constructor after creating FullTextQuery.
static String	escapeQuery(String query) Escape any characters that can be interpreted by the query parser.
LuceneQuery<T>	exclude(String field, Object value) Exclude any items with the given value in the specified field.
LuceneQuery<T>	exclude(String field, Object[] values) Exclude any items with the given values in the specified field.
protected org.hibernate.search.FullTextSession	getFullTextSession() Gives you access to the full text session.
LuceneQuery<T>	include(String field, Collection<?> values)
LuceneQuery<T>	include(String field, Object value) Include items with the given value in the specified field.
LuceneQuery<T>	include(String field, Object[] values) Include items with any of the given values in the specified field.
List<T>	list() Runs the query returning a list with all results.
ListPart<T>	listPart(Long firstResult, Long maxResults) Runs the query returning a partial results list.
ListPart<Object[]>	listPartProjection(Integer firstResult, Integer maxResults, String... fields)
ListPart<Object[]>	listPartProjection(Long firstResult, Long maxResults, String... fields)
List<Object[]>	listProjection(String... fields)
protected org.apache.lucene.queryparser.classic.MultiFieldQueryParser	newMultipleFieldQueryParser(Collection<String> fields, LuceneQuery.MatchType matchType)
static <T> LuceneQuery<T>	newQuery(Class<T> type, org.hibernate.Session session, String query) The preferred way to create a Lucene query using the query parser.
static <T> LuceneQuery<T>	newQuery(Class<T> type, org.hibernate.Session session, String query, Collection<String> fields)
static <T> LuceneQuery<T>	newQuery(Class<T> type, org.hibernate.Session session, String query, Collection<String> fields, LuceneQuery.MatchType matchType)
protected org.hibernate.search.query.dsl.QueryBuilder	newQueryBuilder() You can use it in prepareQuery().
protected org.apache.lucene.queryparser.classic.QueryParser	newQueryParser() You can use it in prepareQuery().
protected abstract org.apache.lucene.search.Query	prepareQuery() It is called by the constructor to get an instance of a query.
long	resultSize()
LuceneQuery<T>	skipSame(String field) Skip elements, values of which repeat in the given field.
LuceneQuery<T>	skipSame(String field, LuceneQuery<?> luceneQuery) Skip elements, values of which repeat in the given field.
T	uniqueResult() Runs the query returning a unique result.
LuceneQuery<T>	useOrQueryParser()

Methods inherited from class org.openmrs.api.db.hibernate.search.SearchQuery

getSession, getType, listPart

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneQuery

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

Method Detail

newQuery

public static <T> LuceneQuery<T> newQuery(Class<T> type,
                                          org.hibernate.Session session,
                                          String query,
                                          Collection<String> fields)

newQuery

public static <T> LuceneQuery<T> newQuery(Class<T> type,
                                          org.hibernate.Session session,
                                          String query,
                                          Collection<String> fields,
                                          LuceneQuery.MatchType matchType)

newQuery

public static <T> LuceneQuery<T> newQuery(Class<T> type,
                                          org.hibernate.Session session,
                                          String query)

The preferred way to create a Lucene query using the query parser.

Parameters:

type - filters on type

session -

query -

Returns:

the Lucene query

escapeQuery

public static String escapeQuery(String query)

Escape any characters that can be interpreted by the query parser.

Parameters:

query -

Returns:

the escaped query

useOrQueryParser

public LuceneQuery<T> useOrQueryParser()

include

public LuceneQuery<T> include(String field,
                              Object value)

Include items with the given value in the specified field.

It is a filter applied before the query.

Parameters:

field -

value -

Returns:

the query

include

public LuceneQuery<T> include(String field,
                              Collection<?> values)

include

public LuceneQuery<T> include(String field,
                              Object[] values)

Include items with any of the given values in the specified field.

It is a filter applied before the query.

Parameters:

field -

values -

Returns:

the query

exclude

public LuceneQuery<T> exclude(String field,
                              Object value)

Exclude any items with the given value in the specified field.

It is a filter applied before the query.

Parameters:

field -

value -

Returns:

the query

exclude

public LuceneQuery<T> exclude(String field,
                              Object[] values)

Exclude any items with the given values in the specified field.

It is a filter applied before the query.

Parameters:

field -

values -

Returns:

the query

prepareQuery

protected abstract org.apache.lucene.search.Query prepareQuery()
                                                        throws org.apache.lucene.queryparser.classic.ParseException

It is called by the constructor to get an instance of a query.

To construct the query you can use newQueryBuilder() or newQueryParser(), which are created for the proper type.

Returns:

the query

Throws:

org.apache.lucene.queryparser.classic.ParseException

adjustFullTextQuery

protected void adjustFullTextQuery(org.hibernate.search.FullTextQuery fullTextQuery)

It is called by the constructor after creating FullTextQuery.

You can override it to adjust the full text query, e.g. add a filter.

Parameters:

fullTextQuery -

newQueryBuilder

protected org.hibernate.search.query.dsl.QueryBuilder newQueryBuilder()

You can use it in prepareQuery().

Returns:

the query builder

newQueryParser

protected org.apache.lucene.queryparser.classic.QueryParser newQueryParser()

You can use it in prepareQuery().

Returns:

the query parser

newMultipleFieldQueryParser

protected org.apache.lucene.queryparser.classic.MultiFieldQueryParser newMultipleFieldQueryParser(Collection<String> fields,
                                                                                                  LuceneQuery.MatchType matchType)

getFullTextSession

protected org.hibernate.search.FullTextSession getFullTextSession()

Gives you access to the full text session.

Returns:

the full text session

skipSame

public LuceneQuery<T> skipSame(String field)

Skip elements, values of which repeat in the given field.

Only first elements will be included in the results.

Note: This method must be called as last when constructing a query. When called it will project the query and create a filter to eliminate duplicates.

Parameters:

field -

Returns:

this

skipSame

public LuceneQuery<T> skipSame(String field,
                               LuceneQuery<?> luceneQuery)

Skip elements, values of which repeat in the given field.

Only first elements will be included in the results.

Note: This method must be called as last when constructing a query. When called it will project the query and create a filter to eliminate duplicates.

Parameters:

field -

luceneQuery - results of which should be skipped too. It works only for queries, which called skipSame as well.

Returns:

this

uniqueResult

public T uniqueResult()

Description copied from class: SearchQuery

Runs the query returning a unique result.

Specified by:

uniqueResult in class SearchQuery<T>

Returns:

the unique result or null

list

public List<T> list()

Description copied from class: SearchQuery

Runs the query returning a list with all results.

Specified by:

list in class SearchQuery<T>

Returns:

the list

listPart

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

Description copied from class: SearchQuery

Runs the query returning a partial results list.

Specified by:

listPart in class SearchQuery<T>

Parameters:

firstResult - position of the first result to return, optional

maxResults - maximum number of results, optional

Returns:

the partial list

resultSize

public long resultSize()

Specified by:

resultSize in class SearchQuery<T>

See Also:

SearchQuery.resultSize()

listProjection

public List<Object[]> listProjection(String... fields)

listPartProjection

public ListPart<Object[]> listPartProjection(Long firstResult,
                                             Long maxResults,
                                             String... fields)

listPartProjection

public ListPart<Object[]> listPartProjection(Integer firstResult,
                                             Integer maxResults,
                                             String... fields)