Package com.aquima.interactions.matching

Interface IMatchableInstance

All Known Subinterfaces:
IMatchRequest
All Known Implementing Classes:
MatchInstance, MatchRequest
public interface IMatchableInstance
This interface defines the methods that can be used to override the default match settings for an instance.
Since:
6.2
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEntityName()
    This method returns the entity name of the casebase against which this match request should be matched.
    String
    getInstanceName()
    This method returns the name of the instance.
    IMatchableInstance[]
    getInstances(String relation)
    This method may be used to retrieve the instances that will be matched for the specified relation attribute.
    int
    getThresholdPercentage()
    This method returns the threshold for the instance score.
    IMatchableAttribute
    getValue(String attribute)
    This method may be used to retrieve the match settings for the specified attribute.
    void
    setThresholdPercentage(int threshold)
    This method may be used to specify the threshold that should be used for this instance.

  • Method Details

    • getEntityName

      String getEntityName()
      This method returns the entity name of the casebase against which this match request should be matched.
      Returns:
      the entity name of the casebase against which this match request should be matched.

    • getInstanceName

      String getInstanceName()
      This method returns the name of the instance. The name is used to identify the instance in for instance a detail match.
      Returns:
      The name of the instance this interface represents.

    • getThresholdPercentage

      int getThresholdPercentage()
      This method returns the threshold for the instance score. When the instance scores less than the threshold, the case will be removed from consideration. The default threshold returned by this method is -1, indicating that the default as specified in the match engine should be used.
      Returns:
      The threshold that should be used for this instance.

    • setThresholdPercentage

      void setThresholdPercentage(int threshold)
      This method may be used to specify the threshold that should be used for this instance. A threshold should be an integer ranging from zero to 100, where a value of zero means that the threshold should be disabled (as all instances will at least score zero).
      Parameters:
      threshold - The threshold that should be used when matching this instance.

    • getValue

      IMatchableAttribute getValue(String attribute)
      This method may be used to retrieve the match settings for the specified attribute.
      Parameters:
      attribute - The attribute for which the match settings are requested.
      Returns:
      The match settings for the specified attribute.

    • getInstances

      IMatchableInstance[] getInstances(String relation)
      This method may be used to retrieve the instances that will be matched for the specified relation attribute.
      Parameters:
      relation - The relation attribute for which the instances are requested.
      Returns:
      The instances that will be match for the spacified relation attribute.