Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class InterceptedQueryBuilderWrapper

java.lang.Object

org.elasticsearch.index.query.InterceptedQueryBuilderWrapper

All Implemented Interfaces:

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

public class InterceptedQueryBuilderWrapper
extends Object
implements QueryBuilder

Wrapper for instances of QueryBuilder that have been intercepted using the QueryRewriteInterceptor to break out of the rewrite phase. These instances are unwrapped on serialization.

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

Modifier and Type	Field	Description
protected final QueryBuilder	queryBuilder

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
InterceptedQueryBuilderWrapper(QueryBuilder queryBuilder)

Method Summary

Modifier and Type	Method	Description
float	boost()	Returns the boost for this query.
QueryBuilder	boost(float boost)	Sets the boost for this query.
boolean	equals(Object o)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to.
String	getName()	Returns the name that identifies uniquely the query
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
QueryBuilder	query()
String	queryName()	Returns the arbitrary name assigned to the query (see named queries).
QueryBuilder	queryName(String queryName)	Sets the arbitrary name to be assigned to the query (see named queries).
QueryBuilder	rewrite(QueryRewriteContext queryRewriteContext)	Rewrites this query builder into its primitive form.
org.apache.lucene.search.Query	toQuery(SearchExecutionContext context)	Converts this QueryBuilder to a lucene Query.
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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

queryBuilder

protected final QueryBuilder queryBuilder

Constructor Details

InterceptedQueryBuilderWrapper

public InterceptedQueryBuilderWrapper(QueryBuilder queryBuilder)

Method Details

query

public QueryBuilder query()

rewrite

public QueryBuilder rewrite(QueryRewriteContext queryRewriteContext)
                     throws IOException

Description copied from interface: QueryBuilder

Rewrites this query builder into its primitive form. By default this method return the builder itself. If the builder did not change the identity reference must be returned otherwise the builder will be rewritten infinitely.

Specified by:

rewrite in interface QueryBuilder

Specified by:

rewrite in interface Rewriteable<QueryBuilder>

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to. See VersionedNamedWriteable.supportsVersion(TransportVersion) for the default serialization check.

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

toQuery

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

Description copied from interface: QueryBuilder

Converts this QueryBuilder to a lucene Query. Returns null if this query should be ignored in the context of parent queries.

Specified by:

toQuery in interface QueryBuilder

Parameters:

context - additional information needed to construct the queries

Returns:

the Query or null if this query should be ignored upstream

Throws:

IOException

queryName

public QueryBuilder queryName(String queryName)

Description copied from interface: QueryBuilder

Sets the arbitrary name to be assigned to the query (see named queries). Implementers should return the concrete type of the QueryBuilder so that calls can be chained. This is done automatically when extending AbstractQueryBuilder.

Specified by:

queryName in interface QueryBuilder

queryName

public String queryName()

Description copied from interface: QueryBuilder

Returns the arbitrary name assigned to the query (see named queries).

Specified by:

queryName in interface QueryBuilder

boost

public float boost()

Description copied from interface: QueryBuilder

Returns the boost for this query.

Specified by:

boost in interface QueryBuilder

boost

public QueryBuilder boost(float boost)

Description copied from interface: QueryBuilder

Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided. Implementers should return the concrete type of the QueryBuilder so that calls can be chained. This is done automatically when extending AbstractQueryBuilder.

Specified by:

boost in interface QueryBuilder

getName

public String getName()

Description copied from interface: QueryBuilder

Returns the name that identifies uniquely the query

Specified by:

getName in interface QueryBuilder

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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object