Package org.elasticsearch.index.query
Class PrefixQueryBuilder
org.elasticsearch.index.query.AbstractQueryBuilder<PrefixQueryBuilder>
org.elasticsearch.index.query.PrefixQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,MultiTermQueryBuilder
,QueryBuilder
,Rewriteable<QueryBuilder>
public class PrefixQueryBuilder
extends AbstractQueryBuilder<PrefixQueryBuilder>
implements MultiTermQueryBuilder
A Query that matches documents containing terms with a specified prefix.
-
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 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
ConstructorDescriptionfieldName, value)
A Query that matches documents containing terms with a specified prefix.Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionboolean
caseInsensitive(boolean caseInsensitive)
protected boolean
doEquals(PrefixQueryBuilder other)
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.protected int
protected QueryBuilder
doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query
doToQuery(SearchExecutionContext context)
protected void
doWriteTo(StreamOutput out)
void
doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
Get the field name for this query.static PrefixQueryBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
Returns the name of the writeable objectrewrite()
rewrite)
value()
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.
, , , , , , ,
Methods inherited from interface org.elasticsearch.index.query.QueryBuilder
boost, boost, getName, queryName, queryName, rewrite, toQuery
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent
toXContent
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
public static final NAME- See Also:
- Constant Field Values
-
DEFAULT_CASE_INSENSITIVITY
public static final boolean DEFAULT_CASE_INSENSITIVITY- See Also:
- Constant Field Values
-
-
Constructor Details
-
PrefixQueryBuilder
public PrefixQueryBuilder( fieldName, value)A Query that matches documents containing terms with a specified prefix.- Parameters:
fieldName
- The name of the fieldvalue
- The prefix query
-
PrefixQueryBuilder
Read from a stream.- Throws:
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<PrefixQueryBuilder>
- Throws:
-
fieldName
public fieldName()Description copied from interface:MultiTermQueryBuilder
Get the field name for this query.- Specified by:
fieldName
in interfaceMultiTermQueryBuilder
-
value
public value() -
caseInsensitive
-
caseInsensitive
public boolean caseInsensitive() -
rewrite
public rewrite) -
rewrite
public rewrite() -
doXContent
public void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws- Specified by:
doXContent
in classAbstractQueryBuilder<PrefixQueryBuilder>
- Throws:
-
fromXContent
public static PrefixQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws- Throws:
-
getWriteableName
public getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
-
doRewrite
- Overrides:
doRewrite
in classAbstractQueryBuilder<PrefixQueryBuilder>
- Throws:
-
doToQuery
- Specified by:
doToQuery
in classAbstractQueryBuilder<PrefixQueryBuilder>
- Throws:
-
doHashCode
protected final int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<PrefixQueryBuilder>
-
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<PrefixQueryBuilder>
-