org.elasticsearch.index.query

Class FieldMaskingSpanQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.FieldMaskingSpanQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder, SpanQueryBuilder

public class FieldMaskingSpanQueryBuilder
extends AbstractQueryBuilder<FieldMaskingSpanQueryBuilder>
implements SpanQueryBuilder

Nested Class Summary

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

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

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and 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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.spans.SpanQuery	doToQuery(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	fieldName()
static java.util.Optional<FieldMaskingSpanQueryBuilder>	fromXContent(QueryParseContext parseContext)
java.lang.String	getWriteableName() Returns the name of the writeable object
SpanQueryBuilder	innerQuery()

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQueries, toQuery, toXContent, writeQueries, writeTo

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString, toString

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, rewriteQuery, toFilter, toQuery

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

writeTo

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

toXContent

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

FieldMaskingSpanQueryBuilder

public FieldMaskingSpanQueryBuilder(SpanQueryBuilder queryBuilder,
                                    java.lang.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 java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<FieldMaskingSpanQueryBuilder>

Throws:

java.io.IOException

fieldName

public java.lang.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 java.io.IOException

Specified by:

doXContent in class AbstractQueryBuilder<FieldMaskingSpanQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static java.util.Optional<FieldMaskingSpanQueryBuilder> fromXContent(QueryParseContext parseContext)
                                                                     throws java.io.IOException

Throws:

java.io.IOException

doToQuery

protected org.apache.lucene.search.spans.SpanQuery doToQuery(QueryShardContext context)
                                                      throws java.io.IOException

Specified by:

doToQuery in class AbstractQueryBuilder<FieldMaskingSpanQueryBuilder>

Throws:

java.io.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 java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable