Package com.aquima.interactions.matching

Interface IMatchableAttribute

All Known Implementing Classes:
MatchAttribute
public interface IMatchableAttribute
This interface defines the methods for a matchable attribute from the match request. The matchable attribute interface may be used to override the default match settings for the attribute.
Since:
6.2
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getThresholdPercentage()
    This method returns the threshold for the attribute score.
    int
    getUnknownPercentage()
    This method returns the score that should be used when one of the required values is unknown.
    IValue
    getValue()
    This method returns the value that should be matched.
    int
    getWeight()
    This method returns the weight of the attribute that should be used when calculating the match score.
    void
    setThresholdPercentage(int threshold)
    This method may be used to specify the threshold that should be used for this attribute.
    void
    setUnknownPercentage(int percentage)
    This method can be used to set the score that should be used when one of the required values is unknown.
    void
    setWeight(int weight)
    This method may be used to override the default weight of the attribute.

  • Method Details

    • getValue

      IValue getValue()
      This method returns the value that should be matched.
      Returns:
      the value that should be matched.

    • getWeight

      int getWeight()
      This method returns the weight of the attribute that should be used when calculating the match score. The default weight value if -1, indicating that the default weight value as specified in the match engine should be used.
      Returns:
      The weight that should be used when calculating a match score for this attribute.

    • setWeight

      void setWeight(int weight)
      This method may be used to override the default weight of the attribute. A weight value should be a non negative integer, with a weight of zero having a special meaning. When a weight value of zero is used, the attribute will still be matched, but the resulting score will not be part of the match score for the case. A weight value of zero is only relevant when the attribute has also specified a threshold greater than zero.
      Parameters:
      weight - The weight that should be used when calculating the match score.

    • getThresholdPercentage

      int getThresholdPercentage()
      This method returns the threshold for the attribute score. When the attribute 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 attribute.

    • setThresholdPercentage

      void setThresholdPercentage(int threshold)
      This method may be used to specify the threshold that should be used for this attribute. 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 attributes will at least score zero).
      Parameters:
      threshold - The threshold that should be used when matching this attribute.

    • getUnknownPercentage

      int getUnknownPercentage()
      This method returns the score that should be used when one of the required values is unknown.
      Returns:
      the score that should be used when one of the required values is unknown.

    • setUnknownPercentage

      void setUnknownPercentage(int percentage)
      This method can be used to set the score that should be used when one of the required values is unknown.
      Parameters:
      percentage - the score that should be used when one of the required values is unknown.