com.atlassian.confluence.search.v2.query
Class TextFieldQuery
java.lang.Object
com.atlassian.confluence.search.v2.query.TextFieldQuery
- All Implemented Interfaces:
- SearchQuery
public class TextFieldQuery
- extends Object
- implements SearchQuery
Represents a raw query from the user that may be parsed.
Note: Using this query means that you know the name of fields within your index. This means that your code is
bound to the name of fields in the index which could change.
Ultimately you should not consider the TextFieldQuery
part of the public search API.
TextFieldQuery
public TextFieldQuery(String fieldName,
String rawQuery,
BooleanOperator operator)
- Parameters:
fieldName
- the field name in the indexrawQuery
- the raw query string for the fieldoperator
- the operator applied to raw query string. For example, with a rawQuery of "foo bar", specifying
BooleanOperator.AND
means "foo AND bar"
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
String
s or SearchQuery
s.
- Specified by:
getParameters
in interface SearchQuery
- Returns:
String
s or SearchQuery
s.
getFieldName
public String getFieldName()
getRawQuery
public String getRawQuery()
getOperator
public BooleanOperator getOperator()
equals
public boolean equals(Object obj)
- Overrides:
equals
in class Object
hashCode
public int hashCode()
- Overrides:
hashCode
in class Object
Copyright © 2003-2013 Atlassian. All Rights Reserved.