Package org.elasticsearch.join.query

Class HasParentQueryBuilder

java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<HasParentQueryBuilder>
org.elasticsearch.join.query.HasParentQueryBuilder
All Implemented Interfaces:
org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.index.query.QueryBuilder, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.index.query.QueryBuilder>, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
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.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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>

  • Field Summary

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    HasParentQueryBuilder(String type, org.elasticsearch.index.query.QueryBuilder query, boolean score)
     
    HasParentQueryBuilder(org.elasticsearch.common.io.stream.StreamInput in)
    Read from a stream.

  • Method Summary

    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 queryRewriteContext)
     
    protected org.apache.lucene.search.Query
    doToQuery(org.elasticsearch.index.query.SearchExecutionContext context)
     
    protected void
    doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out)
     
    protected void
    doXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    protected void
    extractInnerHitBuilders(Map<String,org.elasticsearch.index.query.InnerHitContextBuilder> innerHits)
     
    static HasParentQueryBuilder
    fromXContent(org.elasticsearch.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.
    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
    String
    type()
    Returns the parents type name

    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

  • Constructor Details

    • HasParentQueryBuilder

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

    • HasParentQueryBuilder

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

  • Method Details

    • doWriteTo

      protected void doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      doWriteTo in class org.elasticsearch.index.query.AbstractQueryBuilder<HasParentQueryBuilder>
      Throws:
      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 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.SearchExecutionContext context) throws IOException
      Specified by:
      doToQuery in class org.elasticsearch.index.query.AbstractQueryBuilder<HasParentQueryBuilder>
      Throws:
      IOException

    • doXContent

      protected void doXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      doXContent in class org.elasticsearch.index.query.AbstractQueryBuilder<HasParentQueryBuilder>
      Throws:
      IOException

    • fromXContent

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

    • getWriteableName

      public String getWriteableName()

    • doEquals

      protected boolean doEquals(HasParentQueryBuilder that)
      Specified by:
      doEquals in class org.elasticsearch.index.query.AbstractQueryBuilder<HasParentQueryBuilder>

    • 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 queryRewriteContext) throws IOException
      Overrides:
      doRewrite in class org.elasticsearch.index.query.AbstractQueryBuilder<HasParentQueryBuilder>
      Throws:
      IOException

    • extractInnerHitBuilders

      protected void extractInnerHitBuilders(Map<String,org.elasticsearch.index.query.InnerHitContextBuilder> innerHits)
      Overrides:
      extractInnerHitBuilders in class org.elasticsearch.index.query.AbstractQueryBuilder<HasParentQueryBuilder>