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
,ToXContent
,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
ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 ParseField
FIELD_FIELD
static java.lang.String
NAME
Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
-
Constructor Summary
Constructors Constructor Description ExistsQueryBuilder(java.lang.String fieldName)
ExistsQueryBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description protected boolean
doEquals(ExistsQueryBuilder other)
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.protected int
doHashCode()
protected org.apache.lucene.search.Query
doToQuery(QueryShardContext context)
protected void
doWriteTo(StreamOutput out)
protected void
doXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String
fieldName()
static ExistsQueryBuilder
fromXContent(XContentParser parser)
java.lang.String
getWriteableName()
Returns the name of the writeable objectstatic org.apache.lucene.search.Query
newFilter(QueryShardContext context, java.lang.String fieldPattern)
Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
FIELD_FIELD
-
-
Constructor Details
-
ExistsQueryBuilder
public ExistsQueryBuilder(java.lang.String fieldName) -
ExistsQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<ExistsQueryBuilder>
- Throws:
java.io.IOException
-
fieldName
public java.lang.String fieldName()- Returns:
- the field name that has to exist for this query to match
-
doXContent
protected void doXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<ExistsQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
- Throws:
java.io.IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<ExistsQueryBuilder>
- Throws:
java.io.IOException
-
newFilter
public static org.apache.lucene.search.Query newFilter(QueryShardContext context, java.lang.String fieldPattern) -
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<ExistsQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Specified by:
doEquals
in classAbstractQueryBuilder<ExistsQueryBuilder>
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object
-