Package org.opensearch.join.query

Class HasChildQueryBuilder

java.lang.Object

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

org.opensearch.join.query.HasChildQueryBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>

public class HasChildQueryBuilder
extends AbstractQueryBuilder<HasChildQueryBuilder>

A query builder for has_child query.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

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

Fields inherited from class org.opensearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

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

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
HasChildQueryBuilder(String type, QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode)
HasChildQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
String	childType()	Returns the child type
protected boolean	doEquals(HasChildQueryBuilder that)
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryShardContext)
protected org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
protected void	doXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
protected void	extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)
static HasChildQueryBuilder	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
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.
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)
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.
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.

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

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, equals, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

Methods inherited from class java.lang.Object

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

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

visit

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final 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 Details

HasChildQueryBuilder

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

HasChildQueryBuilder

public HasChildQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                     throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<HasChildQueryBuilder>

Throws:

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)

query

public QueryBuilder query()

Returns the children query to execute.

childType

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

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 2147483647

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(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<HasChildQueryBuilder>

Throws:

IOException

fromXContent

public static HasChildQueryBuilder fromXContent(org.opensearch.core.xcontent.XContentParser parser)
                                         throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<HasChildQueryBuilder>

Throws:

IOException

doEquals

protected boolean doEquals(HasChildQueryBuilder that)

Specified by:

doEquals in class AbstractQueryBuilder<HasChildQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<HasChildQueryBuilder>

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryShardContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<HasChildQueryBuilder>

Throws:

IOException

extractInnerHitBuilders

protected void extractInnerHitBuilders(Map<String,InnerHitContextBuilder> innerHits)

Overrides:

extractInnerHitBuilders in class AbstractQueryBuilder<HasChildQueryBuilder>