com.atlassian.confluence.search.v2.query

Class QueryStringQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.QueryStringQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

@SearchPrimitive
public class QueryStringQuery
extends Object
implements SearchQuery

v2 primitive query

Since:

5.10

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY

Constructor Summary

Constructors

Constructor and Description
QueryStringQuery(Collection<String> fieldNames, Map<String,? extends com.atlassian.confluence.plugins.index.api.AnalyzerDescriptorProvider> analyzerProviders, BooleanOperator operator, String query) Construct a query with a custom analyzer.
QueryStringQuery(Collection<String> fieldNames, String query, BooleanOperator operator)

Method Summary

Modifier and Type	Method and Description
Map<String,? extends com.atlassian.confluence.plugins.index.api.AnalyzerDescriptorProvider>	getAnalyzerProviders() Returns information required to construct analyzer for a field if it is available.
Set<String>	getFieldNames()
String	getKey()
BooleanOperator	getOperator()
List<?>	getParameters() List of parameters as Strings or SearchQuerys.
String	getQuery()

Methods inherited from class java.lang.Object

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

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

expand, getBoost

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

QueryStringQuery

public QueryStringQuery(Collection<String> fieldNames,
                        String query,
                        BooleanOperator operator)

QueryStringQuery

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

Construct a query with a custom analyzer.

Since:

7.0

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

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.

getFieldNames

public Set<String> getFieldNames()

getAnalyzerProviders

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

Returns information required to construct analyzer for a field if it is available.

Since:

7.0

getQuery

public String getQuery()

getOperator

public BooleanOperator getOperator()