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

Class FieldExistsQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.FieldExistsQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

@SearchPrimitive
public class FieldExistsQuery
extends Object
implements SearchQuery

A V2 SearchQuery implementation which finds documents which contain a specific field.

Since:

7.20

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
FieldExistsQuery(String fieldName)
FieldExistsQuery(String fieldName, boolean isNegate)	Creates a SearchQuery which finds documents that do not contain a specific field.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static FieldExistsQuery	fieldNotExistsQuery(String fieldName)
String	getFieldName()
String	getKey()
List	getParameters()	List of parameters as Strings or SearchQuerys.
int	hashCode()
boolean	isNegate()

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, getBoost, getSubClauses

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

FieldExistsQuery

public FieldExistsQuery(String fieldName,
                        boolean isNegate)

Creates a SearchQuery which finds documents that do not contain a specific field. Can be negated.

Parameters:

fieldName - the name of the field which must exist on the found documents.

isNegate - negates the query iff true. Negation will find documents that do not contain a specific field.

FieldExistsQuery

public FieldExistsQuery(String fieldName)

Method Detail

fieldNotExistsQuery

public static FieldExistsQuery fieldNotExistsQuery(String fieldName)

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()

isNegate

public boolean isNegate()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object