java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<NestedQueryBuilder>
org.elasticsearch.index.query.NestedQueryBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,QueryBuilder,Rewriteable<QueryBuilder>,ToXContent,ToXContentObject
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final booleanThe default value for ignore_unmapped.static final StringFields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionNestedQueryBuilder(String path, QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode) Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionprotected booleandoEquals(NestedQueryBuilder that) Indicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intprotected QueryBuilderdoRewrite(QueryRewriteContext queryRewriteContext) protected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context) protected voiddoWriteTo(StreamOutput out) protected voiddoXContent(XContentBuilder builder, ToXContent.Params params) voidextractInnerHitBuilders(Map<String, InnerHitContextBuilder> innerHits) For internal usage only! Extracts the inner hits from the query tree.static NestedQueryBuilderfromXContent(XContentParser parser) The minimal version of the recipient this object can be sent tofinal StringReturns the name of the writeable objectbooleanGets whether the query builder will ignore unmapped fields (and run aMatchNoDocsQueryin place of this query) or throw an exception if the path is unmapped.ignoreUnmapped(boolean ignoreUnmapped) Sets whether the query builder should ignore unmapped paths (and run aMatchNoDocsQueryin place of this query) or throw an exception if the path is unmapped.innerHit()Returns inner hit definition in the scope of this query and reusing the defined type and query.innerHit(InnerHitBuilder innerHitBuilder) static org.apache.lucene.search.join.ScoreModeparseScoreMode(String scoreModeString) path()Returns path to the searched nested object.query()Returns the nested query to execute.org.apache.lucene.search.join.ScoreModeReturns how the scores from the matching child documents are mapped into the nested parent document.static StringscoreModeAsString(org.apache.lucene.search.join.ScoreMode scoreMode) static <E extends Exception>
org.apache.lucene.search.QuerytoQuery(CheckedFunction<SearchExecutionContext, org.apache.lucene.search.Query, E> queryProvider, String path, org.apache.lucene.search.join.ScoreMode scoreMode, boolean ignoreUnmapped, SearchExecutionContext context) Returns the primitive Lucene query for a nested query given the primitive query to wrapMethods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doIndexMetadataRewrite, doInnerHitsRewrite, doSearchRewrite, equals, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
- See Also:
-
DEFAULT_IGNORE_UNMAPPED
public static final boolean DEFAULT_IGNORE_UNMAPPEDThe default value for ignore_unmapped.- See Also:
-
-
Constructor Details
-
NestedQueryBuilder
public NestedQueryBuilder(String path, QueryBuilder query, org.apache.lucene.search.join.ScoreMode scoreMode) -
NestedQueryBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<NestedQueryBuilder>- Throws:
IOException
-
query
Returns the nested query to execute. -
path
Returns path to the searched nested object. -
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 aMatchNoDocsQueryin 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 aMatchNoDocsQueryin place of this query) or throw an exception if the path is unmapped. -
doXContent
- Specified by:
doXContentin classAbstractQueryBuilder<NestedQueryBuilder>- Throws:
IOException
-
fromXContent
- Throws:
IOException
-
parseScoreMode
-
scoreModeAsString
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object -
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<NestedQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<NestedQueryBuilder>
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQueryin classAbstractQueryBuilder<NestedQueryBuilder>- Throws:
IOException
-
toQuery
public static <E extends Exception> org.apache.lucene.search.Query toQuery(CheckedFunction<SearchExecutionContext, org.apache.lucene.search.Query, throws EE> queryProvider, String path, org.apache.lucene.search.join.ScoreMode scoreMode, boolean ignoreUnmapped, SearchExecutionContext context) Returns the primitive Lucene query for a nested query given the primitive query to wrap- Type Parameters:
E- exception that the queryProvider may throw- Parameters:
queryProvider- Retrieves tye query to use given the SearchExecutionContextpath- nested pathscoreMode- score mode to useignoreUnmapped- whether to ignore unmapped fieldscontext- search execution context- Returns:
- the primitive Lucene query
- Throws:
E
-
doRewrite
- Overrides:
doRewritein classAbstractQueryBuilder<NestedQueryBuilder>- Throws:
IOException
-
extractInnerHitBuilders
Description copied from class:AbstractQueryBuilderFor 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:
extractInnerHitBuildersin classAbstractQueryBuilder<NestedQueryBuilder>
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to
-