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
,QueryBuilder
,Rewriteable<QueryBuilder>
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
A query builder for
has_child
query.-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
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.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
The default value for ignore_unmapped.static final int
The default maximum number of children that are required to match for the parent to be considered a match.static final int
The default minimum number of children that are required to match for the parent to be considered a match.static final String
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.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionHasChildQueryBuilder
(String type, QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode) Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionReturns the child typeprotected boolean
doEquals
(HasChildQueryBuilder that) protected int
protected QueryBuilder
doRewrite
(QueryRewriteContext queryRewriteContext) protected org.apache.lucene.search.Query
doToQuery
(SearchExecutionContext context) protected void
doWriteTo
(StreamOutput out) protected void
doXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) protected void
extractInnerHitBuilders
(Map<String, InnerHitContextBuilder> innerHits) static HasChildQueryBuilder
fromXContent
(org.elasticsearch.xcontent.XContentParser parser) boolean
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.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.innerHit()
Returns inner hit definition in the scope of this query and reusing the defined type and query.innerHit
(InnerHitBuilder innerHit) int
Returns the maximum number of children that are required to match for the parent to be considered a match.int
Returns the minimum number of children that are required to match for the parent to be considered a match.minMaxChildren
(int min, int max) 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.query()
Returns the children query to execute.org.apache.lucene.search.join.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, checkNegativeBoost, declareStandardFields, equals, getName, hashCode, parseInnerQueryBuilder, 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.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
- See Also:
-
DEFAULT_MAX_CHILDREN
public static final int DEFAULT_MAX_CHILDRENThe default maximum number of children that are required to match for the parent to be considered a match.- See Also:
-
DEFAULT_MIN_CHILDREN
public static final int DEFAULT_MIN_CHILDRENThe default minimum number of children that are required to match for the parent to be considered a match.- See Also:
-
DEFAULT_IGNORE_UNMAPPED
public static final boolean DEFAULT_IGNORE_UNMAPPEDThe default value for ignore_unmapped.- See Also:
-
-
Constructor Details
-
HasChildQueryBuilder
public HasChildQueryBuilder(String type, QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode) -
HasChildQueryBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<HasChildQueryBuilder>
- Throws:
IOException
-
minMaxChildren
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
Returns inner hit definition in the scope of this query and reusing the defined type and query. -
innerHit
-
query
Returns the children query to execute. -
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
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(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
doXContent
in classAbstractQueryBuilder<HasChildQueryBuilder>
- Throws:
IOException
-
fromXContent
public static HasChildQueryBuilder fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException - Throws:
IOException
-
getWriteableName
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQuery
in classAbstractQueryBuilder<HasChildQueryBuilder>
- Throws:
IOException
-
doEquals
- Specified by:
doEquals
in classAbstractQueryBuilder<HasChildQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<HasChildQueryBuilder>
-
doRewrite
- Overrides:
doRewrite
in classAbstractQueryBuilder<HasChildQueryBuilder>
- Throws:
IOException
-
extractInnerHitBuilders
- Overrides:
extractInnerHitBuilders
in classAbstractQueryBuilder<HasChildQueryBuilder>
-