Package org.odpi.openmetadata.adapters.connectors.surveyaction.surveyfile

Enum Class SurveyFileAnnotationType

java.lang.Object

java.lang.Enum<SurveyFileAnnotationType>

org.odpi.openmetadata.adapters.connectors.surveyaction.surveyfile.SurveyFileAnnotationType

All Implemented Interfaces:

Serializable, Comparable<SurveyFileAnnotationType>, Constable

public enum SurveyFileAnnotationType
extends Enum<SurveyFileAnnotationType>

The SurveyFileAnnotationType enum describes the annotation types used by the File survey action service.

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
MEASUREMENTS

Field Summary

Fields

Modifier and Type	Field	Description
final String	explanation
final List<FileMetric>	metrics
final String	name
final String	openMetadataTypeName
final String	summary

Method Summary

Modifier and Type	Method	Description
String	getAnalysisStep()	Return the analysis step that produces this type of annotation.
AnnotationTypeType	getAnnotationTypeType()	Return the description of this annotation type that can be used in a Connector Provider for a Survey Action Service.
static List<AnnotationTypeType>	getAnnotationTypeTypes()	Return the defined annotation types as a list of annotation type types.
String	getExplanation()	Return the description of the annotation type.
String	getName()	Return the name of the annotation type.
String	getOpenMetadataTypeName()	Return the name of the open metadata type used for this type of annotation.
String	getSummary()	Return the short description of the annotation type.
String	toString()	Output of this enum class and main value.
static SurveyFileAnnotationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SurveyFileAnnotationType[]	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

MEASUREMENTS

public static final SurveyFileAnnotationType MEASUREMENTS

Field Details

name

public final String name

openMetadataTypeName

public final String openMetadataTypeName

summary

public final String summary

explanation

public final String explanation

metrics

public final List<FileMetric> metrics

Method Details

values

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

getAnnotationTypeTypes

public static List<AnnotationTypeType> getAnnotationTypeTypes()

Return the defined annotation types as a list of annotation type types.

Returns:

list

getName

public String getName()

Return the name of the annotation type.

Returns:

string name

getAnalysisStep

public String getAnalysisStep()

Return the analysis step that produces this type of annotation.

Returns:

analysis step name

getOpenMetadataTypeName

public String getOpenMetadataTypeName()

Return the name of the open metadata type used for this type of annotation.

Returns:

type name

getSummary

public String getSummary()

Return the short description of the annotation type.

Returns:

text

getExplanation

public String getExplanation()

Return the description of the annotation type.

Returns:

text

getAnnotationTypeType

public AnnotationTypeType getAnnotationTypeType()

Return the description of this annotation type that can be used in a Connector Provider for a Survey Action Service.

Returns:

annotationType type

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<SurveyFileAnnotationType>

Returns:

string showing enum value