Package org.elasticsearch.index.query
Class NestedQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<NestedQueryBuilder>
org.elasticsearch.index.query.NestedQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
public class NestedQueryBuilder extends AbstractQueryBuilder<NestedQueryBuilder>
-
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>, Writeable.Writer<V>
-
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
-
Constructor Summary
Constructors Constructor Description NestedQueryBuilder(java.lang.String path, QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode)
NestedQueryBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description protected boolean
doEquals(NestedQueryBuilder that)
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.protected int
doHashCode()
protected QueryBuilder
doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query
doToQuery(QueryShardContext context)
protected void
doWriteTo(StreamOutput out)
protected void
doXContent(XContentBuilder builder, ToXContent.Params params)
void
extractInnerHitBuilders(java.util.Map<java.lang.String,InnerHitContextBuilder> innerHits)
For internal usage only! Extracts the inner hits from the query tree.static NestedQueryBuilder
fromXContent(XContentParser parser)
java.lang.String
getWriteableName()
Returns the name of the writeable objectboolean
ignoreUnmapped()
Gets whether the query builder will ignore unmapped fields (and run aMatchNoDocsQuery
in place of this query) or throw an exception if the path is unmapped.NestedQueryBuilder
ignoreUnmapped(boolean ignoreUnmapped)
Sets whether the query builder should ignore unmapped paths (and run aMatchNoDocsQuery
in place of this query) or throw an exception if the path is unmapped.InnerHitBuilder
innerHit()
Returns inner hit definition in the scope of this query and reusing the defined type and query.NestedQueryBuilder
innerHit(InnerHitBuilder innerHitBuilder)
static org.apache.lucene.search.join.ScoreMode
parseScoreMode(java.lang.String scoreModeString)
QueryBuilder
query()
Returns the nested query to execute.org.apache.lucene.search.join.ScoreMode
scoreMode()
Returns how the scores from the matching child documents are mapped into the nested parent document.static java.lang.String
scoreModeAsString(org.apache.lucene.search.join.ScoreMode scoreMode)
Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, equals, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
DEFAULT_IGNORE_UNMAPPED
public static final boolean DEFAULT_IGNORE_UNMAPPEDThe default value for ignore_unmapped.- See Also:
- Constant Field Values
-
-
Constructor Details
-
NestedQueryBuilder
public NestedQueryBuilder(java.lang.String path, QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode) -
NestedQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<NestedQueryBuilder>
- Throws:
java.io.IOException
-
query
Returns the nested query to execute. -
innerHit
Returns inner hit definition in the scope of this query and reusing the defined type and query. -
innerHit
-
scoreMode
public org.apache.lucene.search.join.ScoreMode scoreMode()Returns how the scores from the matching child documents are mapped into the nested parent document. -
ignoreUnmapped
Sets whether the query builder should ignore unmapped paths (and run aMatchNoDocsQuery
in place of this query) or throw an exception if the path is unmapped. -
ignoreUnmapped
public boolean ignoreUnmapped()Gets whether the query builder will ignore unmapped fields (and run aMatchNoDocsQuery
in place of this query) or throw an exception if the path is unmapped. -
doXContent
protected void doXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<NestedQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
- Throws:
java.io.IOException
-
parseScoreMode
public static org.apache.lucene.search.join.ScoreMode parseScoreMode(java.lang.String scoreModeString) -
scoreModeAsString
public static java.lang.String scoreModeAsString(org.apache.lucene.search.join.ScoreMode scoreMode) -
getWriteableName
public final java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
doEquals
Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Specified by:
doEquals
in classAbstractQueryBuilder<NestedQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<NestedQueryBuilder>
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<NestedQueryBuilder>
- Throws:
java.io.IOException
-
doRewrite
protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext) throws java.io.IOException- Overrides:
doRewrite
in classAbstractQueryBuilder<NestedQueryBuilder>
- Throws:
java.io.IOException
-
extractInnerHitBuilders
public void extractInnerHitBuilders(java.util.Map<java.lang.String,InnerHitContextBuilder> innerHits)Description copied from class:AbstractQueryBuilder
For internal usage only! Extracts the inner hits from the query tree. While it extracts inner hits, child inner hits are inlined into the inner hit builder they belong to.- Overrides:
extractInnerHitBuilders
in classAbstractQueryBuilder<NestedQueryBuilder>
-