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

Enum Class SurveyFolderAnnotationType

java.lang.Object

java.lang.Enum<SurveyFolderAnnotationType>

org.odpi.openmetadata.adapters.connectors.surveyaction.controls.SurveyFolderAnnotationType

All Implemented Interfaces:

Serializable, Comparable<SurveyFolderAnnotationType>, Constable, AnnotationType

public enum SurveyFolderAnnotationType
extends Enum<SurveyFolderAnnotationType>
implements AnnotationType

The SurveyFolderAnnotationType enum describes the annotation types used by the folder 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
INACCESSIBLE_FILES
MEASUREMENTS
MISSING_REF_DATA
PROFILE_ASSET_TYPES
PROFILE_DEP_IMPL_TYPES
PROFILE_FILE_EXTENSIONS
PROFILE_FILE_NAMES
PROFILE_FILE_TYPES

Field Summary

Fields

Modifier and Type	Field	Description
final AnalysisStep	analysisStep
final String	explanation
final List<FileDirectoryMetric>	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	getExpression()	Return the expression used in the annotation type processing.
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 SurveyFolderAnnotationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SurveyFolderAnnotationType[]	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 SurveyFolderAnnotationType MEASUREMENTS

PROFILE_FILE_EXTENSIONS

public static final SurveyFolderAnnotationType PROFILE_FILE_EXTENSIONS

PROFILE_FILE_NAMES

public static final SurveyFolderAnnotationType PROFILE_FILE_NAMES

PROFILE_FILE_TYPES

public static final SurveyFolderAnnotationType PROFILE_FILE_TYPES

PROFILE_ASSET_TYPES

public static final SurveyFolderAnnotationType PROFILE_ASSET_TYPES

PROFILE_DEP_IMPL_TYPES

public static final SurveyFolderAnnotationType PROFILE_DEP_IMPL_TYPES

MISSING_REF_DATA

public static final SurveyFolderAnnotationType MISSING_REF_DATA

INACCESSIBLE_FILES

public static final SurveyFolderAnnotationType INACCESSIBLE_FILES

Field Details

name

public final String name

openMetadataTypeName

public final String openMetadataTypeName

analysisStep

public final AnalysisStep analysisStep

summary

public final String summary

explanation

public final String explanation

metrics

public final List<FileDirectoryMetric> metrics

Method Details

values

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

Specified by:

getName in interface AnnotationType

Returns:

string name

getAnalysisStep

public String getAnalysisStep()

Return the analysis step that produces this type of annotation.

Specified by:

getAnalysisStep in interface AnnotationType

Returns:

analysis step name

getOpenMetadataTypeName

public String getOpenMetadataTypeName()

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

Specified by:

getOpenMetadataTypeName in interface AnnotationType

Returns:

type name

getSummary

public String getSummary()

Return the short description of the annotation type.

Specified by:

getSummary in interface AnnotationType

Returns:

text

getExplanation

public String getExplanation()

Return the description of the annotation type.

Specified by:

getExplanation in interface AnnotationType

Returns:

text

getExpression

public String getExpression()

Return the expression used in the annotation type processing.

Specified by:

getExpression in interface AnnotationType

Returns:

string

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<SurveyFolderAnnotationType>

Returns:

string showing enum value