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>
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.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.common.xcontent.ToXContent
EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionWrapperQueryBuilder(byte[] source)Creates a query builder given a query provided as a bytes arrayWrapperQueryBuilder(String source)Creates a query builder given a query provided as a stringWrapperQueryBuilder(BytesReference source)Creates a query builder given a query provided as aBytesReferenceRead from a stream. -
Method Summary
Modifier and TypeMethodDescriptionprotected booleandoEquals(WrapperQueryBuilder other)Indicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intprotected QueryBuilderdoRewrite(QueryRewriteContext context)protected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context)protected voiddoWriteTo(StreamOutput out)protected voiddoXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)static WrapperQueryBuilderfromXContent(org.elasticsearch.common.xcontent.XContentParser parser)getName()Returns the name that identifies uniquely the queryReturns 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, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
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
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:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<WrapperQueryBuilder>- Throws:
IOException
-
source
public byte[] source() -
getName
Description copied from interface:QueryBuilderReturns the name that identifies uniquely the query- Specified by:
getNamein interfaceQueryBuilder- Overrides:
getNamein classAbstractQueryBuilder<WrapperQueryBuilder>
-
doXContent
protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException- Specified by:
doXContentin classAbstractQueryBuilder<WrapperQueryBuilder>- Throws:
IOException
-
fromXContent
public static WrapperQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws IOException- Throws:
IOException
-
getWriteableName
Description copied from interface:NamedWriteableReturns the name of the writeable object -
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException- Specified by:
doToQueryin classAbstractQueryBuilder<WrapperQueryBuilder>- Throws:
IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<WrapperQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<WrapperQueryBuilder>
-
doRewrite
- Overrides:
doRewritein classAbstractQueryBuilder<WrapperQueryBuilder>- Throws:
IOException
-