Package com.yahoo.searchdefinition

Class DefaultRankProfile

java.lang.Object

com.yahoo.searchdefinition.RankProfile

com.yahoo.searchdefinition.DefaultRankProfile

All Implemented Interfaces:

Cloneable

public class DefaultRankProfile
extends RankProfile

The rank profile containing default settings. This is derived from the fields whenever this is accessed.

Author:

bratseth

Nested Class Summary

Nested classes/interfaces inherited from class com.yahoo.searchdefinition.RankProfile

RankProfile.DiversitySettings, RankProfile.MatchPhaseSettings, RankProfile.MutateOperation, RankProfile.RankingExpressionFunction, RankProfile.RankProperty, RankProfile.RankSetting, RankProfile.TypeSettings

Field Summary

Fields inherited from class com.yahoo.searchdefinition.RankProfile

FIRST_PHASE, rankSettings, SECOND_PHASE

Constructor Summary

Constructors

Constructor	Description
DefaultRankProfile(Schema schema, RankProfileRegistry rankProfileRegistry, RankingConstants rankingConstants)	Creates a new rank profile

Method Summary

Modifier and Type	Method	Description
RankProfile.RankSetting	getRankSetting(String fieldOrIndex, RankProfile.RankSetting.Type type)	Returns a rank setting of field or index, or null if there is no such rank setting in this profile or one it inherits
void	inherit(String inheritedName)	Ignore self inheriting of default as some applications may use that for historical reasons.
Set<RankProfile.RankSetting>	rankSettings()	Returns the names of the fields which have a rank boost setting explicitly in this profile or in fields

Methods inherited from class com.yahoo.searchdefinition.RankProfile

addAttributeType, addConstant, addConstantTensor, addFunction, addFunction, addInputFeature, addMatchFeatures, addMutateOperation, addQueryFeatureType, addRankFeatures, addRankProperty, addRankSetting, addRankSetting, addSummaryFeatures, allFilterFields, applicationPackage, clone, compile, declaredRankSettingIterator, filterFields, findFunction, getAttributeTypes, getConstants, getFirstPhase, getFirstPhaseRanking, getFunctions, getIgnoreDefaultRankFeatures, getKeepRankCount, getMatchFeatures, getMatchPhaseSettings, getMinHitsPerThread, getMutateOperations, getNumSearchPartitions, getNumThreadsPerSearch, getQueryFeatureTypes, getRankFeatures, getRankProperties, getRankPropertyMap, getRankScoreDropLimit, getRerankCount, getSecondPhase, getSecondPhaseRanking, getSummaryFeatures, getTermwiseLimit, inheritedNames, inherits, name, onnxModels, rankingConstants, rankSettingIterator, schema, setFirstPhaseRanking, setIgnoreDefaultRankFeatures, setInheritedMatchFeatures, setInheritedSummaryFeatures, setKeepRankCount, setMatchPhaseSettings, setMinHitsPerThread, setNumSearchPartitions, setNumThreadsPerSearch, setRankScoreDropLimit, setRerankCount, setSecondPhaseRanking, setTermwiseLimit, toString, typeContext, typeContext, typeContext

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultRankProfile

public DefaultRankProfile(Schema schema,
                          RankProfileRegistry rankProfileRegistry,
                          RankingConstants rankingConstants)

Creates a new rank profile

Parameters:

rankProfileRegistry - the RankProfileRegistry to use for storing and looking up rank profiles

Method Detail

inherit

public void inherit(String inheritedName)

Ignore self inheriting of default as some applications may use that for historical reasons.

Overrides:

inherit in class RankProfile

getRankSetting

public RankProfile.RankSetting getRankSetting(String fieldOrIndex,
                                              RankProfile.RankSetting.Type type)

Description copied from class: RankProfile

Returns a rank setting of field or index, or null if there is no such rank setting in this profile or one it inherits

Overrides:

getRankSetting in class RankProfile

Parameters:

fieldOrIndex - the field whose settings to return

type - the type that the field is required to be

Returns:

the rank setting found, or null

rankSettings

public Set<RankProfile.RankSetting> rankSettings()

Returns the names of the fields which have a rank boost setting explicitly in this profile or in fields

Overrides:

rankSettings in class RankProfile