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

Enum Class DataContractQualitySeverity

java.lang.Object

java.lang.Enum<DataContractQualitySeverity>

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

All Implemented Interfaces:

Serializable, Comparable<DataContractQualitySeverity>, Constable

public enum DataContractQualitySeverity
extends Enum<DataContractQualitySeverity>

DataContractQualitySeverity lists the standard severities of a failed 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
ERROR	A failure means the data does not meet the contract and should not be used.
INFO	A failure is informational and does not affect the use of the data.
WARNING	A failure should be reviewed but the data remains usable.

Method Summary

Modifier and Type	Method	Description
static DataContractQualitySeverity	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 DataContractQualitySeverity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataContractQualitySeverity[]	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

INFO

public static final DataContractQualitySeverity INFO

A failure is informational and does not affect the use of the data.

WARNING

public static final DataContractQualitySeverity WARNING

A failure should be reviewed but the data remains usable.

ERROR

public static final DataContractQualitySeverity ERROR

A failure means the data does not meet the contract and should not be used.

Method Details

values

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

Returns:

print out of variables in a JSON-style