Package 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	Description
static final String	KEY

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

DEFAULT_BOOST

Constructor Summary

Constructors

Constructor	Description
QueryStringQuery(Collection<String> fieldNames, String query, BooleanOperator operator)
QueryStringQuery(Collection<String> fieldNames, String query, BooleanOperator operator, Map<String,Float> fieldsBoost)
QueryStringQuery(Collection<String> fieldNames, Map<String,? extends AnalyzerDescriptorProvider> analyzerProviders, BooleanOperator operator, String query)	Construct a query with a custom analyzer.
QueryStringQuery(Collection<String> fieldNames, Map<String,? extends AnalyzerDescriptorProvider> analyzerProviders, BooleanOperator operator, String query, Map<String,Float> fieldsBoost)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,? extends AnalyzerDescriptorProvider>	getAnalyzerProviders()	Returns information required to construct analyzer for a field if it is available.
Set<String>	getFieldNames()
Map<String,Float>	getFieldsBoost()
String	getKey()
BooleanOperator	getOperator()
List<?>	getParameters()	List of parameters as Strings or SearchQuerys.
String	getQuery()
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

expand, getBoost, getSubClauses

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

Constructor Details

QueryStringQuery

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

QueryStringQuery

public QueryStringQuery(Collection<String> fieldNames,
 Map<String,? extends AnalyzerDescriptorProvider> analyzerProviders,
 BooleanOperator operator,
 String query)

Construct a query with a custom analyzer.

Since:

7.0

QueryStringQuery

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

Since:

8.7

QueryStringQuery

public QueryStringQuery(Collection<String> fieldNames,
 Map<String,? extends AnalyzerDescriptorProvider> analyzerProviders,
 BooleanOperator operator,
 String query,
 Map<String,Float> fieldsBoost)

Since:

8.7

Method Details

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 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()

getFieldsBoost

public Map<String,Float> getFieldsBoost()

Returns:

the boost used for each field.

Since:

8.7

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object