public interface IDfResultRaterConfig
Modifier and Type | Method and Description |
---|---|
float |
getAttributeWeight(java.lang.String attrName,
java.lang.String[] attrValues)
Gets the relative weight of an attribute when rating a result.
|
java.lang.String |
getDateAttribute()
Gets the date attribute.
|
float |
getRankConfidence(java.lang.String sourceName,
int sourceType)
Gets the rank confidence of a specific source.
|
float |
getSourceBonusAttribute(java.lang.String sourceName,
int sourceType)
Gets a specific source confidence bonus for queries with attribute constraint.
|
float |
getSourceBonusFullText(java.lang.String sourceName,
int sourceType)
Gets a specific source confidence bonus for queries with full-text constraint.
|
boolean |
isAttributeValueRequired(java.lang.String attrName)
Indicates whether the value(s) of attributes must be provided to the method
getAttributeWeight(java.lang.String, java.lang.String[]) . |
boolean |
isFullTextAttribute(java.lang.String attrName)
Indicates whether an attribute is part of the "full-text" definition.
|
boolean |
isHeaderAttribute(java.lang.String attrName)
Indicates whether an attribute belongs to the result header.
|
boolean |
isPrimaryAttribute(java.lang.String attrName)
Indicates whether an attribute is primary.
|
boolean |
needsSrcTypeForRankConfidence(java.lang.String sourceName)
Indicates whether the type of sources must be provided to the method
getRankConfidence(java.lang.String, int) . |
boolean |
needsSrcTypeForSrcBonus(java.lang.String sourceName)
Indicates whether the type of sources must be provided to the methods
getSourceBonusFullText(java.lang.String, int) , getSourceBonusAttribute(java.lang.String, int) . |
float getAttributeWeight(java.lang.String attrName, java.lang.String[] attrValues)
isAttributeValueRequired(String)
to check whether the attribute value(s) is required or if
a null
value is sufficient.attrName
- The name of the attribute.attrValues
- The values of the attribute (more than one value in the case of a repeated attribute). In many
cases the value is not required, see isAttributeValueRequired(String)
.boolean isAttributeValueRequired(java.lang.String attrName)
getAttributeWeight(java.lang.String, java.lang.String[])
. If this
method returns false
then a null
value may be provided as parameter of getAttributeWeight(java.lang.String, java.lang.String[])
.attrName
- The name of the attribute.true
, if the attribute value(s) must be provided; false
if a null
value is sufficient.boolean isFullTextAttribute(java.lang.String attrName)
attrName
- The name of the attribute.true
, if the attribute is a full-text one; false
, otherwise.boolean isPrimaryAttribute(java.lang.String attrName)
attrName
- The name of the attribute.true
, if the attribute is primary; false
, otherwise.java.lang.String getDateAttribute()
null
if none.boolean isHeaderAttribute(java.lang.String attrName)
attrName
- The name of the attribute.true
, if the attribute belongs to the result header; false
, otherwise.float getRankConfidence(java.lang.String sourceName, int sourceType)
needsSrcTypeForSrcBonus(String)
to check
whether the source type is required or if IDfSearchSource.SRC_TYPE_UNDEFINED
value is sufficient.sourceName
- The name of the source.sourceType
- The type of the source (IDfSearchSource.SRC_TYPE_DOCBASE
, IDfSearchSource.SRC_TYPE_EXTERNAL
).boolean needsSrcTypeForRankConfidence(java.lang.String sourceName)
getRankConfidence(java.lang.String, int)
. If this method
returns false
then IDfSearchSource.SRC_TYPE_UNDEFINED
value may be provided as parameter of
the method getRankConfidence(java.lang.String, int)
.sourceName
- The name of the source.true
if the type of sources must be provided; false
if IDfSearchSource.SRC_TYPE_UNDEFINED
value is sufficient.float getSourceBonusFullText(java.lang.String sourceName, int sourceType)
#isSourceTypeRequired()
to check whether the source type is required or if IDfSearchSource.SRC_TYPE_UNDEFINED
value is sufficient.sourceName
- The name of the source.sourceType
- The type of the source (IDfSearchSource.SRC_TYPE_DOCBASE
, IDfSearchSource.SRC_TYPE_EXTERNAL
).float getSourceBonusAttribute(java.lang.String sourceName, int sourceType)
#getSourceBonusFullText(String)
sourceName
- The name of the source.sourceType
- The type of the source (IDfSearchSource.SRC_TYPE_DOCBASE
, IDfSearchSource.SRC_TYPE_EXTERNAL
).boolean needsSrcTypeForSrcBonus(java.lang.String sourceName)
getSourceBonusFullText(java.lang.String, int)
, getSourceBonusAttribute(java.lang.String, int)
. If this method returns false
then IDfSearchSource.SRC_TYPE_UNDEFINED
value may be provided as parameter of these methods.sourceName
- The name of the source.true
if the type of sources must be provided; false
if IDfSearchSource.SRC_TYPE_UNDEFINED
value is sufficient.Copyright 1994-2023 OpenText Corporation. All rights reserved.