Package org.odpi.openmetadata.frameworks.discovery.properties

Class Annotation

    • Constructor Detail

      • Annotation

        public Annotation()
        Default constructor used by subclasses

      • Annotation

        public Annotation​(Annotation template)
        Copy/clone Constructor
        Parameters:
        template - template object to copy.

    • Method Detail

      • getAnnotationType

        public String getAnnotationType()
        Return the informal name for the type of annotation.
        Returns:
        String annotation type

      • setAnnotationType

        public void setAnnotationType​(String annotationType)
        Set up the informal name for the type of annotation.
        Parameters:
        annotationType - String annotation type

      • getSummary

        public String getSummary()
        Return the summary description for the annotation.
        Returns:
        String summary of annotation

      • setSummary

        public void setSummary​(String summary)
        Set up the summary description for the annotation.
        Parameters:
        summary - String summary of annotation

      • getConfidenceLevel

        public int getConfidenceLevel()
        Return the confidence level of the discovery service that the annotation is correct.
        Returns:
        int confidence level

      • setConfidenceLevel

        public void setConfidenceLevel​(int confidenceLevel)
        Set up the confidence level of the discovery service that the annotation is correct.
        Parameters:
        confidenceLevel - int confidence level

      • getExpression

        public String getExpression()
        Return the expression that represent the relationship between the annotation and the asset.
        Returns:
        String expression

      • setExpression

        public void setExpression​(String expression)
        Set up the expression that represent the relationship between the annotation and the asset.
        Parameters:
        expression - String expression

      • getExplanation

        public String getExplanation()
        Return the explanation for the annotation.
        Returns:
        String explanation

      • setExplanation

        public void setExplanation​(String explanation)
        Set up the explanation for the annotation.
        Parameters:
        explanation - explanation

      • getAnalysisStep

        public String getAnalysisStep()
        Return a description of the analysis step that the discovery service was in when it created the annotation.
        Returns:
        String analysis step

      • setAnalysisStep

        public void setAnalysisStep​(String analysisStep)
        Set up a description of the analysis step that the discovery service was in when it created the annotation.
        Parameters:
        analysisStep - analysis step

      • getJsonProperties

        public String getJsonProperties()
        Return the JSON properties associated with the annotation.
        Returns:
        String JSON properties of annotation

      • setJsonProperties

        public void setJsonProperties​(String jsonProperties)
        Set up the JSON properties associated with the annotation.
        Parameters:
        jsonProperties - JSON properties of annotation

      • getAnnotationStatus

        public AnnotationStatus getAnnotationStatus()
        Return the current status of the annotation.
        Returns:
        AnnotationStatus current status of annotation

      • setAnnotationStatus

        public void setAnnotationStatus​(AnnotationStatus annotationStatus)
        Set up the current status of the annotation.
        Parameters:
        annotationStatus - current status of annotation

      • getNumAttachedAnnotations

        public int getNumAttachedAnnotations()
        Return the number of annotations attached to the this annotation. These generally add further information.
        Returns:
        number of annotations

      • setNumAttachedAnnotations

        public void setNumAttachedAnnotations​(int number)
        Set up the number of annotations attached to the this annotation. These generally add further information.
        Parameters:
        number - number of annotations

      • getReviewDate

        public Date getReviewDate()
        Return the date that this annotation was reviewed. If no review has taken place then this property is null.
        Returns:
        Date review date

      • setReviewDate

        public void setReviewDate​(Date reviewDate)
        Set up the date that this annotation was reviewed. If no review has taken place then this property is null.
        Parameters:
        reviewDate - review date

      • getSteward

        public String getSteward()
        Return the name of the steward that reviewed the annotation.
        Returns:
        String steward's name.

      • setSteward

        public void setSteward​(String steward)
        Set up the name of the steward that reviewed the annotation.
        Parameters:
        steward - steward's name.

      • getReviewComment

        public String getReviewComment()
        Return any comments made by the steward during the review.
        Returns:
        String review comment

      • setReviewComment

        public void setReviewComment​(String reviewComment)
        Set up any comments made by the steward during the review.
        Parameters:
        reviewComment - review comment

      • getAdditionalProperties

        public Map<String,​String> getAdditionalProperties()
        Return the additional properties for the Annotation.
        Returns:
        properties map

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​String> additionalProperties)
        Set up the additional properties for the Annotation.
        Parameters:
        additionalProperties - properties map

      • toString

        public String toString()
        Standard toString method.
        Overrides:
        toString in class Object
        Returns:
        print out of variables in a JSON-style

      • equals

        public boolean equals​(Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class Object
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison

      • hashCode

        public int hashCode()
        Create a hash code for this element type.
        Overrides:
        hashCode in class Object
        Returns:
        int hash code