Module org.elasticsearch.server

Package org.elasticsearch.search.builder

Class SubSearchSourceBuilder

java.lang.Object

org.elasticsearch.search.builder.SubSearchSourceBuilder

All Implemented Interfaces:

Writeable, Rewriteable<SubSearchSourceBuilder>, ToXContent

public class SubSearchSourceBuilder
extends Object
implements ToXContent, Writeable, Rewriteable<SubSearchSourceBuilder>

SearchQueryBuilder is a wrapper class for containing all the information required to perform a single search query as part of a series of multiple queries for features like ranking. It's expected to typically be used as part of a List.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

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

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SubSearchSourceBuilder(StreamInput in)
SubSearchSourceBuilder(QueryBuilder queryBuilder)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SubSearchSourceBuilder	fromXContent(XContentParser parser, SearchUsage searchUsage)
QueryBuilder	getQueryBuilder()
int	hashCode()
boolean	isFragment()
SubSearchSourceBuilder	rewrite(QueryRewriteContext ctx)	Rewrites this instance based on the provided context.
org.apache.lucene.search.Query	toSearchQuery(SearchExecutionContext context)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Constructor Details

SubSearchSourceBuilder

public SubSearchSourceBuilder(QueryBuilder queryBuilder)

SubSearchSourceBuilder

public SubSearchSourceBuilder(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

fromXContent

public static SubSearchSourceBuilder fromXContent(XContentParser parser,
 SearchUsage searchUsage)
                                           throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

isFragment

public boolean isFragment()

Specified by:

isFragment in interface ToXContent

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

rewrite

public SubSearchSourceBuilder rewrite(QueryRewriteContext ctx)
                               throws IOException

Description copied from interface: Rewriteable

Rewrites this instance based on the provided context. The returned objects will be the same instance as this if no changes during the rewrite were applied.

Specified by:

rewrite in interface Rewriteable<SubSearchSourceBuilder>

Throws:

IOException

getQueryBuilder

public QueryBuilder getQueryBuilder()

toSearchQuery

public org.apache.lucene.search.Query toSearchQuery(SearchExecutionContext context)
                                             throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object