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

java.lang.Object
  extended by com.atlassian.confluence.search.v2.query.TextFieldPrefixQuery
All Implemented Interfaces:
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
TextFieldPrefixQuery(String fieldName, String prefix)
          Construct a new TextFieldPrefixQuery.
 
Method Summary
 boolean equals(Object obj)
           
 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()

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


Copyright © 2003-2012 Atlassian. All Rights Reserved.