java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<PrefixQueryBuilder>
org.elasticsearch.index.query.PrefixQueryBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,MultiTermQueryBuilder,QueryBuilder,Rewriteable<QueryBuilder>,ToXContent,ToXContentObject
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.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionPrefixQueryBuilder(String fieldName, String value) A Query that matches documents containing terms with a specified prefix.Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionbooleancaseInsensitive(boolean caseInsensitive) protected QueryBuilderdoCoordinatorRewrite(CoordinatorRewriteContext coordinatorRewriteContext) protected booleandoEquals(PrefixQueryBuilder other) Indicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected final intprotected QueryBuilderOptional rewrite logic that only needs access to index level metadata and services (e.g.protected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context) protected voiddoWriteTo(StreamOutput out) voiddoXContent(XContentBuilder builder, ToXContent.Params params) Get the field name for this query.static PrefixQueryBuilderfromXContent(XContentParser parser) The minimal version of the recipient this object can be sent to.Returns the name of the writeable objectrewrite()value()Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doInnerHitsRewrite, doRewrite, doSearchRewrite, equals, extractInnerHitBuilders, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.index.query.QueryBuilder
boost, boost, getName, queryName, queryName, rewrite, toQueryMethods inherited from interface org.elasticsearch.xcontent.ToXContent
toXContentMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragmentMethods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable
supportsVersion
-
Field Details
-
NAME
- See Also:
-
DEFAULT_CASE_INSENSITIVITY
public static final boolean DEFAULT_CASE_INSENSITIVITY- See Also:
-
-
Constructor Details
-
PrefixQueryBuilder
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:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<PrefixQueryBuilder>- Throws:
IOException
-
fieldName
Description copied from interface:MultiTermQueryBuilderGet the field name for this query.- Specified by:
fieldNamein interfaceMultiTermQueryBuilder
-
value
-
caseInsensitive
-
caseInsensitive
public boolean caseInsensitive() -
rewrite
-
rewrite
-
doXContent
- Specified by:
doXContentin classAbstractQueryBuilder<PrefixQueryBuilder>- Throws:
IOException
-
fromXContent
- Throws:
IOException
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object- Specified by:
getWriteableNamein interfaceNamedWriteable- Specified by:
getWriteableNamein interfaceVersionedNamedWriteable
-
doIndexMetadataRewrite
Description copied from class:AbstractQueryBuilderOptional rewrite logic that only needs access to index level metadata and services (e.g. index settings and mappings) on the data node, but not the shard / Lucene index. The can_match phase can use this logic to early terminate a search without doing any search related i/o.- Overrides:
doIndexMetadataRewritein classAbstractQueryBuilder<PrefixQueryBuilder>- Parameters:
context- anQueryRewriteContextinstance that has access the mappings and other index metadata- Returns:
- A
QueryBuilderrepresenting the rewritten query, that could be used to determine whether this query yields result.
-
doCoordinatorRewrite
- Overrides:
doCoordinatorRewritein classAbstractQueryBuilder<PrefixQueryBuilder>- Parameters:
coordinatorRewriteContext- AQueryRewriteContextthat enables limited rewrite capabilities happening on the coordinator node before execution moves to the data node.- Returns:
- A
QueryBuilderrepresenting the rewritten query which could be executed without going to the date node.
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQueryin classAbstractQueryBuilder<PrefixQueryBuilder>- Throws:
IOException
-
doHashCode
protected final int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<PrefixQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<PrefixQueryBuilder>
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to. SeeVersionedNamedWriteable.supportsVersion(TransportVersion)for the default serialization check.- Specified by:
getMinimalSupportedVersionin interfaceVersionedNamedWriteable
-