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

Class AnnotationTypeType

java.lang.Object
org.odpi.openmetadata.frameworks.surveyaction.controls.AnnotationTypeType
public class AnnotationTypeType extends Object
AnnotationTypeType describes an annotation type of survey action service it is part of the metadata to help tools understand the operations of a service.

  • Field Details

    • analysisStepName

      public String analysisStepName
      The analysis step that produces this annotation.

    • openMetadataTypeName

      public String openMetadataTypeName
      The open metadata type used for this annotation type.

  • Constructor Details

    • AnnotationTypeType

      public AnnotationTypeType()
      Default constructor

    • AnnotationTypeType

      public AnnotationTypeType(AnnotationTypeType template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getName

      public String getName()
      Return the name of the annotation type.
      Returns:
      string name

    • setName

      public void setName(String name)
      Set up the name of the annotation type.
      Parameters:
      name - string name

    • getAnalysisStepName

      public String getAnalysisStepName()
      Return the analysis step that produces this type of annotation.
      Returns:
      completion status

    • setAnalysisStepName

      public void setAnalysisStepName(String analysisStepName)
      Set up the analysis step that produces this type of annotation.
      Parameters:
      analysisStepName - string

    • getOpenMetadataTypeName

      public String getOpenMetadataTypeName()
      Return the name of the open metadata type used for this type of annotation.
      Returns:
      type name

    • setOpenMetadataTypeName

      public void setOpenMetadataTypeName(String openMetadataTypeName)
      Set up the name of the open metadata type used for this type of annotation.
      Parameters:
      openMetadataTypeName - typeName

    • getSummary

      public String getSummary()
      Return the short description of the annotation type.
      Returns:
      string

    • setSummary

      public void setSummary(String summary)
      Set up the short description of the annotation type.
      Parameters:
      summary - string

    • getExplanation

      public String getExplanation()
      Return the description of the annotation type processing.
      Returns:
      string

    • setExplanation

      public void setExplanation(String explanation)
      Set up the description of the annotation type processing.
      Parameters:
      explanation - string

    • getExpression

      public String getExpression()
      Return the expression used in the annotation type processing.
      Returns:
      string

    • setExpression

      public void setExpression(String expression)
      Set up the expression used in the annotation type processing.
      Parameters:
      expression - string

    • getOtherPropertyValues

      public Map<String,String> getOtherPropertyValues()
      Return a map of property name to property value to provide additional information for this governance service.
      Returns:
      map of string to string

    • setOtherPropertyValues

      public void setOtherPropertyValues(Map<String,String> otherPropertyValues)
      Set up a map of property name to property value to provide additional information for this governance service..
      Parameters:
      otherPropertyValues - map of string to string

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Object
      Returns:
      return string containing the property names and values

    • equals

      public boolean equals(Object objectToCompare)
      Return comparison result based on the content of the properties.
      Overrides:
      equals in class Object
      Parameters:
      objectToCompare - test object
      Returns:
      result of comparison

    • hashCode

      public int hashCode()
      Return hash code for this object
      Overrides:
      hashCode in class Object
      Returns:
      int hash code