org.elasticsearch.index.query

Class HasChildQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.HasChildQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder

public class HasChildQueryBuilder
extends AbstractQueryBuilder<HasChildQueryBuilder>

A query builder for has_child query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HasChildQueryBuilder.LateParsingQuery A query that rewrites into another query using JoinUtil.createJoinQuery(String, Query, Query, IndexSearcher, ScoreMode, MultiDocValues.OrdinalMap, int, int) that executes the actual join.

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 int	DEFAULT_MAX_CHILDREN The default maximum number of children that are required to match for the parent to be considered a match.
static int	DEFAULT_MIN_CHILDREN The default minimum number of children that are required to match for the parent to be considered a match.
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
HasChildQueryBuilder(StreamInput in) Read from a stream.
HasChildQueryBuilder(java.lang.String type, QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode)

Method Summary

Modifier and Type	Method and Description
java.lang.String	childType() Returns the child type
protected boolean	doEquals(HasChildQueryBuilder that) Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
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<HasChildQueryBuilder>	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.
HasChildQueryBuilder	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.
HasChildQueryBuilder	innerHit(InnerHitBuilder innerHit, boolean ignoreUnmapped)
int	maxChildren() Returns the maximum number of children that are required to match for the parent to be considered a match.
int	minChildren() Returns the minimum number of children that are required to match for the parent to be considered a match.
HasChildQueryBuilder	minMaxChildren(int minChildren, int maxChildren) Defines the minimum number of children that are required to match for the parent to be considered a match and the maximum number of children that are required to match for the parent to be considered a match.
static org.apache.lucene.search.join.ScoreMode	parseScoreMode(java.lang.String scoreModeString)
QueryBuilder	query() Returns the children query to execute.
org.apache.lucene.search.join.ScoreMode	scoreMode() Returns how the scores from the matching child documents are mapped into the parent document.
static java.lang.String	scoreModeAsString(org.apache.lucene.search.join.ScoreMode scoreMode)

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_MAX_CHILDREN

public static final int DEFAULT_MAX_CHILDREN

The default maximum number of children that are required to match for the parent to be considered a match.

See Also:

Constant Field Values

DEFAULT_MIN_CHILDREN

public static final int DEFAULT_MIN_CHILDREN

The default minimum number of children that are required to match for the parent to be considered a match.

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

HasChildQueryBuilder

public HasChildQueryBuilder(java.lang.String type,
                            QueryBuilder query,
                            org.apache.lucene.search.join.ScoreMode scoreMode)

HasChildQueryBuilder

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

Throws:

java.io.IOException

minMaxChildren

public HasChildQueryBuilder minMaxChildren(int minChildren,
                                           int maxChildren)

Defines the minimum number of children that are required to match for the parent to be considered a match and the maximum number of children that are required to match for the parent to be considered a match.

innerHit

public InnerHitBuilder innerHit()

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

innerHit

public HasChildQueryBuilder innerHit(InnerHitBuilder innerHit,
                                     boolean ignoreUnmapped)

query

public QueryBuilder query()

Returns the children query to execute.

childType

public java.lang.String childType()

Returns the child type

scoreMode

public org.apache.lucene.search.join.ScoreMode scoreMode()

Returns how the scores from the matching child documents are mapped into the parent document.

minChildren

public int minChildren()

Returns the minimum number of children that are required to match for the parent to be considered a match. The default is 2147483647

maxChildren

public int maxChildren()

Returns the maximum number of children that are required to match for the parent to be considered a match. The default is 0

ignoreUnmapped

public HasChildQueryBuilder 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(XContentBuilder builder,
                          ToXContent.Params params)
                   throws java.io.IOException

Specified by:

doXContent in class AbstractQueryBuilder<HasChildQueryBuilder>

Throws:

java.io.IOException

fromXContent

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

Throws:

java.io.IOException

parseScoreMode

public static org.apache.lucene.search.join.ScoreMode parseScoreMode(java.lang.String scoreModeString)

scoreModeAsString

public static java.lang.String scoreModeAsString(org.apache.lucene.search.join.ScoreMode scoreMode)

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<HasChildQueryBuilder>

Throws:

java.io.IOException

doEquals

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

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<HasChildQueryBuilder>

doRewrite

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

Overrides:

doRewrite in class AbstractQueryBuilder<HasChildQueryBuilder>

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