org.elasticsearch.index.query

Class IdsQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.IdsQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder

public class IdsQueryBuilder
extends AbstractQueryBuilder<IdsQueryBuilder>

A query that will return only documents matching specific ids (and a type).

Nested Class Summary

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

Writeable.Reader<R>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
static ParseField	QUERY_NAME_FIELD

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

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
IdsQueryBuilder() Creates a new IdsQueryBuilder without providing the types of the documents to look for
IdsQueryBuilder(StreamInput in) Read from a stream.
IdsQueryBuilder(java.lang.String... types) Creates a new IdsQueryBuilder by providing the types of the documents to look for

Method Summary

Modifier and Type	Method and Description
IdsQueryBuilder	addIds(java.lang.String... ids) Adds ids to the query.
protected boolean	doEquals(IdsQueryBuilder other) Indicates whether some other QueryBuilder 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)
static IdsQueryBuilder	fromXContent(QueryParseContext parseContext)
java.lang.String	getWriteableName() Returns the name of the writeable object
java.util.Set<java.lang.String>	ids() Returns the ids for the query.
java.lang.String[]	types() Returns the types used in this query

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, toFilter, toQueries, toQuery, toXContent, writeQueries, writeTo

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.index.query.QueryBuilder

rewriteQuery

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

QUERY_NAME_FIELD

public static final ParseField QUERY_NAME_FIELD

Constructor Detail

IdsQueryBuilder

public IdsQueryBuilder()

Creates a new IdsQueryBuilder without providing the types of the documents to look for

IdsQueryBuilder

public IdsQueryBuilder(java.lang.String... types)

Creates a new IdsQueryBuilder by providing the types of the documents to look for

IdsQueryBuilder

public IdsQueryBuilder(StreamInput in)
                throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<IdsQueryBuilder>

Throws:

java.io.IOException

types

public java.lang.String[] types()

Returns the types used in this query

addIds

public IdsQueryBuilder addIds(java.lang.String... ids)

Adds ids to the query.

ids

public java.util.Set<java.lang.String> ids()

Returns the ids for the query.

doXContent

protected void doXContent(XContentBuilder builder,
                          ToXContent.Params params)
                   throws java.io.IOException

Specified by:

doXContent in class AbstractQueryBuilder<IdsQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static IdsQueryBuilder fromXContent(QueryParseContext parseContext)
                                    throws java.io.IOException

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

doToQuery

protected org.apache.lucene.search.Query doToQuery(QueryShardContext context)
                                            throws java.io.IOException

Specified by:

doToQuery in class AbstractQueryBuilder<IdsQueryBuilder>

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<IdsQueryBuilder>

doEquals

protected boolean doEquals(IdsQueryBuilder 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<IdsQueryBuilder>