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

java.lang.Object
  com.atlassian.confluence.search.v2.query.TextFieldPrefixQuery

All Implemented Interfaces:

SearchQuery

public class TextFieldPrefixQuery
extends java.lang.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

TextFieldPrefixQuery(java.lang.String fieldName, java.lang.String prefix)
Construct a new TextFieldPrefixQuery.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getFieldName()
java.lang.String	getKey()
java.util.List	getParameters() List of parameters as Strings or SearchQuerys.
java.lang.String	getPrefix()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFieldPrefixQuery

public TextFieldPrefixQuery(java.lang.String fieldName,
                            java.lang.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 java.lang.String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

getParameters

public java.util.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 java.lang.String getFieldName()

getPrefix

public java.lang.String getPrefix()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object