Package com.aquima.interactions.matching

Interface IDetailMatchResult

All Known Implementing Classes:
DetailMatchResult
public interface IDetailMatchResult
This interface defines the object that is used to pass the result of a detail match.
Since:
6.2
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCaseId()
    This method returns the name of the case that was matched.
    String[]
    getMatchedAttributes()
    This method returns an array containing the names of the attributes that were matched to calculate the score of this case.
    int
    getScore()
    This method returns the score of the case.
    IAttributeScore
    getScore(String attribute)
    This method returns the match information for the specified attribute.
    IAttributeScoreDetails
    getScoreDetails(String attribute)
    This method returns the score details for the specified attribute.

  • Method Details

    • getCaseId

      String getCaseId()
      This method returns the name of the case that was matched.
      Returns:
      the name of the case that was matched.

    • getScore

      int getScore()
      This method returns the score of the case.
      Returns:
      the score of the case.

    • getScore

      IAttributeScore getScore(String attribute)
      This method returns the match information for the specified attribute.
      Parameters:
      attribute - The attribute for which detailed match information is requested.
      Returns:
      Detailed match information of the specified attribute.

    • getMatchedAttributes

      String[] getMatchedAttributes()
      This method returns an array containing the names of the attributes that were matched to calculate the score of this case.
      Returns:
      An array containing the names of the attributes that were matched.

    • getScoreDetails

      IAttributeScoreDetails getScoreDetails(String attribute)
      This method returns the score details for the specified attribute.
      Parameters:
      attribute - The attribute for which detailed score information is requested.
      Returns:
      Detailed scoring information of the specified attribute.
      Throws:
      InvalidStateException - if the provided attribute does not specify a multivalue attribute.