Package org.elasticsearch.join.query

Class HasParentQueryBuilder

  • 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 HasParentQueryBuilder
extends org.elasticsearch.index.query.AbstractQueryBuilder<HasParentQueryBuilder>
    Builder for the 'has_parent' query.

    • Nested Class Summary

      • 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 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
      HasParentQueryBuilder​(java.lang.String type, org.elasticsearch.index.query.QueryBuilder query, boolean score)  
      HasParentQueryBuilder​(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
      protected boolean doEquals​(HasParentQueryBuilder 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 HasParentQueryBuilder 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.
      HasParentQueryBuilder 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.
      HasParentQueryBuilder innerHit​(org.elasticsearch.index.query.InnerHitBuilder innerHit)  
      org.elasticsearch.index.query.QueryBuilder query()
      Returns the query to execute.
      boolean score()
      Returns true if the parent score is mapped into the child documents
      java.lang.String type()
      Returns the parents type name

      • 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_IGNORE_UNMAPPED

        public static final boolean DEFAULT_IGNORE_UNMAPPED
        The default value for ignore_unmapped.
        See Also:
        Constant Field Values

    • Constructor Detail

      • HasParentQueryBuilder

        public HasParentQueryBuilder​(java.lang.String type,
                             org.elasticsearch.index.query.QueryBuilder query,
                             boolean score)

      • HasParentQueryBuilder

        public HasParentQueryBuilder​(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<HasParentQueryBuilder>
        Throws:
        java.io.IOException

      • query

        public org.elasticsearch.index.query.QueryBuilder query()
        Returns the query to execute.

      • score

        public boolean score()
        Returns true if the parent score is mapped into the child documents

      • type

        public java.lang.String type()
        Returns the parents type name

      • 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 HasParentQueryBuilder innerHit​(org.elasticsearch.index.query.InnerHitBuilder innerHit)

      • ignoreUnmapped

        public HasParentQueryBuilder 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.

      • 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<HasParentQueryBuilder>
        Throws:
        java.io.IOException

      • 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<HasParentQueryBuilder>
        Throws:
        java.io.IOException

      • fromXContent

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

      • getWriteableName

        public java.lang.String getWriteableName()

      • doHashCode

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

      • 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<HasParentQueryBuilder>
        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<HasParentQueryBuilder>