Package org.elasticsearch.join.query

Class HasChildQueryBuilder

  • All Implemented Interfaces:
    org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.index.query.QueryBuilder, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.index.query.QueryBuilder>
    public class HasChildQueryBuilder
extends org.elasticsearch.index.query.AbstractQueryBuilder<HasChildQueryBuilder>
    A query builder for has_child query.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static 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.elasticsearch.common.xcontent.ToXContent

        org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

      • Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

        org.elasticsearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.elasticsearch.common.io.stream.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, org.elasticsearch.index.query.QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode)  
      HasChildQueryBuilder​(org.elasticsearch.common.io.stream.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 type
      protected boolean doEquals​(HasChildQueryBuilder that)  
      protected int doHashCode()  
      protected org.elasticsearch.index.query.QueryBuilder doRewrite​(org.elasticsearch.index.query.QueryRewriteContext queryShardContext)  
      protected org.apache.lucene.search.Query doToQuery​(org.elasticsearch.index.query.QueryShardContext context)  
      protected void doWriteTo​(org.elasticsearch.common.io.stream.StreamOutput out)  
      protected void doXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
      protected void extractInnerHitBuilders​(java.util.Map<java.lang.String,org.elasticsearch.index.query.InnerHitContextBuilder> innerHits)  
      static HasChildQueryBuilder fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
      java.lang.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.
      org.elasticsearch.index.query.InnerHitBuilder innerHit()
      Returns inner hit definition in the scope of this query and reusing the defined type and query.
      HasChildQueryBuilder innerHit​(org.elasticsearch.index.query.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.
      org.elasticsearch.index.query.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.index.query.Rewriteable

      • Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

        isFragment

    • Field Detail

      • 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,
                            org.elasticsearch.index.query.QueryBuilder query,
                            org.apache.lucene.search.join.ScoreMode scoreMode)

      • HasChildQueryBuilder

        public HasChildQueryBuilder​(org.elasticsearch.common.io.stream.StreamInput in)
                     throws java.io.IOException
        Read from a stream.
        Throws:
        java.io.IOException

    • Method Detail

      • doWriteTo

        protected void doWriteTo​(org.elasticsearch.common.io.stream.StreamOutput out)
                  throws java.io.IOException
        Specified by:
        doWriteTo in class org.elasticsearch.index.query.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 org.elasticsearch.index.query.InnerHitBuilder innerHit()
        Returns inner hit definition in the scope of this query and reusing the defined type and query.

      • innerHit

        public HasChildQueryBuilder innerHit​(org.elasticsearch.index.query.InnerHitBuilder innerHit)

      • query

        public org.elasticsearch.index.query.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​(org.elasticsearch.common.xcontent.XContentBuilder builder,
                          org.elasticsearch.common.xcontent.ToXContent.Params params)
                   throws java.io.IOException
        Specified by:
        doXContent in class org.elasticsearch.index.query.AbstractQueryBuilder<HasChildQueryBuilder>
        Throws:
        java.io.IOException

      • fromXContent

        public static HasChildQueryBuilder fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • getWriteableName

        public java.lang.String getWriteableName()

      • doToQuery

        protected org.apache.lucene.search.Query doToQuery​(org.elasticsearch.index.query.QueryShardContext context)
                                            throws java.io.IOException
        Specified by:
        doToQuery in class org.elasticsearch.index.query.AbstractQueryBuilder<HasChildQueryBuilder>
        Throws:
        java.io.IOException

      • doHashCode

        protected int doHashCode()
        Specified by:
        doHashCode in class org.elasticsearch.index.query.AbstractQueryBuilder<HasChildQueryBuilder>

      • doRewrite

        protected org.elasticsearch.index.query.QueryBuilder doRewrite​(org.elasticsearch.index.query.QueryRewriteContext queryShardContext)
                                                        throws java.io.IOException
        Overrides:
        doRewrite in class org.elasticsearch.index.query.AbstractQueryBuilder<HasChildQueryBuilder>
        Throws:
        java.io.IOException

      • extractInnerHitBuilders

        protected void extractInnerHitBuilders​(java.util.Map<java.lang.String,org.elasticsearch.index.query.InnerHitContextBuilder> innerHits)
        Overrides:
        extractInnerHitBuilders in class org.elasticsearch.index.query.AbstractQueryBuilder<HasChildQueryBuilder>