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

Enum Class RelationalDatabaseMetric

java.lang.Object

java.lang.Enum<RelationalDatabaseMetric>

org.odpi.openmetadata.frameworks.surveyaction.measurements.RelationalDatabaseMetric

All Implemented Interfaces:

Serializable, Comparable<RelationalDatabaseMetric>, Constable, SurveyMetric

public enum RelationalDatabaseMetric
extends Enum<RelationalDatabaseMetric>
implements SurveyMetric

RelationalDatabaseMetric describes the metrics for a Relational Database.

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
ACTIVE_TIME	The length of time (milliseconds) that the database was being actively queried.
COLUMN_COUNT	Count of all columns in the tables/views.
DATA_SIZE	Number of stored bytes of data in the surveyed resource.
DATABASE_NAME	Name of the database
LAST_STATISTICS_RESET	Last time that the statistics were reset in the database.
MAT_VIEW_COUNT	Count of materialized views in the database.
ROWS_DELETED	Number of rows deleted from any table in the database.
ROWS_FETCHED	Number of rows retrieved from any table in the database.
ROWS_INSERTED	Number of rows inserted from any table in the database.
ROWS_UPDATED	Number of rows updated from any table in the database.
SCHEMA_COUNT	Number of schemas found in the surveyed resource.
SESSION_TIME	The length of time (milliseconds) that the database had at least one open session from an external client.
TABLE_COUNT	Number of tables found in the database.
VIEW_COUNT	Count of views in the database.

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 RelationalDatabaseMetric	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RelationalDatabaseMetric[]	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

DATABASE_NAME

public static final RelationalDatabaseMetric DATABASE_NAME

Name of the database

SCHEMA_COUNT

public static final RelationalDatabaseMetric SCHEMA_COUNT

Number of schemas found in the surveyed resource.

TABLE_COUNT

public static final RelationalDatabaseMetric TABLE_COUNT

Number of tables found in the database.

VIEW_COUNT

public static final RelationalDatabaseMetric VIEW_COUNT

Count of views in the database.

MAT_VIEW_COUNT

public static final RelationalDatabaseMetric MAT_VIEW_COUNT

Count of materialized views in the database.

COLUMN_COUNT

public static final RelationalDatabaseMetric COLUMN_COUNT

Count of all columns in the tables/views.

DATA_SIZE

public static final RelationalDatabaseMetric DATA_SIZE

Number of stored bytes of data in the surveyed resource.

ROWS_FETCHED

public static final RelationalDatabaseMetric ROWS_FETCHED

Number of rows retrieved from any table in the database.

ROWS_INSERTED

public static final RelationalDatabaseMetric ROWS_INSERTED

Number of rows inserted from any table in the database.

ROWS_UPDATED

public static final RelationalDatabaseMetric ROWS_UPDATED

Number of rows updated from any table in the database.

ROWS_DELETED

public static final RelationalDatabaseMetric ROWS_DELETED

Number of rows deleted from any table in the database.

SESSION_TIME

public static final RelationalDatabaseMetric SESSION_TIME

The length of time (milliseconds) that the database had at least one open session from an external client.

ACTIVE_TIME

public static final RelationalDatabaseMetric ACTIVE_TIME

The length of time (milliseconds) that the database was being actively queried.

LAST_STATISTICS_RESET

public static final RelationalDatabaseMetric LAST_STATISTICS_RESET

Last time that the statistics were reset in the database.

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 RelationalDatabaseMetric[] 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 RelationalDatabaseMetric 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<RelationalDatabaseMetric>

Returns:

string showing enum value