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

Enum Class SurveyDatabaseAnnotationType

java.lang.Object
java.lang.Enum<SurveyDatabaseAnnotationType>
org.odpi.openmetadata.frameworks.surveyaction.controls.SurveyDatabaseAnnotationType
All Implemented Interfaces:
Serializable, Comparable<SurveyDatabaseAnnotationType>, Constable, AnnotationType
public enum SurveyDatabaseAnnotationType extends Enum<SurveyDatabaseAnnotationType> implements AnnotationType
The SurveyDatabaseAnnotationType enum describes the annotation types used by the PostgreSQL server survey action service.

  • Enum Constant Details

  • Field Details

    • name

      public final String name

    • openMetadataTypeName

      public final String openMetadataTypeName

    • summary

      public final String summary

    • explanation

      public final String explanation

    • profilePropertyNames

      public final List<String> profilePropertyNames

    • metrics

      public final List<SurveyMetric> metrics

  • Method Details

    • values

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

    • getPostgresServerAnnotationTypeTypes

      public static List<AnnotationTypeType> getPostgresServerAnnotationTypeTypes()
      Return the defined annotation types for the PostgreSQL Server survey action service as a list of annotation type types.
      Returns:
      list

    • getPostgresDatabaseAnnotationTypeTypes

      public static List<AnnotationTypeType> getPostgresDatabaseAnnotationTypeTypes()
      Return the defined annotation types for the PostgreSQL Database.
      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

    • getProfilePropertyNames

      public List<String> getProfilePropertyNames()
      Return the list of property names that make up this profile entry
      Returns:
      list of property names

    • 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<SurveyDatabaseAnnotationType>
      Returns:
      string showing enum value