Package com.aquima.interactions.matching.ds

Interface ICaseBaseDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ExtXmlCaseBaseDS, ReportingCaseBaseDS
public interface ICaseBaseDS extends IReportingDS
This interface defines the methods that are needed to initialise a casebase.
Since:
6.2
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getCaseThresholdPercentage()
    This method returns the default threshold percentage for this casebase's cases.
    String
    getEntityName()
    This method returns the entity name for which this casebase was defined.
    String
    getKeyField()
    This method returns the attribute that should be used to group matching cases on.
    int
    getMaxKeyResults()
    This methods returns the maximum number of scores that should be grouped on a single unique key-field value.
    int
    getMaxResults()
    This method returns the setting which specified the maximum amount of matches that will be returned.
    void
    iterateCases(ICaseVisitor visitor)
    The implementor of this method should invoke the visitor for every case available within this case base.
    void
    iterateMatchDefinitions(IMatchDefinitionVisitor visitor)
    The implementor of this method should invoke the visitor for every available match definition which should be used.
    boolean
    updateCase(String caseName, ICaseVisitor visitor)
    The implementor of this method should invoke the visitor for the named case within this case base.

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

    addMessage

  • Method Details

    • getEntityName

      String getEntityName()
      This method returns the entity name for which this casebase was defined.
      Returns:
      the entity name for this casebase which is never null.

    • getCaseThresholdPercentage

      int getCaseThresholdPercentage()
      This method returns the default threshold percentage for this casebase's cases. The value supplied can lie between 0 and 100.
      Returns:
      The threshold that should be used for this attribute.

    • getMaxResults

      int getMaxResults()
      This method returns the setting which specified the maximum amount of matches that will be returned.
      Returns:
      the maximum result value between 1 and max-int

    • 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. The key field can optionally be null.
      Returns:
      the key field attribute name when available, null otherwise.

    • getMaxKeyResults

      int getMaxKeyResults()
      This methods returns the maximum number of scores that should be grouped on a single unique key-field value.
      Returns:
      the maximum number of scores that should be grouped on a single unique key-field value.

    • iterateMatchDefinitions

      void iterateMatchDefinitions(IMatchDefinitionVisitor visitor)
      The implementor of this method should invoke the visitor for every available match definition which should be used. A match definition are settings on a per attribute basis within the case base which can be used by the match engine. The match settings are stored on a case base level per attribute.
      Parameters:
      visitor - The match definition visitor which can be used to register the match definitions on.
      Throws:
      InitializationException - When there was a problem during initialisation of the match definitions.

    • iterateCases

      void iterateCases(ICaseVisitor visitor)
      The implementor of this method should invoke the visitor for every case available within this case base.
      Parameters:
      visitor - The case visitor which is used to register the cases on.
      Throws:
      InitializationException - When there was a problem during initialisation of the cases.

    • updateCase

      @CheckReturnValue(explanation="Spotbugs thinks that this method doesn\'t have a side effect. However, it can.") boolean updateCase(String caseName, ICaseVisitor visitor)
      The implementor of this method should invoke the visitor for the named case within this case base.
      Parameters:
      caseName - the name of the case to visit
      visitor - the case visitor which is used to register the case on.
      Returns:
      true if the case is inserted.
      Throws:
      CaseUpdateException - When there was a problem during insertion or update of the case.