Package com.aquima.interactions.matching.ds

Interface ICrosstableDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ExtXmlCrosstableDS
public interface ICrosstableDS extends IReportingDS
This interface defines the methods that are needed to initialise a crosstable. A cross table is a special match function which can be defined in the studio.
Since:
6.2
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDomainName()
    The unique name of the domain this cross table is defined for.
    String
    getName()
    This method returns the (unique) name of a cross table.
    boolean
    isSymmetric()
    When a cross table is defined as symmetric the match engine knows to check the upper half of the cross table to look for the reverse value if required.
    void
    iterateDistances(ICrosstableDistanceVisitor distanceVisitor)
    This method should initialise the cross table with the correct distances.

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

    addMessage

  • Method Details

    • getName

      String getName()
      This method returns the (unique) name of a cross table. This name is the identifier which can be used to locate a match function from the IMatchEngine interface.
      Returns:
      The (unique) name of the cross table / match function.

    • getDomainName

      String getDomainName()
      The unique name of the domain this cross table is defined for.
      Returns:
      The Id of the domain this cross table is defined for.

    • iterateDistances

      void iterateDistances(ICrosstableDistanceVisitor distanceVisitor)
      This method should initialise the cross table with the correct distances. The addDistance method of the visitor can be invoked to add a distance.

      Note: The diagonal is ignored. (in the example house-house & office-office & barn-barn they are auto 100%)

      A crosstable is defined as such:
      Crosstable definition
      House Office Barn
      House 100 70 50
      Office 70 100 50
      Barn 40 100
      When iterating the distances the permutations and values in the tables are linked. one can omit values from the list. Default one can omit the exact matching values. ( i.e. house-house, office-office etc ) iterate in this example should call:
      • House-Office: 70
      • House-Barn: 50
      • Office-House: 70
      • Office-Barn: 60
      • Barn-house: 40
      Parameters:
      distanceVisitor - The visitor which is used to register the cross table distances to.
      Throws:
      InitializationException - This exception is thrown when invalid values are passed to the visitor.

    • isSymmetric

      boolean isSymmetric()
      When a cross table is defined as symmetric the match engine knows to check the upper half of the cross table to look for the reverse value if required.
      Returns:
      A boolean indicating the cross table is symmetric across the diagonal.