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
String	getInheritedName()	Returns null, the default rank profile can not inherit anything
RankProfile.RankSetting	getRankSetting(String fieldOrIndex, RankProfile.RankSetting.Type type)	Returns the rank boost value of the given field
Set<RankProfile.RankSetting>	rankSettings()	Returns the names of the fields which have a rank boost setting explicitly in this profile or in fields
void	setInherited(String inheritedName)	Does nothing, the default rank profile can not inherit anything

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, getName, getNumSearchPartitions, getNumThreadsPerSearch, getQueryFeatureTypes, getRankFeatures, getRankProperties, getRankPropertyMap, getRankScoreDropLimit, getRerankCount, getSearch, getSecondPhase, getSecondPhaseRanking, getSummaryFeatures, getTermwiseLimit, inherits, onnxModels, rankingConstants, rankSettingIterator, 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

setInherited

public void setInherited(String inheritedName)

Does nothing, the default rank profile can not inherit anything

Overrides:

setInherited in class RankProfile

getInheritedName

public String getInheritedName()

Returns null, the default rank profile can not inherit anything

Overrides:

getInheritedName in class RankProfile

getRankSetting

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

Returns the rank boost value of the given field

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