com.atlassian.confluence.search.v2.query

Class MultiTextFieldQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.MultiTextFieldQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

Direct Known Subclasses:

TextQuery

public class MultiTextFieldQuery
extends Object
implements SearchQuery

Represents a query against multiple fields.

Constructor Summary

Constructors

Constructor and Description
MultiTextFieldQuery(Collection<String> fields, Map<String,? extends com.atlassian.confluence.plugins.index.api.AnalyzerDescriptorProvider> analyzerProviders, BooleanOperator operator, String query) Create a query where a field can be tokenized by a provided analyzer.
MultiTextFieldQuery(String query, Set<String> fields, BooleanOperator operator) Constructs a multi-field query with the specified query, fields and operator.
MultiTextFieldQuery(String query, String... fields) Constructs a multi-field query with the operator set to BooleanOperator.AND.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
SearchQuery	expand() Expands this query into a composite query (that composes other queries).
Map<String,? extends com.atlassian.confluence.plugins.index.api.AnalyzerDescriptorProvider>	getAnalyzerProviders() Returns information required to construct analyzer for the query if it is available.
Set<String>	getFields()
String	getKey()
BooleanOperator	getOperator()
List	getParameters() List of parameters as Strings or SearchQuerys.
String	getQuery()
String	getUnescapedQuery()
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.search.v2.SearchQuery

getBoost

Constructor Detail

MultiTextFieldQuery

public MultiTextFieldQuery(String query,
                           Set<String> fields,
                           BooleanOperator operator)

Constructs a multi-field query with the specified query, fields and operator.

Parameters:

fields - the fields to query against

operator - whether the query must match all terms AND or any of them {code OR}.

query - the query

MultiTextFieldQuery

public MultiTextFieldQuery(String query,
                           String... fields)

Constructs a multi-field query with the operator set to BooleanOperator.AND.

Parameters:

fields - the fields to query against

query - the query

MultiTextFieldQuery

public MultiTextFieldQuery(Collection<String> fields,
                           Map<String,? extends com.atlassian.confluence.plugins.index.api.AnalyzerDescriptorProvider> analyzerProviders,
                           BooleanOperator operator,
                           String query)

Create a query where a field can be tokenized by a provided analyzer.

Parameters:

fields - the fields to query against

analyzerProviders - specifies a non-standard analyzer for a field

operator - whether the query must match all terms AND or any of them {code OR}

query - the query

Since:

7.0

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

getQuery

public String getQuery()

getUnescapedQuery

public String getUnescapedQuery()

getFields

public Set<String> getFields()

getAnalyzerProviders

public Map<String,? extends com.atlassian.confluence.plugins.index.api.AnalyzerDescriptorProvider> getAnalyzerProviders()

Returns information required to construct analyzer for the query if it is available.

Since:

7.0

getOperator

public BooleanOperator getOperator()

getParameters

public List getParameters()

Description copied from interface: SearchQuery

List of parameters as Strings or SearchQuerys.

Specified by:

getParameters in interface SearchQuery

Returns:

Strings or SearchQuerys.

expand

public SearchQuery expand()

Description copied from interface: SearchQuery

Expands this query into a composite query (that composes other queries). By overriding this method, one can specify a new query that is composition of the behaviour of the composed queries.

Specified by:

expand in interface Expandable<SearchQuery>

Specified by:

expand in interface SearchQuery

Returns:

a query

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object