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

Enum Class DataContractQualityMetric

java.lang.Object

java.lang.Enum<DataContractQualityMetric>

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

All Implemented Interfaces:

Serializable, Comparable<DataContractQualityMetric>, Constable

public enum DataContractQualityMetric
extends Enum<DataContractQualityMetric>

DataContractQualityMetric lists the standard metrics evaluated by a library data quality check in an ODCS data contract. 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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DUPLICATE_VALUES	The number of duplicated values.
INVALID_VALUES	The number of values that fail the validity rules.
MISSING_VALUES	The number of missing values (nulls and values in the arguments' missing list).
NULL_VALUES	The number of null values.
ROW_COUNT	The number of rows.

Method Summary

Modifier and Type	Method	Description
static DataContractQualityMetric	fromValue(String value)	Return the enumeration that matches the supplied document value (case-insensitive).
String	getDescription()	Return the description of the meaning of the value.
String	getValue()	Return the string used in the document.
String	toString()	Standard toString method.
static DataContractQualityMetric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataContractQualityMetric[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NULL_VALUES

public static final DataContractQualityMetric NULL_VALUES

The number of null values.

MISSING_VALUES

public static final DataContractQualityMetric MISSING_VALUES

The number of missing values (nulls and values in the arguments' missing list).

INVALID_VALUES

public static final DataContractQualityMetric INVALID_VALUES

The number of values that fail the validity rules.

DUPLICATE_VALUES

public static final DataContractQualityMetric DUPLICATE_VALUES

The number of duplicated values.

ROW_COUNT

public static final DataContractQualityMetric ROW_COUNT

The number of rows.

Method Details

values

public static DataContractQualityMetric[] 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 DataContractQualityMetric 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 DataContractQualityMetric 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<DataContractQualityMetric>

Returns:

print out of variables in a JSON-style