Package org.elasticsearch.index.query

Class ExistsQueryBuilder

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<ExistsQueryBuilder>

org.elasticsearch.index.query.ExistsQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>

public class ExistsQueryBuilder
extends AbstractQueryBuilder<ExistsQueryBuilder>

Constructs a query that only match on documents that the field has a value in them.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static org.elasticsearch.common.xcontent.ParseField	FIELD_FIELD
static String	NAME

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ExistsQueryBuilder(String fieldName)
ExistsQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(ExistsQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
String	fieldName()
static ExistsQueryBuilder	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
String	getWriteableName()	Returns the name of the writeable object
static org.apache.lucene.search.Query	newFilter(SearchExecutionContext context, String fieldPattern, boolean checkRewrite)

Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

Constant Field Values

FIELD_FIELD

public static final org.elasticsearch.common.xcontent.ParseField FIELD_FIELD

Constructor Details

ExistsQueryBuilder

public ExistsQueryBuilder(String fieldName)

ExistsQueryBuilder

public ExistsQueryBuilder(StreamInput in)
                   throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<ExistsQueryBuilder>

Throws:

IOException

fieldName

public String fieldName()

Returns:

the field name that has to exist for this query to match

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<ExistsQueryBuilder>

Throws:

IOException

doXContent

protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<ExistsQueryBuilder>

Throws:

IOException

fromXContent

public static ExistsQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
                                       throws IOException

Throws:

IOException

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<ExistsQueryBuilder>

Throws:

IOException

newFilter

public static org.apache.lucene.search.Query newFilter(SearchExecutionContext context,
 String fieldPattern,
 boolean checkRewrite)

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<ExistsQueryBuilder>

doEquals

protected boolean doEquals(ExistsQueryBuilder other)

Description copied from class: AbstractQueryBuilder

Indicates whether some other QueryBuilder object of the same type is "equal to" this one.

Specified by:

doEquals in class AbstractQueryBuilder<ExistsQueryBuilder>

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object