AttributeCriteriaComputedBy enum

Strategy for computing the Attribute ranking criterion. This mainly affects multi-word queries with matches in more than one attribute. The ranking setting decides whether best takes effect. When Attribute comes after Proximity, which is the default order, the engine always uses the minProximity strategy and ignores best. To select best, move Attribute before Proximity in ranking. The sum strategy applies in both orders. - minProximity. Pick the best matching attribute from the attributes that form the best proximity score. On an ordered attribute, the match position breaks ties. - best. Pick the best matching attribute from all attributes that match any query word. On an ordered attribute, the match position breaks ties. - sum. Add up a score for every query word instead of picking one attribute. Each word's score comes from the attribute it matched, and from its position in that attribute when the attribute is ordered. A query word that matches nothing adds a large penalty. A record with a lower total ranks higher. A record therefore cannot rank high only because one word of a multi-word query matched a top attribute. Use sum with short, relevant attributes, and set long-text attributes to unordered.

Inheritance

• Object
• Enum
• AttributeCriteriaComputedBy

Available extensions

• EnumName

Annotations

• @JsonEnum.new(valueField: 'raw')

Values

minProximity → const AttributeCriteriaComputedBy

const AttributeCriteriaComputedBy(r'minProximity')

best → const AttributeCriteriaComputedBy

const AttributeCriteriaComputedBy(r'best')

sum → const AttributeCriteriaComputedBy

const AttributeCriteriaComputedBy(r'sum')

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.

no setter

raw → dynamic

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → dynamic

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromJson(dynamic json) → AttributeCriteriaComputedBy

Constants

values → const List<AttributeCriteriaComputedBy>

A constant List of the values in this enum, in order of their declaration.