Package org.elasticsearch.index.query
Class WrapperQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<WrapperQueryBuilder>
org.elasticsearch.index.query.WrapperQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.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.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 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.index.query.Rewriteable
MAX_REWRITE_ROUNDS
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description WrapperQueryBuilder(byte[] source)
Creates a query builder given a query provided as a bytes arrayWrapperQueryBuilder(java.lang.String source)
Creates a query builder given a query provided as a stringWrapperQueryBuilder(BytesReference source)
Creates a query builder given a query provided as aBytesReference
WrapperQueryBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description protected boolean
doEquals(WrapperQueryBuilder other)
Indicates whether some otherQueryBuilder
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(SearchExecutionContext context)
protected void
doWriteTo(StreamOutput out)
protected void
doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
static WrapperQueryBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.String
getName()
Returns the name that identifies uniquely the queryjava.lang.String
getWriteableName()
Returns the name of the writeable objectbyte[]
source()
Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, equals, extractInnerHitBuilders, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo
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
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
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
Creates a query builder given a query provided as aBytesReference
-
WrapperQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<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 interfaceQueryBuilder
- Overrides:
getName
in classAbstractQueryBuilder<WrapperQueryBuilder>
-
doXContent
protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<WrapperQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static WrapperQueryBuilder fromXContent(org.elasticsearch.common.xcontent.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(SearchExecutionContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<WrapperQueryBuilder>
- Throws:
java.io.IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<WrapperQueryBuilder>
-
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<WrapperQueryBuilder>
-
doRewrite
- Overrides:
doRewrite
in classAbstractQueryBuilder<WrapperQueryBuilder>
- Throws:
java.io.IOException
-