Package com.aquima.interactions.matching

Interface IMatchResult

All Known Implementing Classes:
MatchResult
public interface IMatchResult
This interface defines the methods that can be used to query the result of a match action.
Since:
6.2
Author:
O. Kerpershoek, F. van der Meer

  • Method Details

    • getMatches

      IMatchScore[] getMatches()
      This method returns all the matches from this match result.
      Returns:
      Array containing all the matches of this match result.

    • getScoresForKey

      IMatchScore[] getScoresForKey(ISingleValue key)
      This method returns the matches for the specified key field value. This method is only relevant when a key field has been used when matching.
      Parameters:
      key - The key field value for which the match scores are requested.
      Returns:
      Array containing the matches for the specified key field value.

    • getUniqueKeys

      ISingleValue[] getUniqueKeys()
      This method returns the key field values that are used to group the results on. This method is only relevant when a key field is used during the match.
      Returns:
      Array containing the key field values the results are grouped on.

    • getScoreCount

      int getScoreCount()
      This method returns the number of match results.
      Returns:
      the number of match results.