Enum Class SurveyFileAnnotationType
java.lang.Object
java.lang.Enum<SurveyFileAnnotationType>
org.odpi.openmetadata.adapters.connectors.surveyaction.controls.SurveyFileAnnotationType
- All Implemented Interfaces:
Serializable
,Comparable<SurveyFileAnnotationType>
,Constable
,AnnotationType
public enum SurveyFileAnnotationType
extends Enum<SurveyFileAnnotationType>
implements AnnotationType
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
-
Field Summary
Modifier and TypeFieldDescriptionfinal AnalysisStep
final String
final List<SurveyMetric>
final String
final String
final String
-
Method Summary
Modifier and TypeMethodDescriptionReturn the analysis step that produces this type of annotation.Return the description of this annotation type that can be used in a Connector Provider for a Survey Action Service.static List<AnnotationTypeType>
Return the defined annotation types as a list of annotation type types.Return the description of the annotation type.Return the expression used in the annotation type processing.static List<AnnotationTypeType>
Return the defined annotation types as a list of annotation type types.getName()
Return the name of the annotation type.Return the name of the open metadata type used for this type of annotation.Return the short description of the annotation type.toString()
Output of this enum class and main value.static SurveyFileAnnotationType
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.
-
Enum Constant Details
-
MEASUREMENTS
-
DERIVE_SCHEMA_FROM_DATA
-
-
Field Details
-
name
-
openMetadataTypeName
-
analysisStep
-
summary
-
explanation
-
metrics
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getCSVSurveyAnnotationTypeTypes
Return the defined annotation types as a list of annotation type types.- Returns:
- list
-
getFileSurveyAnnotationTypeTypes
Return the defined annotation types as a list of annotation type types.- Returns:
- list
-
getName
Return the name of the annotation type.- Specified by:
getName
in interfaceAnnotationType
- Returns:
- string name
-
getAnalysisStep
Return the analysis step that produces this type of annotation.- Specified by:
getAnalysisStep
in interfaceAnnotationType
- Returns:
- analysis step name
-
getOpenMetadataTypeName
Return the name of the open metadata type used for this type of annotation.- Specified by:
getOpenMetadataTypeName
in interfaceAnnotationType
- Returns:
- type name
-
getSummary
Return the short description of the annotation type.- Specified by:
getSummary
in interfaceAnnotationType
- Returns:
- text
-
getExplanation
Return the description of the annotation type.- Specified by:
getExplanation
in interfaceAnnotationType
- Returns:
- text
-
getExpression
Return the expression used in the annotation type processing.- Specified by:
getExpression
in interfaceAnnotationType
- Returns:
- string
-
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
Output of this enum class and main value.- Overrides:
toString
in classEnum<SurveyFileAnnotationType>
- Returns:
- string showing enum value
-