edu.cornell.mannlib.vitro.webapp.searchengine.base

Class BaseSearchQuery

java.lang.Object

edu.cornell.mannlib.vitro.webapp.searchengine.base.BaseSearchQuery

All Implemented Interfaces:

SearchQuery

public class BaseSearchQuery
extends Object
implements SearchQuery

A foundation class for implementing SearchQuery.

Nested Class Summary

Nested classes/interfaces inherited from interface edu.cornell.mannlib.vitro.webapp.modules.searchEngine.SearchQuery

SearchQuery.Order

Constructor Summary

Constructors

Constructor and Description
BaseSearchQuery()

Method Summary

Modifier and Type	Method and Description
SearchQuery	addFacetFields(String... fields) What fields should be used to facet the results?
SearchQuery	addFields(Collection<String> names) Which fields should be returned from the query?
SearchQuery	addFields(String... names) Which fields should be returned from the query?
SearchQuery	addFilterQueries(String... filterQueries) Restrict the results by these queries.
SearchQuery	addFilterQuery(String filterQuery) Restrict the results by this query.
SearchQuery	addSortField(String name, SearchQuery.Order order) What field should be used to sort the results, and in what order?
Set<String>	getFacetFields()
int	getFacetLimit()
int	getFacetMinCount()
Set<String>	getFieldsToReturn()
Set<String>	getFilters()
String	getQuery()
int	getRows()
Map<String,SearchQuery.Order>	getSortFields()
int	getStart()
SearchQuery	setFacetLimit(int cnt) The maximum number of facet counts that will be returned from the query.
SearchQuery	setFacetMinCount(int cnt) Facet having fewer hits will be excluded from the list.
SearchQuery	setQuery(String query) Set the text of the query.
SearchQuery	setRows(int rows) What is the maximum number of documents that will be returned from the query? A negative value means no limit.
SearchQuery	setStart(int start) Where in the ordered list of result documents should the response begin? That is, how many of the results should be skipped? (allows paging of results).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSearchQuery

public BaseSearchQuery()

Method Detail

setQuery

public SearchQuery setQuery(String query)

Description copied from interface: SearchQuery

Set the text of the query. This will be parsed using Lucene query syntax.

Specified by:

setQuery in interface SearchQuery

Returns:

this query

setStart

public SearchQuery setStart(int start)

Description copied from interface: SearchQuery

Where in the ordered list of result documents should the response begin? That is, how many of the results should be skipped? (allows paging of results). The default is 0.

Specified by:

setStart in interface SearchQuery

Returns:

this query

setRows

public SearchQuery setRows(int rows)

Description copied from interface: SearchQuery

What is the maximum number of documents that will be returned from the query? A negative value means no limit. The default is -1.

Specified by:

setRows in interface SearchQuery

Returns:

this query

addFields

public SearchQuery addFields(String... names)

Description copied from interface: SearchQuery

Which fields should be returned from the query?

Specified by:

addFields in interface SearchQuery

Returns:

this query

addFields

public SearchQuery addFields(Collection<String> names)

Description copied from interface: SearchQuery

Which fields should be returned from the query?

Specified by:

addFields in interface SearchQuery

Returns:

this query

addSortField

public SearchQuery addSortField(String name,
                                SearchQuery.Order order)

Description copied from interface: SearchQuery

What field should be used to sort the results, and in what order?

Specified by:

addSortField in interface SearchQuery

Returns:

this query

addFilterQuery

public SearchQuery addFilterQuery(String filterQuery)

Description copied from interface: SearchQuery

Restrict the results by this query.

Specified by:

addFilterQuery in interface SearchQuery

Returns:

this query

addFilterQueries

public SearchQuery addFilterQueries(String... filterQueries)

Description copied from interface: SearchQuery

Restrict the results by these queries.

Specified by:

addFilterQueries in interface SearchQuery

Returns:

this query

addFacetFields

public SearchQuery addFacetFields(String... fields)

Description copied from interface: SearchQuery

What fields should be used to facet the results?

Specified by:

addFacetFields in interface SearchQuery

Returns:

this query

setFacetLimit

public SearchQuery setFacetLimit(int cnt)

Description copied from interface: SearchQuery

The maximum number of facet counts that will be returned from the query. The default is 100. A negative value means no limit.

Specified by:

setFacetLimit in interface SearchQuery

Returns:

this query

setFacetMinCount

public SearchQuery setFacetMinCount(int cnt)

Description copied from interface: SearchQuery

Facet having fewer hits will be excluded from the list. The default is 0.

Specified by:

setFacetMinCount in interface SearchQuery

Returns:

this query

getQuery

public String getQuery()

Specified by:

getQuery in interface SearchQuery

Returns:

The text of the query. May be empty, but never null.

getStart

public int getStart()

Specified by:

getStart in interface SearchQuery

getRows

public int getRows()

Specified by:

getRows in interface SearchQuery

Returns:

A negative value means that no limit has been specified.

getFieldsToReturn

public Set<String> getFieldsToReturn()

Specified by:

getFieldsToReturn in interface SearchQuery

Returns:

May return an empty set, but never null.

getSortFields

public Map<String,SearchQuery.Order> getSortFields()

Specified by:

getSortFields in interface SearchQuery

Returns:

May return an empty map, but never null.

getFilters

public Set<String> getFilters()

Specified by:

getFilters in interface SearchQuery

Returns:

May return an empty set, but never null.

getFacetFields

public Set<String> getFacetFields()

Specified by:

getFacetFields in interface SearchQuery

Returns:

May return an empty set, but never null.

getFacetLimit

public int getFacetLimit()

Specified by:

getFacetLimit in interface SearchQuery

Returns:

A negative value means that no limit has been specified.

getFacetMinCount

public int getFacetMinCount()

Specified by:

getFacetMinCount in interface SearchQuery

Returns:

A negative value means that no limit has been specified.

toString

public String toString()

Overrides:

toString in class Object