net.conquiris.api.search
Interface Searcher

All Known Subinterfaces:

SearcherService

public interface Searcher

Interface for conquiris searchers. Implementations specify the mapping between conquiris and lucene index searchers.

Author:

Andres Rodriguez

Method Summary

org.apache.lucene.document.Document	doc(int i) Low level Lucene method.
CountResult	getCount(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, boolean score) Returns the number of results of a query.
<T> ItemResult<T>	getFirst(DocMapper<T> mapper, org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Sort sort, Highlight highlight) Returns the first result of a query
<T> PageResult<T>	getPage(DocMapper<T> mapper, org.apache.lucene.search.Query query, int firstRecord, int maxRecords, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Sort sort, Highlight highlight) Returns a page of results of a query.
org.apache.lucene.search.Query	rewrite(org.apache.lucene.search.Query query) Low level Lucene method.
void	search(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, org.apache.lucene.search.Collector results) Low level Lucene method.
org.apache.lucene.search.TopDocs	search(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, int n) Low level Lucene method.
org.apache.lucene.search.TopFieldDocs	search(org.apache.lucene.search.Query query, org.apache.lucene.search.Filter filter, int n, org.apache.lucene.search.Sort sort) Low level Lucene method.

Method Detail

search

void search(org.apache.lucene.search.Query query,
            org.apache.lucene.search.Filter filter,
            org.apache.lucene.search.Collector results)

Low level Lucene method.

See Also:

IndexSearcher.search(Query, Filter, Collector)

search

org.apache.lucene.search.TopDocs search(org.apache.lucene.search.Query query,
                                        org.apache.lucene.search.Filter filter,
                                        int n)

Low level Lucene method.

See Also:

IndexSearcher.search(Query, Filter, int)

search

org.apache.lucene.search.TopFieldDocs search(org.apache.lucene.search.Query query,
                                             org.apache.lucene.search.Filter filter,
                                             int n,
                                             org.apache.lucene.search.Sort sort)

Low level Lucene method.

See Also:

IndexSearcher.search(Query, Filter, int, Sort)

rewrite

org.apache.lucene.search.Query rewrite(org.apache.lucene.search.Query query)

Low level Lucene method.

See Also:

IndexSearcher.rewrite(Query)

doc

org.apache.lucene.document.Document doc(int i)

Low level Lucene method.

See Also:

IndexSearcher.doc(int)

getFirst

<T> ItemResult<T> getFirst(DocMapper<T> mapper,
                           org.apache.lucene.search.Query query,
                           @Nullable
                           org.apache.lucene.search.Filter filter,
                           @Nullable
                           org.apache.lucene.search.Sort sort,
                           @Nullable
                           Highlight highlight)

Returns the first result of a query

Parameters:

mapper - Mapper to use.

query - Query to perform.

filter - Filter to apply

sort - Sort order.

highlight - Highlight configuration.

Returns:

The item result.

getPage

<T> PageResult<T> getPage(DocMapper<T> mapper,
                          org.apache.lucene.search.Query query,
                          int firstRecord,
                          int maxRecords,
                          @Nullable
                          org.apache.lucene.search.Filter filter,
                          @Nullable
                          org.apache.lucene.search.Sort sort,
                          @Nullable
                          Highlight highlight)

Returns a page of results of a query.

Parameters:

mapper - Mapper to use.

query - Query to perform.

firstRecord - First requedted record.

maxRecords - Maximum number of records to return.

filter - Filter to apply

sort - Sort order.

highlight - Highlight configuration.

Returns:

The page result.

getCount

CountResult getCount(org.apache.lucene.search.Query query,
                     @Nullable
                     org.apache.lucene.search.Filter filter,
                     boolean score)

Returns the number of results of a query.

Parameters:

query - Query to perform.

filter - Filter to apply

score - Whether the scores must be calculated.

Returns:

The count result.