Package org.elasticsearch.index.query
Class TermQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<QB>
org.elasticsearch.index.query.BaseTermQueryBuilder<TermQueryBuilder>
org.elasticsearch.index.query.TermQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
public class TermQueryBuilder extends BaseTermQueryBuilder<TermQueryBuilder>
A Query that matches documents containing a term.
-
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 boolean
DEFAULT_CASE_INSENSITIVITY
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 TermQueryBuilder(java.lang.String fieldName, boolean value)
TermQueryBuilder(java.lang.String fieldName, double value)
TermQueryBuilder(java.lang.String fieldName, float value)
TermQueryBuilder(java.lang.String fieldName, int value)
TermQueryBuilder(java.lang.String fieldName, long value)
TermQueryBuilder(java.lang.String fieldName, java.lang.Object value)
TermQueryBuilder(java.lang.String fieldName, java.lang.String value)
TermQueryBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description protected void
addExtraXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
boolean
caseInsensitive()
TermQueryBuilder
caseInsensitive(boolean caseInsensitive)
protected boolean
doEquals(TermQueryBuilder other)
Indicates whether some otherQueryBuilder
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(QueryShardContext context)
protected void
doWriteTo(StreamOutput out)
static TermQueryBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.String
getWriteableName()
Returns the name of the writeable objectMethods inherited from class org.elasticsearch.index.query.BaseTermQueryBuilder
doXContent, fieldName, value
Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, 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
-
DEFAULT_CASE_INSENSITIVITY
public static final boolean DEFAULT_CASE_INSENSITIVITY- See Also:
- Constant Field Values
-
-
Constructor Details
-
TermQueryBuilder
public TermQueryBuilder(java.lang.String fieldName, java.lang.String value)- See Also:
BaseTermQueryBuilder(String, String)
-
TermQueryBuilder
public TermQueryBuilder(java.lang.String fieldName, int value)- See Also:
BaseTermQueryBuilder(String, int)
-
TermQueryBuilder
public TermQueryBuilder(java.lang.String fieldName, long value)- See Also:
BaseTermQueryBuilder(String, long)
-
TermQueryBuilder
public TermQueryBuilder(java.lang.String fieldName, float value)- See Also:
BaseTermQueryBuilder(String, float)
-
TermQueryBuilder
public TermQueryBuilder(java.lang.String fieldName, double value)- See Also:
BaseTermQueryBuilder(String, double)
-
TermQueryBuilder
public TermQueryBuilder(java.lang.String fieldName, boolean value)- See Also:
BaseTermQueryBuilder(String, boolean)
-
TermQueryBuilder
public TermQueryBuilder(java.lang.String fieldName, java.lang.Object value)- See Also:
BaseTermQueryBuilder(String, Object)
-
TermQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
caseInsensitive
-
caseInsensitive
public boolean caseInsensitive() -
doWriteTo
- Overrides:
doWriteTo
in classBaseTermQueryBuilder<TermQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static TermQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
addExtraXContent
protected void addExtraXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Overrides:
addExtraXContent
in classBaseTermQueryBuilder<TermQueryBuilder>
- Throws:
java.io.IOException
-
doRewrite
protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext) throws java.io.IOException- Overrides:
doRewrite
in classAbstractQueryBuilder<TermQueryBuilder>
- Throws:
java.io.IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<TermQueryBuilder>
- Throws:
java.io.IOException
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
doHashCode
protected final int doHashCode()- Overrides:
doHashCode
in classBaseTermQueryBuilder<TermQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Overrides:
doEquals
in classBaseTermQueryBuilder<TermQueryBuilder>
-