Interface IMatchFunctionFactory

All Known Implementing Classes:
CrossTableMatchFactory, DateRampMatchFactory, ExactNumberMatchFactory, ExactStringMatchFactory, FullTextMatchFactory, LevenshteinMatchFactory, NormDistMatchFactory, NumberRampMatchFactory, RangeMatchFactory, TrigramMatchFactory

public interface IMatchFunctionFactory
This interface may be implemented by objects capable of providing match function implementations of a specific type.
Since:
6.2
Author:
O. Kerpershoek, F. van der Meer
  • Method Summary

    Modifier and Type
    Method
    Description
    This method constructs a match function for a specific match type definition with the specified name and parameters.
    This method returns the type name of the match functions this factory can provide for.
  • Method Details

    • getTypeName

      String getTypeName()
      This method returns the type name of the match functions this factory can provide for.
      Returns:
      the type name of the match functions this factory can provide for.
    • getMatchFunction

      IMatchFunction getMatchFunction(String name, IMatchFunctionParameters parameters)
      This method constructs a match function for a specific match type definition with the specified name and parameters. After construction of this function the object is expected to be reentrant. When a match function could not be created the factory should throw an exception, when the match function could not be found a null pointer should be returned.
      Parameters:
      name - The name of the user created match function.
      parameters - The parameters which can be used to initialize a match function with specific settings.
      Returns:
      A match function implementation object. If the match function was unknown null can be returned.
      Throws:
      InitializationException - This exception is thrown when the match function could not be initialized, for instance due to invalid parameters.