Package com.aquima.interactions.matching

Interface IMatchRequest

All Superinterfaces:
IMatchableInstance
All Known Implementing Classes:
MatchRequest
public interface IMatchRequest extends IMatchableInstance
This interface defines the methods that specify the attributes and configuration that should be used by the match action.
Since:
6.2
Author:
O. Kerpershoek, F. van der Meer

  • Method Details

    • getKeyField

      String getKeyField()
      This method returns the attribute that should be used to group matching cases on. Cases with the same value for this attribute will be considered as the same result, where the highest score will be taken as the match score.
      Returns:
      the attribute that should be used to group matching cases on.

    • setKeyField

      void setKeyField(String attribute, int maxResults)
      This method may be used to override the key field of the match result. When this method is invoked with a null value for the key field, the match result will not group result.
      Parameters:
      attribute - The attribute whose values should be used as key-field.
      maxResults - The maximum number of cases that should be grouped.

    • getMaxKeyResults

      int getMaxKeyResults()
      This method returns the maximum number of results that should be stored for each unique key field value.
      Returns:
      the maximum number of results that should be stored for each unique key field value.

    • getMaxResults

      int getMaxResults()
      This method returns the maximum number of matching cases that should be returned as a result of the match action.
      Returns:
      the maximum number of matching cases that should be returned as a result of the match action.

    • setMaxResult

      void setMaxResult(int maxResults)
      This method may be used to specify the maximum number of results that may be present in the match result.
      Parameters:
      maxResults - The maximum number of results that may be present in the match result.