Package org.odpi.openmetadata.frameworks.surveyaction.measurements

Enum Class RelationalColumnMetric

java.lang.Object

java.lang.Enum<RelationalColumnMetric>

org.odpi.openmetadata.frameworks.surveyaction.measurements.RelationalColumnMetric

All Implemented Interfaces:

Serializable, Comparable<RelationalColumnMetric>, Constable, SurveyMetric

public enum RelationalColumnMetric
extends Enum<RelationalColumnMetric>
implements SurveyMetric

RelationalColumnMetric describes the metrics for a Relational Column.

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
AVERAGE_WIDTH	Average width of the values in this column.
COLUMN_NAME	Name of the column within the table.
COLUMN_NOT_NULL	Is a null value prohibited in this column?
COLUMN_QNAME	Qualified name of the column showing the database name, schema name and table name.
COLUMN_SIZE	Number of stored bytes in the column.
COLUMN_TYPE	Data type of column.
MOST_COMMON_VALUES	List of the most common values stored in this column.
MOST_COMMON_VALUES_FREQUENCY	The frequency that each of the most common values occur.
NUMBER_OF_DISTINCT_VALUES	Number of distinct values stored in this column.

Field Summary

Fields

Modifier and Type	Field	Description
final String	dataType
final String	description
final String	displayName
final String	propertyName

Method Summary

Modifier and Type	Method	Description
String	getDataType()	Return the data type of the property used to store the measure.
String	getDescription()	Return the description of the metric.
String	getDisplayName()	Return the name of the metric.
static List<SurveyMetric>	getMetrics()	Return the defined metrics as a list
String	getPropertyName()	Return the property name used to store the measurement.
String	toString()	Output of this enum class and main value.
static RelationalColumnMetric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RelationalColumnMetric[]	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

COLUMN_QNAME

public static final RelationalColumnMetric COLUMN_QNAME

Qualified name of the column showing the database name, schema name and table name.

COLUMN_NAME

public static final RelationalColumnMetric COLUMN_NAME

Name of the column within the table.

COLUMN_SIZE

public static final RelationalColumnMetric COLUMN_SIZE

Number of stored bytes in the column.

COLUMN_TYPE

public static final RelationalColumnMetric COLUMN_TYPE

Data type of column.

AVERAGE_WIDTH

public static final RelationalColumnMetric AVERAGE_WIDTH

Average width of the values in this column.

NUMBER_OF_DISTINCT_VALUES

public static final RelationalColumnMetric NUMBER_OF_DISTINCT_VALUES

Number of distinct values stored in this column.

MOST_COMMON_VALUES

public static final RelationalColumnMetric MOST_COMMON_VALUES

List of the most common values stored in this column.

MOST_COMMON_VALUES_FREQUENCY

public static final RelationalColumnMetric MOST_COMMON_VALUES_FREQUENCY

The frequency that each of the most common values occur.

COLUMN_NOT_NULL

public static final RelationalColumnMetric COLUMN_NOT_NULL

Is a null value prohibited in this column?

Field Details

propertyName

public final String propertyName

dataType

public final String dataType

displayName

public final String displayName

description

public final String description

Method Details

values

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

getPropertyName

public String getPropertyName()

Return the property name used to store the measurement.

Specified by:

getPropertyName in interface SurveyMetric

Returns:

name

getDataType

public String getDataType()

Return the data type of the property used to store the measure.

Specified by:

getDataType in interface SurveyMetric

Returns:

data type name

getDisplayName

public String getDisplayName()

Return the name of the metric.

Specified by:

getDisplayName in interface SurveyMetric

Returns:

string name

getDescription

public String getDescription()

Return the description of the metric.

Specified by:

getDescription in interface SurveyMetric

Returns:

text

getMetrics

public static List<SurveyMetric> getMetrics()

Return the defined metrics as a list

Returns:

list

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<RelationalColumnMetric>

Returns:

string showing enum value