org.elasticsearch.index.query

Class WrapperQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.WrapperQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>

public class WrapperQueryBuilder
extends AbstractQueryBuilder<WrapperQueryBuilder>

A Query builder which allows building a query given JSON string or binary data provided as input. This is useful when you want to use the Java Builder API but still have JSON query strings at hand that you want to combine with other query builders.

Example usage in a boolean query :

 
      BoolQueryBuilder bool = new BoolQueryBuilder();
      bool.must(new WrapperQueryBuilder("{\"term\": {\"field\":\"value\"}}");
      bool.must(new TermQueryBuilder("field2","value2");
 
 

Nested Class Summary

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

Writeable.Reader<V>, Writeable.Writer<V>

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

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

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Constructor Summary

Constructors

Constructor and Description
WrapperQueryBuilder(byte[] source) Creates a query builder given a query provided as a bytes array
WrapperQueryBuilder(BytesReference source) Creates a query builder given a query provided as a BytesReference
WrapperQueryBuilder(StreamInput in) Read from a stream.
WrapperQueryBuilder(java.lang.String source) Creates a query builder given a query provided as a string

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(WrapperQueryBuilder other) Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext context)
protected org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
static WrapperQueryBuilder	fromXContent(XContentParser parser)
java.lang.String	getName() Returns the name that identifies uniquely the query
java.lang.String	getWriteableName() Returns the name of the writeable object
byte[]	source()

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, declareStandardFields, equals, extractInnerHitBuilders, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQueries, toQuery, toXContent, writeQueries, writeTo

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

buildAsBytes, buildAsBytes, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

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

rewrite, rewrite, rewrite, rewriteAndFetch, rewriteAndFetch

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

WrapperQueryBuilder

public WrapperQueryBuilder(byte[] source)

Creates a query builder given a query provided as a bytes array

WrapperQueryBuilder

public WrapperQueryBuilder(java.lang.String source)

Creates a query builder given a query provided as a string

WrapperQueryBuilder

public WrapperQueryBuilder(BytesReference source)

Creates a query builder given a query provided as a BytesReference

WrapperQueryBuilder

public WrapperQueryBuilder(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<WrapperQueryBuilder>

Throws:

java.io.IOException

source

public byte[] source()

getName

public java.lang.String getName()

Description copied from interface: QueryBuilder

Returns the name that identifies uniquely the query

Specified by:

getName in interface QueryBuilder

Overrides:

getName in class AbstractQueryBuilder<WrapperQueryBuilder>

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<WrapperQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static WrapperQueryBuilder fromXContent(XContentParser parser)
                                        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<WrapperQueryBuilder>

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<WrapperQueryBuilder>

doEquals

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

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext context)
                          throws java.io.IOException

Overrides:

doRewrite in class AbstractQueryBuilder<WrapperQueryBuilder>

Throws:

java.io.IOException