Package com.orchestranetworks.addon.mame.model.decisiontree

Interface DecisionField

public interface DecisionField
Represents the information of a decision field that belongs to a decision tree node.

  • Method Details

    • getLabel

      String getLabel()
      Gets the name of this field.
      Returns:
      String The name of this field.

    • getPath

      com.orchestranetworks.schema.Path getPath()
      Gets the absolute path of this field in the data model.
      Returns:
      Path The absolute path of this field in the data model.

    • getFieldComparison

      FieldComparison getFieldComparison()
      Gets the comparison used to compare two fields in two different records
      Returns:
      FieldComparison The comparison used to compare two fields in two different records. TODO: cls

    • getComparisonAlgorithm

      @Deprecated FieldComparisonAlgorithm getComparisonAlgorithm()
      Deprecated.
      This method is no longer acceptable to get algorithm used to compute a score between two fields in two different records.

      Use getFieldComparison() instead.

      Gets the algorithm used to compute a score.
      Returns:
      FieldComparisonAlgorithm The algorithm used to compute a score of two fields in two different records.

    • getComparisonParameters

      Collection<ParameterValue> getComparisonParameters()
      Gets all parameters used to execute a comparison algorithm.

      If the comparison function used in the decision node is DecisionNodeComparisonType.ALL_FIELD_MATCH or DecisionNodeComparisonType.AT_LEAST_N_FIELD_MATCH, all decision fields in this node use a parameter named minimumScore and some specific parameters are used for certain field comparison algorithms:

      If the comparison function used in the decision node is DecisionNodeComparisonType.AVERAGE, all decision fields in this node use a parameter named weight

      Returns:
      Collection All parameters used to execute a comparison algorithm.

    • isMatchWhenBothValuesAreNull

      Boolean isMatchWhenBothValuesAreNull()
      Returns:
      true if the add-on identifies two matched fields where both field values are null.

    • isMatchWhenOneValueIsNull

      Boolean isMatchWhenOneValueIsNull()
      Returns:
      true if the add-on identifies two matched fields where only one field value is null.

    • getScore

      Double getScore()
      Gets the computed score.
      Returns:
      Double The score computed when comparing two fields in two different records.

      For example:

      • If the Exact algorithm is used, the score will be 0.0 or 1.0.
      • If the Levenshtein algorithm is used, the score will be in the range of 0.0 to 1.0.