Module org.elasticsearch.server
Class RetrieverBuilderWrapper<T extends RetrieverBuilder>
java.lang.Object
org.elasticsearch.search.retriever.RetrieverBuilder
org.elasticsearch.search.retriever.RetrieverBuilderWrapper<T>
- All Implemented Interfaces:
Rewriteable<RetrieverBuilder>,ToXContent
A wrapper that can be used to modify the behaviour of an existing
RetrieverBuilder.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params -
Field Summary
FieldsFields inherited from class org.elasticsearch.search.retriever.RetrieverBuilder
MIN_SCORE_FIELD, minScore, NAME_FIELD, PRE_FILTER_FIELD, preFilterQueryBuilders, rankDocs, retrieverNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract Tclone(RetrieverBuilder sub) protected booleanprotected intprotected voiddoToXContent(XContentBuilder builder, ToXContent.Params params) voidextractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed) This method is called at the end of rewriting on behalf of aSearchSourceBuilder.getName()Gets the filters for this retriever.RankDoc[]booleanDetermines if this retriever contains sub-retrievers that need to be executed prior to search.booleanminScore()retrieverName(String retrieverName) Rewrites this instance based on the provided context.voidsetRankDocs(RankDoc[] rankDocs) This function is called by compoundRetrieverBuilderto return the original query that was used by this retriever to compute its top documents.toString()validate(SearchSourceBuilder source, ActionRequestValidationException validationException, boolean isScroll, boolean allowPartialSearchResults) Methods inherited from class org.elasticsearch.search.retriever.RetrieverBuilder
declareBaseParserFields, equals, hashCode, parseInnerRetrieverBuilder, parseTopLevelRetrieverBuilder, rewritePreFilters, toXContent
-
Field Details
-
in
-
-
Constructor Details
-
RetrieverBuilderWrapper
-
-
Method Details
-
clone
-
rewrite
Description copied from interface:RewriteableRewrites this instance based on the provided context. The returned objects will be the same instance as this if no changes during the rewrite were applied.- Specified by:
rewritein interfaceRewriteable<T extends RetrieverBuilder>- Overrides:
rewritein classRetrieverBuilder- Throws:
IOException
-
topDocsQuery
Description copied from class:RetrieverBuilderThis function is called by compoundRetrieverBuilderto return the original query that was used by this retriever to compute its top documents.- Specified by:
topDocsQueryin classRetrieverBuilder
-
minScore
- Overrides:
minScorein classRetrieverBuilder
-
getPreFilterQueryBuilders
Description copied from class:RetrieverBuilderGets the filters for this retriever.- Overrides:
getPreFilterQueryBuildersin classRetrieverBuilder
-
validate
public ActionRequestValidationException validate(SearchSourceBuilder source, ActionRequestValidationException validationException, boolean isScroll, boolean allowPartialSearchResults) - Overrides:
validatein classRetrieverBuilder
-
retrieverName
- Overrides:
retrieverNamein classRetrieverBuilder
-
setRankDocs
- Overrides:
setRankDocsin classRetrieverBuilder
-
getRankDocs
- Overrides:
getRankDocsin classRetrieverBuilder
-
isCompound
public boolean isCompound()Description copied from class:RetrieverBuilderDetermines if this retriever contains sub-retrievers that need to be executed prior to search.- Overrides:
isCompoundin classRetrieverBuilder
-
explainQuery
- Overrides:
explainQueryin classRetrieverBuilder
-
minScore
- Overrides:
minScorein classRetrieverBuilder
-
isFragment
public boolean isFragment()- Specified by:
isFragmentin interfaceToXContent- Overrides:
isFragmentin classRetrieverBuilder
-
toString
- Overrides:
toStringin classRetrieverBuilder
-
retrieverName
- Overrides:
retrieverNamein classRetrieverBuilder
-
extractToSearchSourceBuilder
public void extractToSearchSourceBuilder(SearchSourceBuilder searchSourceBuilder, boolean compoundUsed) Description copied from class:RetrieverBuilderThis method is called at the end of rewriting on behalf of aSearchSourceBuilder. Elements from retrievers are expected to be "extracted" into theSearchSourceBuilder.- Specified by:
extractToSearchSourceBuilderin classRetrieverBuilder
-
getName
- Specified by:
getNamein classRetrieverBuilder
-
doToXContent
- Specified by:
doToXContentin classRetrieverBuilder- Throws:
IOException
-
doEquals
- Specified by:
doEqualsin classRetrieverBuilder
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classRetrieverBuilder
-