Package org.opencastproject.elasticsearch.impl

Class AbstractSearchQuery

java.lang.Object

org.opencastproject.elasticsearch.impl.AbstractSearchQuery

All Implemented Interfaces:

org.opencastproject.elasticsearch.api.SearchQuery

public abstract class AbstractSearchQuery
extends Object
implements org.opencastproject.elasticsearch.api.SearchQuery

Base implementation for search queries.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	fields	The list of fields to return
protected String	filter	Filter terms
protected boolean	fuzzySearch	True if the search text should be matched using wildcards
protected int	limit	The query limit
protected int	offset	The query offset
protected List<org.opencastproject.elasticsearch.api.SearchTerms<String>>	text	Query terms
protected List<String>	types	The document types

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSearchQuery()	Creates a search query that is executed on all document types.
	AbstractSearchQuery(String documentType)	Creates a search query that is executed on the given document type.

Method Summary

Modifier and Type	Method	Description
String[]	getFields()
String	getFilter()
int	getLimit()
int	getOffset()
String	getQueryString()
org.opencastproject.util.requests.SortCriterion.Order	getSortOrder(String field)
Map<String,org.opencastproject.util.requests.SortCriterion.Order>	getSortOrders()
Collection<org.opencastproject.elasticsearch.api.SearchTerms<String>>	getTerms()
String[]	getTypes()
boolean	isFuzzySearch()
protected abstract String	sortOrderFieldName(String field)
AbstractSearchQuery	withField(String field)
AbstractSearchQuery	withFields(String... fields)
org.opencastproject.elasticsearch.api.SearchQuery	withFilter(String filter)
org.opencastproject.elasticsearch.api.SearchQuery	withLimit(int limit)
org.opencastproject.elasticsearch.api.SearchQuery	withOffset(int offset)
org.opencastproject.elasticsearch.api.SearchQuery	withSortOrder(String field, org.opencastproject.util.requests.SortCriterion.Order order)
org.opencastproject.elasticsearch.api.SearchQuery	withText(boolean wildcardSearch, String text)
org.opencastproject.elasticsearch.api.SearchQuery	withText(boolean wildcardSearch, org.opencastproject.elasticsearch.api.SearchTerms.Quantifier quantifier, String... text)
org.opencastproject.elasticsearch.api.SearchQuery	withText(String text)
org.opencastproject.elasticsearch.api.SearchQuery	withTypes(String... types)

Methods inherited from class java.lang.Object

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

Field Details

types

protected List<String> types

The document types

fields

protected List<String> fields

The list of fields to return

fuzzySearch

protected boolean fuzzySearch

True if the search text should be matched using wildcards

text

protected List<org.opencastproject.elasticsearch.api.SearchTerms<String>> text

Query terms

filter

protected String filter

Filter terms

offset

protected int offset

The query offset

limit

protected int limit

The query limit

Constructor Details

AbstractSearchQuery

protected AbstractSearchQuery()

Creates a search query that is executed on all document types.

AbstractSearchQuery

public AbstractSearchQuery(String documentType)

Creates a search query that is executed on the given document type.

Parameters:

documentType - the document type

Method Details

withTypes

public org.opencastproject.elasticsearch.api.SearchQuery withTypes(String... types)

Specified by:

withTypes in interface org.opencastproject.elasticsearch.api.SearchQuery

getTypes

public String[] getTypes()

Specified by:

getTypes in interface org.opencastproject.elasticsearch.api.SearchQuery

withField

public AbstractSearchQuery withField(String field)

Specified by:

withField in interface org.opencastproject.elasticsearch.api.SearchQuery

withFields

public AbstractSearchQuery withFields(String... fields)

Specified by:

withFields in interface org.opencastproject.elasticsearch.api.SearchQuery

getFields

public String[] getFields()

Specified by:

getFields in interface org.opencastproject.elasticsearch.api.SearchQuery

withLimit

public org.opencastproject.elasticsearch.api.SearchQuery withLimit(int limit)

Specified by:

withLimit in interface org.opencastproject.elasticsearch.api.SearchQuery

getLimit

public int getLimit()

Specified by:

getLimit in interface org.opencastproject.elasticsearch.api.SearchQuery

withOffset

public org.opencastproject.elasticsearch.api.SearchQuery withOffset(int offset)

Specified by:

withOffset in interface org.opencastproject.elasticsearch.api.SearchQuery

getOffset

public int getOffset()

Specified by:

getOffset in interface org.opencastproject.elasticsearch.api.SearchQuery

withText

public org.opencastproject.elasticsearch.api.SearchQuery withText(String text)

Specified by:

withText in interface org.opencastproject.elasticsearch.api.SearchQuery

withText

public org.opencastproject.elasticsearch.api.SearchQuery withText(boolean wildcardSearch,
 String text)

Specified by:

withText in interface org.opencastproject.elasticsearch.api.SearchQuery

withText

public org.opencastproject.elasticsearch.api.SearchQuery withText(boolean wildcardSearch,
 org.opencastproject.elasticsearch.api.SearchTerms.Quantifier quantifier,
 String... text)

Specified by:

withText in interface org.opencastproject.elasticsearch.api.SearchQuery

getTerms

public Collection<org.opencastproject.elasticsearch.api.SearchTerms<String>> getTerms()

Specified by:

getTerms in interface org.opencastproject.elasticsearch.api.SearchQuery

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface org.opencastproject.elasticsearch.api.SearchQuery

isFuzzySearch

public boolean isFuzzySearch()

Specified by:

isFuzzySearch in interface org.opencastproject.elasticsearch.api.SearchQuery

withFilter

public org.opencastproject.elasticsearch.api.SearchQuery withFilter(String filter)

Specified by:

withFilter in interface org.opencastproject.elasticsearch.api.SearchQuery

getFilter

public String getFilter()

Specified by:

getFilter in interface org.opencastproject.elasticsearch.api.SearchQuery

withSortOrder

public org.opencastproject.elasticsearch.api.SearchQuery withSortOrder(String field,
 org.opencastproject.util.requests.SortCriterion.Order order)

Specified by:

withSortOrder in interface org.opencastproject.elasticsearch.api.SearchQuery

getSortOrders

public Map<String,org.opencastproject.util.requests.SortCriterion.Order> getSortOrders()

Specified by:

getSortOrders in interface org.opencastproject.elasticsearch.api.SearchQuery

getSortOrder

public org.opencastproject.util.requests.SortCriterion.Order getSortOrder(String field)

Specified by:

getSortOrder in interface org.opencastproject.elasticsearch.api.SearchQuery

sortOrderFieldName

protected abstract String sortOrderFieldName(String field)