Package org.odpi.openmetadata.frameworks.integration.bitol.odcs

Enum Class DataContractComparisonOperator

java.lang.Object
java.lang.Enum<DataContractComparisonOperator>
org.odpi.openmetadata.frameworks.integration.bitol.odcs.DataContractComparisonOperator
All Implemented Interfaces:
Serializable, Comparable<DataContractComparisonOperator>, Constable
public enum DataContractComparisonOperator extends Enum<DataContractComparisonOperator>
DataContractComparisonOperator lists the operators an ODCS data quality check uses to compare the measured value with its threshold values. The Bitol standards carry these values as strings, and permit additional values, so the beans hold the string and this enumeration documents the standard values and provides a lookup.

  • Enum Constant Details

    • MUST_BE

      public static final DataContractComparisonOperator MUST_BE
      The measured value must equal the threshold value.

    • MUST_NOT_BE

      public static final DataContractComparisonOperator MUST_NOT_BE
      The measured value must not equal the threshold value.

    • MUST_BE_GREATER_THAN

      public static final DataContractComparisonOperator MUST_BE_GREATER_THAN
      The measured value must be greater than the threshold value.

    • MUST_BE_GREATER_OR_EQUAL_TO

      public static final DataContractComparisonOperator MUST_BE_GREATER_OR_EQUAL_TO
      The measured value must be greater than or equal to the threshold value.

    • MUST_BE_LESS_THAN

      public static final DataContractComparisonOperator MUST_BE_LESS_THAN
      The measured value must be less than the threshold value.

    • MUST_BE_LESS_OR_EQUAL_TO

      public static final DataContractComparisonOperator MUST_BE_LESS_OR_EQUAL_TO
      The measured value must be less than or equal to the threshold value.

    • MUST_BE_BETWEEN

      public static final DataContractComparisonOperator MUST_BE_BETWEEN
      The measured value must lie between the two threshold values.

    • MUST_NOT_BE_BETWEEN

      public static final DataContractComparisonOperator MUST_NOT_BE_BETWEEN
      The measured value must not lie between the two threshold values.

  • Method Details

    • values

      public static DataContractComparisonOperator[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DataContractComparisonOperator valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public String getValue()
      Return the string used in the document.
      Returns:
      string value

    • getDescription

      public String getDescription()
      Return the description of the meaning of the value.
      Returns:
      string description

    • fromValue

      public static DataContractComparisonOperator fromValue(String value)
      Return the enumeration that matches the supplied document value (case-insensitive).
      Parameters:
      value - string from the document
      Returns:
      matching enumeration or null if the value is not one of the standard values

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Enum<DataContractComparisonOperator>
      Returns:
      print out of variables in a JSON-style