com.atlassian.confluence.search.v2.query

Class TextFieldPrefixQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.TextFieldPrefixQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class TextFieldPrefixQuery
extends Object
implements SearchQuery

Represents a query that specifies a prefix to be matched - equivalent to a trailing wildcard search e.g. 'app' will match 'apple'

Note: Using this query means that you know the name of fields within you 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 TextFieldPrefixQuery part of the public search API.

Constructor Summary

Constructors

Constructor and Description
TextFieldPrefixQuery(String fieldName, String prefix) Construct a new TextFieldPrefixQuery.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
SearchQuery	expand() Expands this query into a composite query (that composes other queries).
String	getFieldName()
String	getKey()
List	getParameters() List of parameters as Strings or SearchQuerys.
String	getPrefix()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextFieldPrefixQuery

public TextFieldPrefixQuery(String fieldName,
                            String prefix)

Construct a new TextFieldPrefixQuery.

Parameters:

fieldName - the index field to apply this query on

prefix - the prefix being searched for

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.

getFieldName

public String getFieldName()

getPrefix

public String getPrefix()

expand

public SearchQuery expand()

Description copied from interface: SearchQuery

Expands this query into a composite query (that composes other queries). By overriding this method, one can specify a new query that is composition of the behaviour of the composed queries.

Specified by:

expand in interface Expandable<SearchQuery>

Specified by:

expand in interface SearchQuery

Returns:

a query

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object