Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class FieldMaskingSpanQueryBuilder

java.lang.Object

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

org.elasticsearch.index.query.FieldMaskingSpanQueryBuilder

All Implemented Interfaces:

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

public class FieldMaskingSpanQueryBuilder
extends AbstractQueryBuilder<FieldMaskingSpanQueryBuilder>
implements SpanQueryBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.index.query.SpanQueryBuilder

SpanQueryBuilder.SpanQueryBuilderUtil

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
static final ParseField	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.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
FieldMaskingSpanQueryBuilder(StreamInput in)	Read from a stream.
FieldMaskingSpanQueryBuilder(SpanQueryBuilder queryBuilder, String fieldName)	Constructs a new FieldMaskingSpanQueryBuilder given an inner SpanQueryBuilder for a given field

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(FieldMaskingSpanQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
String	fieldName()
static FieldMaskingSpanQueryBuilder	fromXContent(XContentParser parser)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
SpanQueryBuilder	innerQuery()

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

addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeTo

Methods inherited from class java.lang.Object

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

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

boost, boost, getName, queryName, queryName, rewrite, toQuery

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

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

writeTo

Field Details

NAME

public static final ParseField NAME

Constructor Details

FieldMaskingSpanQueryBuilder

public FieldMaskingSpanQueryBuilder(SpanQueryBuilder queryBuilder,
 String fieldName)

Constructs a new FieldMaskingSpanQueryBuilder given an inner SpanQueryBuilder for a given field

Parameters:

queryBuilder - inner SpanQueryBuilder

fieldName - the field name

FieldMaskingSpanQueryBuilder

public FieldMaskingSpanQueryBuilder(StreamInput in)
                             throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<FieldMaskingSpanQueryBuilder>

Throws:

IOException

fieldName

public String fieldName()

Returns:

the field name for this query

innerQuery

public SpanQueryBuilder innerQuery()

Returns:

the inner QueryBuilder

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<FieldMaskingSpanQueryBuilder>

Throws:

IOException

fromXContent

public static FieldMaskingSpanQueryBuilder fromXContent(XContentParser parser)
                                                 throws IOException

Throws:

IOException

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<FieldMaskingSpanQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<FieldMaskingSpanQueryBuilder>

doEquals

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

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

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable