org.elasticsearch.index.query

Class HasParentQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.HasParentQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder

public class HasParentQueryBuilder
extends AbstractQueryBuilder<HasParentQueryBuilder>

Builder for the 'has_parent' query.

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

Constructor Summary

Constructors

Constructor and Description
HasParentQueryBuilder(StreamInput in) Read from a stream.
HasParentQueryBuilder(java.lang.String type, QueryBuilder query, boolean score)

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(HasParentQueryBuilder that) Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryShardContext)
protected org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
protected void	extractInnerHitBuilders(java.util.Map<java.lang.String,InnerHitBuilder> innerHits) For internal usage only! Extracts the inner hits from the query tree.
static java.util.Optional<HasParentQueryBuilder>	fromXContent(QueryParseContext parseContext)
java.lang.String	getWriteableName() Returns the name of the writeable object
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.
HasParentQueryBuilder	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.
InnerHitBuilder	innerHit() Returns inner hit definition in the scope of this query and reusing the defined type and query.
HasParentQueryBuilder	innerHit(InnerHitBuilder innerHit, boolean ignoreUnmapped)
QueryBuilder	query() Returns the query to execute.
boolean	score() Returns true if the parent score is mapped into the child documents
java.lang.String	type() Returns the parents type name

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, declareStandardFields, equals, 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

rewriteQuery

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

isFragment

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

HasParentQueryBuilder

public HasParentQueryBuilder(java.lang.String type,
                             QueryBuilder query,
                             boolean score)

HasParentQueryBuilder

public HasParentQueryBuilder(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<HasParentQueryBuilder>

Throws:

java.io.IOException

query

public QueryBuilder query()

Returns the query to execute.

score

public boolean score()

Returns true if the parent score is mapped into the child documents

type

public java.lang.String type()

Returns the parents type name

innerHit

public InnerHitBuilder innerHit()

Returns inner hit definition in the scope of this query and reusing the defined type and query.

innerHit

public HasParentQueryBuilder innerHit(InnerHitBuilder innerHit,
                                      boolean ignoreUnmapped)

ignoreUnmapped

public HasParentQueryBuilder 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.

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<HasParentQueryBuilder>

Throws:

java.io.IOException

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<HasParentQueryBuilder>

Throws:

java.io.IOException

fromXContent

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

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

doEquals

protected boolean doEquals(HasParentQueryBuilder that)

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<HasParentQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<HasParentQueryBuilder>

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryShardContext)
                          throws java.io.IOException

Overrides:

doRewrite in class AbstractQueryBuilder<HasParentQueryBuilder>

Throws:

java.io.IOException

extractInnerHitBuilders

protected void extractInnerHitBuilders(java.util.Map<java.lang.String,InnerHitBuilder> innerHits)

Description copied from class: AbstractQueryBuilder

For internal usage only! Extracts the inner hits from the query tree. While it extracts inner hits, child inner hits are inlined into the inner hit builder they belong to.

Overrides:

extractInnerHitBuilders in class AbstractQueryBuilder<HasParentQueryBuilder>