com.atlassian.confluence.search.v2.query

Class QueryStringQuery

java.lang.Object

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

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

@ParametersAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
public class QueryStringQuery
extends Object
implements SearchQuery

Represents a query that could be interpreted as using query syntax. v2 primitive query

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY

Constructor Summary

Constructors

Constructor and Description
QueryStringQuery(Collection<String> fieldNames, String query, BooleanOperator operator) Deprecated. Please use QueryStringQuery#QueryStringQuery(HasWellFormedQuerySyntax, Collection, BooleanOperator) instead.
QueryStringQuery(QueryTypeClassifier.Result.HasWellFormedQuerySyntax wellFormedQuery, Collection<String> fieldNames, BooleanOperator operator) Constructs a query that uses advanced query syntax.
QueryStringQuery(String query, Collection<String> fieldNames, BooleanOperator operator) Deprecated. Please use QueryStringQuery#QueryStringQuery(HasWellFormedQuerySyntax, Collection, BooleanOperator) instead. The support for alternative query is kept due to cyclic dependency and will be remove immediately when all usages of this in bundled plugins have been removed.

Method Summary

Modifier and Type	Method and Description
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

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

QueryStringQuery

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

Deprecated. Please use QueryStringQuery#QueryStringQuery(HasWellFormedQuerySyntax, Collection, BooleanOperator) instead. The support for alternative query is kept due to cyclic dependency and will be remove immediately when all usages of this in bundled plugins have been removed.

Constructs a query that uses advanced query syntax. The raw input should be checked before passed in to the constructor as the fallback mechanism with alternative query will be removed in the immediate future, and the execution of this query in Elasticsearch mode in ESSearchManager with invalid query syntax will result in exception.

Parameters:

query - a query text that should contain well-formed supported query syntax

fieldNames - a set of fields to search against. May be empty, when all text and string fields are to be searched.

operator - the operator applied to query string. For example, with a query of "foo bar", specifying BooleanOperator.AND means "foo AND bar"

QueryStringQuery

public QueryStringQuery(QueryTypeClassifier.Result.HasWellFormedQuerySyntax wellFormedQuery,
                        Collection<String> fieldNames,
                        BooleanOperator operator)

Constructs a query that uses advanced query syntax. A raw input should be checked by QueryTypeClassifier to contain well-formed supported query syntax, as the fallback mechanism with alternative query will be removed in the immediate future, and the execution of this query in Elasticsearch mode in ESSearchManager with invalid query syntax will result in exception.

Parameters:

wellFormedQuery - a query text that has been checked to contain well-formed supported query syntax

fieldNames - a set of fields to search against. May be empty, when all text and string fields are to be searched.

operator - the operator applied to query string. For example, with a query of "foo bar", specifying BooleanOperator.AND means "foo AND bar"

QueryStringQuery

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

Deprecated. Please use QueryStringQuery#QueryStringQuery(HasWellFormedQuerySyntax, Collection, BooleanOperator) instead.

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

getQuery

public String getQuery()

getOperator

public BooleanOperator getOperator()