Package org.odpi.openmetadata.frameworks.surveyaction.controls

Enum Class AnnotationType

java.lang.Object
java.lang.Enum<AnnotationType>
org.odpi.openmetadata.frameworks.surveyaction.controls.AnnotationType
All Implemented Interfaces:
Serializable, Comparable<AnnotationType>, Constable
public enum AnnotationType extends Enum<AnnotationType>
The AnnotationType enum describes the annotation types used by a survey action service. This class is a template for survey writers to copy and fill out.

  • Enum Constant Details

    • EXAMPLE_ANNOTATION_TYPE

      public static final AnnotationType EXAMPLE_ANNOTATION_TYPE

  • Field Details

    • name

      public final String name

    • analysisStep

      public final AnalysisStep analysisStep

    • openMetadataTypeName

      public final String openMetadataTypeName

    • summary

      public final String summary

    • explanation

      public final String explanation

    • expression

      public final String expression

  • Method Details

    • values

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

    • 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

    • getExpression

      public String getExpression()
      Return the expression used in the annotation type processing.
      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<AnnotationType>
      Returns:
      string showing enum value