Package org.elasticsearch.join.query
Class HasChildQueryBuilder
- java.lang.Object
-
- org.elasticsearch.index.query.AbstractQueryBuilder<HasChildQueryBuilder>
-
- org.elasticsearch.join.query.HasChildQueryBuilder
-
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
public class HasChildQueryBuilder extends AbstractQueryBuilder<HasChildQueryBuilder>
A query builder forhas_child
query.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HasChildQueryBuilder.LateParsingQuery
A query that rewrites into another query usingJoinUtil.createJoinQuery(String, Query, Query, IndexSearcher, ScoreMode, OrdinalMap, int, int)
that executes the actual join.-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends java.lang.Object>, Writeable.Writer<V extends java.lang.Object>
-
-
Field Summary
Fields Modifier and Type Field 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.index.query.Rewriteable
MAX_REWRITE_ROUNDS
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description HasChildQueryBuilder(java.lang.String type, QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode)
HasChildQueryBuilder(StreamInput in)
Read from a stream.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
childType()
Returns the child typeprotected boolean
doEquals(HasChildQueryBuilder that)
protected int
doHashCode()
protected QueryBuilder
doRewrite(QueryRewriteContext queryShardContext)
protected 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,InnerHitContextBuilder> innerHits)
static HasChildQueryBuilder
fromXContent(XContentParser parser)
java.lang.String
getWriteableName()
boolean
ignoreUnmapped()
Gets whether the query builder will ignore unmapped types (and run aMatchNoDocsQuery
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 aMatchNoDocsQuery
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.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, declareStandardFields, equals, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQuery, toString, toXContent, writeTo
-
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
-
-
-
-
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 classAbstractQueryBuilder<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)
-
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 0
-
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 aMatchNoDocsQuery
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 aMatchNoDocsQuery
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 classAbstractQueryBuilder<HasChildQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static HasChildQueryBuilder fromXContent(XContentParser parser) throws java.io.IOException
- Throws:
java.io.IOException
-
getWriteableName
public java.lang.String getWriteableName()
-
doToQuery
protected Query doToQuery(QueryShardContext context) throws java.io.IOException
- Specified by:
doToQuery
in classAbstractQueryBuilder<HasChildQueryBuilder>
- Throws:
java.io.IOException
-
doEquals
protected boolean doEquals(HasChildQueryBuilder that)
- Specified by:
doEquals
in classAbstractQueryBuilder<HasChildQueryBuilder>
-
doHashCode
protected int doHashCode()
- Specified by:
doHashCode
in classAbstractQueryBuilder<HasChildQueryBuilder>
-
doRewrite
protected QueryBuilder doRewrite(QueryRewriteContext queryShardContext) throws java.io.IOException
- Overrides:
doRewrite
in classAbstractQueryBuilder<HasChildQueryBuilder>
- Throws:
java.io.IOException
-
extractInnerHitBuilders
protected void extractInnerHitBuilders(java.util.Map<java.lang.String,InnerHitContextBuilder> innerHits)
- Overrides:
extractInnerHitBuilders
in classAbstractQueryBuilder<HasChildQueryBuilder>
-
-