Package com.aquima.interactions.matching.ds

Interface IRampDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ExtXmlRampDS
public interface IRampDS extends IReportingDS
Data source interface for a ramp. A typical ramp consists of two slopes, and an top area. A ramp can be defined by providing the width of the top area, and width of both the left and right slope.
In the match engine, a ramp is usually defined for either a case or profile value. The value is used as the top of the ramp, and the values returned by the IRampDS datasource are used to calculate the ramp. The upper and lower range determine the width of the top area, whereas the upper and lower partial values influence the length of the slopes. A ramp that has only a left or right side, means that the other sides top area extends indefinitely.

Copyright: Copyright (c) 2001-2009

Company: Everest b.v.

Since:
6.2
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getLowerPartial()
    This method returns the lower partial of the ramp definition.
    double
    getLowerRange()
    This method returns the lower range of the ramp definition.
    String
    getName()
    This method returns the (unique) name of the match function.
    double
    getUpperPartial()
    This method returns the upper partial of the ramp definition.
    double
    getUpperRange()
    This method returns the upper range of the ramp definition.
    boolean
    isAbsoluteRamp()
    The absolute flag indicates how the partial and range numbers should be interpreted.
    boolean
    isLeftOnlyRamp()
    The left-only flag indicates whether only the left slope of the ramp exists.
    boolean
    isNumberRamp()
    This method returns a boolean indicating if this ramp match function will be used to match numbers of date values.
    boolean
    isRightOnlyRamp()
    See left-only for some documentation.

    Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

    addMessage

  • Method Details

    • getName

      String getName()
      This method returns the (unique) name of the match function.
      Returns:
      the (unique) name of the match function.

    • isNumberRamp

      boolean isNumberRamp()
      This method returns a boolean indicating if this ramp match function will be used to match numbers of date values.
      Returns:
      Boolean indicating if the ramp will be used to match numbers.

    • isAbsoluteRamp

      boolean isAbsoluteRamp()
      The absolute flag indicates how the partial and range numbers should be interpreted. An absolute ramp will simply use the numbers as is to calculate the ramp. A percentage ramp, will interpret the values as a percentage, and multiply them with base value to determine the shape of the ramp.
      Returns:
      boolean flag, true means absolute, false means percentage.

    • isLeftOnlyRamp

      boolean isLeftOnlyRamp()
      The left-only flag indicates whether only the left slope of the ramp exists. A ramp with only a left slope will have a top area that extends Indefinitely to the right side.
      Note: Only one of the left/right-only methods may return true. Both true would mean a 'ramp' with an infinite top area.
      Returns:
      boolean flag indicating whether only the left side has a slope.

    • isRightOnlyRamp

      boolean isRightOnlyRamp()
      See left-only for some documentation.
      Note: Only one of the left/right-only methods may return true. Both true would mean a 'ramp' with an infinite top area.
      Returns:
      boolean flag indicating whether only the right side has a slope.

    • getLowerRange

      double getLowerRange()

      This method returns the lower range of the ramp definition. A lower range means the left side of the ramp definition which gives a 100 percent match. While a partial means the position where the ramp gives a zero percent match.

      The lower part of the ramp is where the values are lower then the norm value. Whereas the higher part of the ramp has the higher values.

      See also: Otherwise a percentage value see isAbsoluteRamp()

      • a = lower-partial
      • b = lower-range
      • c = upper-range
      • d = upper-partial
       Example:
             b---100%---c
           /      |      \
        0-100%    |     100-0%
 -Inf   /       norm        \              +Inf
   ----a----------|----------d---------------
      Returns:
      The absolute or percentage distance between the norm value. Therefore the returned value cannot be negative.

    • getUpperRange

      double getUpperRange()

      This method returns the upper range of the ramp definition. A lower range means the left side of the ramp definition which gives a 100 percent match. While a partial means the position where the ramp gives a zero percent match.

      The lower part of the ramp is where the values are lower then the norm value. Whereas the higher part of the ramp has the higher values.

      See also: Otherwise a percentage value see isAbsoluteRamp()

      • a = lower-partial
      • b = lower-range
      • c = upper-range
      • d = upper-partial
       Example:
             b---100%---c
           /      |      \
        0-100%    |     100-0%
 -Inf   /       norm        \              +Inf
   ----a----------|----------d---------------
      Returns:
      The absolute or percentage distance between the norm value. Therefore the returned value cannot be negative.

    • getLowerPartial

      double getLowerPartial()

      This method returns the lower partial of the ramp definition. A lower range means the left side of the ramp definition which gives a 100 percent match. While a partial means the position where the ramp gives a zero percent match.

      The lower part of the ramp is where the values are lower then the norm value. Whereas the higher part of the ramp has the higher values.

      See also: Otherwise a percentage value see isAbsoluteRamp()

      • a = lower-partial
      • b = lower-range
      • c = upper-range
      • d = upper-partial
       Example:
             b---100%---c
           /      |      \
        0-100%    |     100-0%
 -Inf   /       norm        \              +Inf
   ----a----------|----------d---------------
      Returns:
      The absolute or percentage distance between the norm value. Therefore the returned value cannot be negative.

    • getUpperPartial

      double getUpperPartial()

      This method returns the upper partial of the ramp definition. A lower range means the left side of the ramp definition which gives a 100 percent match. While a partial means the position where the ramp gives a zero percent match.

      The lower part of the ramp is where the values are lower then the norm value. Whereas the higher part of the ramp has the higher values.

      See also: Otherwise a percentage value see isAbsoluteRamp()

      • a = lower-partial
      • b = lower-range
      • c = upper-range
      • d = upper-partial
       Example:
             b---100%---c
           /      |      \
        0-100%    |     100-0%
 -Inf   /       norm        \              +Inf
   ----a----------|----------d---------------
      Returns:
      The absolute or percentage distance between the norm value. Therefore the returned value cannot be negative.