org.elasticsearch.join.query

Class ParentIdQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.join.query.ParentIdQueryBuilder

All Implemented Interfaces:

org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.index.query.QueryBuilder, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.index.query.QueryBuilder>

public final class ParentIdQueryBuilder
extends org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>

Nested Class Summary

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

org.elasticsearch.common.io.stream.Writeable.Reader<V>, org.elasticsearch.common.io.stream.Writeable.Writer<V>

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.Params

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_IGNORE_UNMAPPED The default value for ignore_unmapped.
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

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

MAX_REWRITE_ROUNDS

Constructor Summary

Constructors

Constructor and Description
ParentIdQueryBuilder(org.elasticsearch.common.io.stream.StreamInput in) Read from a stream.
ParentIdQueryBuilder(java.lang.String type, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(ParentIdQueryBuilder that)
protected int	doHashCode()
protected org.apache.lucene.search.Query	doToQuery(org.elasticsearch.index.query.QueryShardContext context)
protected void	doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out)
protected void	doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
static ParentIdQueryBuilder	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.String	getId()
java.lang.String	getType()
java.lang.String	getWriteableName()
boolean	ignoreUnmapped() Gets whether the query builder will ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.
ParentIdQueryBuilder	ignoreUnmapped(boolean ignoreUnmapped) Sets whether the query builder should ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, 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.common.xcontent.ToXContentObject

isFragment

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

rewrite, rewrite, rewrite, rewriteAndFetch, rewriteAndFetch

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DEFAULT_IGNORE_UNMAPPED

public static final boolean DEFAULT_IGNORE_UNMAPPED

The default value for ignore_unmapped.

See Also:

Constant Field Values

Constructor Detail

ParentIdQueryBuilder

public ParentIdQueryBuilder(java.lang.String type,
                            java.lang.String id)

ParentIdQueryBuilder

public ParentIdQueryBuilder(org.elasticsearch.common.io.stream.StreamInput in)
                     throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>

Throws:

java.io.IOException

getType

public java.lang.String getType()

getId

public java.lang.String getId()

ignoreUnmapped

public ParentIdQueryBuilder ignoreUnmapped(boolean ignoreUnmapped)

Sets whether the query builder should ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.

ignoreUnmapped

public boolean ignoreUnmapped()

Gets whether the query builder will ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.

doXContent

protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
                          org.elasticsearch.common.xcontent.ToXContent.Params params)
                   throws java.io.IOException

Specified by:

doXContent in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static ParentIdQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
                                         throws java.io.IOException

Throws:

java.io.IOException

doToQuery

protected org.apache.lucene.search.Query doToQuery(org.elasticsearch.index.query.QueryShardContext context)
                                            throws java.io.IOException

Specified by:

doToQuery in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>

Throws:

java.io.IOException

doEquals

protected boolean doEquals(ParentIdQueryBuilder that)

Specified by:

doEquals in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>

getWriteableName

public java.lang.String getWriteableName()