Package org.elasticsearch.join.query
Class HasParentQueryBuilder
- java.lang.Object
-
- org.elasticsearch.index.query.AbstractQueryBuilder<HasParentQueryBuilder>
-
- org.elasticsearch.join.query.HasParentQueryBuilder
-
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
public class HasParentQueryBuilder extends AbstractQueryBuilder<HasParentQueryBuilder>
Builder for the 'has_parent' query.
-
-
Nested Class Summary
-
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 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, QueryBuilder query, boolean score)
HasParentQueryBuilder(StreamInput in)
Read from a stream.
-
Method Summary
Modifier and Type Method Description protected boolean
doEquals(HasParentQueryBuilder 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 HasParentQueryBuilder
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.HasParentQueryBuilder
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.HasParentQueryBuilder
innerHit(InnerHitBuilder innerHit)
QueryBuilder
query()
Returns the query to execute.boolean
score()
Returnstrue
if the parent score is mapped into the child documentsjava.lang.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, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQuery, toString, 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_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, QueryBuilder query, boolean score)
-
HasParentQueryBuilder
public HasParentQueryBuilder(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<HasParentQueryBuilder>
- Throws:
java.io.IOException
-
query
public QueryBuilder query()
Returns the query to execute.
-
score
public boolean score()
Returnstrue
if the parent score is mapped into the child documents
-
type
public java.lang.String type()
Returns the parents type name
-
innerHit
public InnerHitBuilder innerHit()
Returns inner hit definition in the scope of this query and reusing the defined type and query.
-
innerHit
public HasParentQueryBuilder innerHit(InnerHitBuilder innerHit)
-
ignoreUnmapped
public HasParentQueryBuilder 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.
-
doToQuery
protected Query doToQuery(QueryShardContext context) throws java.io.IOException
- Specified by:
doToQuery
in classAbstractQueryBuilder<HasParentQueryBuilder>
- Throws:
java.io.IOException
-
doXContent
protected void doXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
doXContent
in classAbstractQueryBuilder<HasParentQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static HasParentQueryBuilder fromXContent(XContentParser parser) throws java.io.IOException
- Throws:
java.io.IOException
-
getWriteableName
public java.lang.String getWriteableName()
-
doEquals
protected boolean doEquals(HasParentQueryBuilder that)
- Specified by:
doEquals
in classAbstractQueryBuilder<HasParentQueryBuilder>
-
doHashCode
protected int doHashCode()
- Specified by:
doHashCode
in classAbstractQueryBuilder<HasParentQueryBuilder>
-
doRewrite
protected QueryBuilder doRewrite(QueryRewriteContext queryShardContext) throws java.io.IOException
- Overrides:
doRewrite
in classAbstractQueryBuilder<HasParentQueryBuilder>
- Throws:
java.io.IOException
-
extractInnerHitBuilders
protected void extractInnerHitBuilders(java.util.Map<java.lang.String,InnerHitContextBuilder> innerHits)
- Overrides:
extractInnerHitBuilders
in classAbstractQueryBuilder<HasParentQueryBuilder>
-
-