MatchData class

Contains and collects metadata about a matching document. A list of MatchData is returned as part of every search.

Constructors

MatchData.new([String? term, String? field, Metadata? metadata])

term - The term this match data is associated with field - The field in which the term was found metadata - The metadata recorded about this term in this field

MatchData.fromJson(Map<String, dynamic> map)

factory

Properties

hashCode → int

The hash code for this object.

no setter, override

metadata ↔ TermMap

A cloned collection of metadata associated with this document.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

add(String term, String field, Metadata? metadata) → dynamic

Add metadata for a term/field pair to this instance of match data.

combine(MatchData otherMatchData) → dynamic

An instance of MatchData will be created for every term that matches a document. However only one instance is required in a result. This method combines metadata from another instance of MatchData with this objects metadata.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override