Package com.atlassian.confluence.search.v2.query

Class PhraseQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.PhraseQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

@SearchPrimitive
public class PhraseQuery
extends Object
implements SearchQuery

A query which matches by phrases.

Since:

5.10

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY

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

DEFAULT_BOOST

Constructor Summary

Constructors

Constructor	Description
PhraseQuery(String fieldName, String text, int slop)	Create a query which matches by phrases.
PhraseQuery(String fieldName, String text, int slop, AnalyzerDescriptorProvider analyzerDescriptorProvider)	Create a query which matches by phrases.
PhraseQuery(String fieldName, String text, int slop, AnalyzerDescriptorProvider analyzerDescriptorProvider, float boost)	Create a query which matches by phrases.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
AnalyzerDescriptorProvider	getAnalyzerDescriptorProvider()
float	getBoost()	Return boost factor of this query.
String	getFieldName()
String	getKey()
List<?>	getParameters()	List of parameters as Strings or SearchQuerys.
int	getSlop()
String	getText()
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, getSubClauses

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

PhraseQuery

public PhraseQuery(String fieldName,
                   String text,
                   int slop,
                   AnalyzerDescriptorProvider analyzerDescriptorProvider,
                   float boost)

Create a query which matches by phrases. Text can be analysed prior to search.

Parameters:

fieldName - the name of the field to query

text - the phrase for matching on the field value

slop - the maximum allowable edit distance of the field value to match the text

analyzerDescriptorProvider - description of how to analyse the text before search. Remaining terms from analysis are positionally incremented by 1 in left to right order.

boost - boost to the scores of matching documents

Since:

8.7

PhraseQuery

public PhraseQuery(String fieldName,
                   String text,
                   int slop,
                   AnalyzerDescriptorProvider analyzerDescriptorProvider)

Create a query which matches by phrases. Text can be analysed prior to search.

Parameters:

fieldName - the name of the field to query

text - the phrase for matching on the field value

slop - the maximum allowable edit distance of the field value to match the text

analyzerDescriptorProvider - description of how to analyse the text before search. Remaining terms from analysis are positionally incremented by 1 in left to right order.

PhraseQuery

public PhraseQuery(String fieldName,
                   String text,
                   int slop)

Create a query which matches by phrases. Text is analysed by Confluence specified analysis prior to search.

Parameters:

fieldName - the name of the field to query

text - the phrase for matching on the field value

slop - the maximum allowable edit distance of the field value to match the text

Method Detail

getFieldName

public String getFieldName()

getSlop

public int getSlop()

getAnalyzerDescriptorProvider

public AnalyzerDescriptorProvider getAnalyzerDescriptorProvider()

Since:

8.0

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.

getText

public String getText()

getBoost

public float getBoost()

Description copied from interface: SearchQuery

Return boost factor of this query. It will take effect when the query is used in combination with others e.g. in BooleanQuery.

Specified by:

getBoost in interface SearchQuery

Returns:

boost factor

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object