Class Annotation

    • Constructor Summary

      Constructors 
      Constructor Description
      Annotation()
      Default constructor used by subclasses
      Annotation​(Annotation template)
      Copy/clone Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      java.util.Map<java.lang.String,​java.lang.String> getAdditionalProperties()
      Return the additional properties for the Annotation.
      java.lang.String getAnalysisStep()
      Return a description of the analysis step that the discovery service was in when it created the annotation.
      AnnotationStatus getAnnotationStatus()
      Return the current status of the annotation.
      java.lang.String getAnnotationType()
      Return the informal name for the type of annotation.
      int getConfidenceLevel()
      Return the confidence level of the discovery service that the annotation is correct.
      java.lang.String getExplanation()
      Return the explanation for the annotation.
      java.lang.String getExpression()
      Return the expression that represent the relationship between the annotation and the asset.
      java.lang.String getJsonProperties()
      Return the JSON properties associated with the annotation.
      int getNumAttachedAnnotations()
      Return the number of annotations attached to the this annotation.
      java.lang.String getReviewComment()
      Return any comments made by the steward during the review.
      java.util.Date getReviewDate()
      Return the date that this annotation was reviewed.
      java.lang.String getSteward()
      Return the name of the steward that reviewed the annotation.
      java.lang.String getSummary()
      Return the summary description for the annotation.
      int hashCode()
      Create a hash code for this element type.
      void setAdditionalProperties​(java.util.Map<java.lang.String,​java.lang.String> additionalProperties)
      Set up the additional properties for the Annotation.
      void setAnalysisStep​(java.lang.String analysisStep)
      Set up a description of the analysis step that the discovery service was in when it created the annotation.
      void setAnnotationStatus​(AnnotationStatus annotationStatus)
      Set up the current status of the annotation.
      void setAnnotationType​(java.lang.String annotationType)
      Set up the informal name for the type of annotation.
      void setConfidenceLevel​(int confidenceLevel)
      Set up the confidence level of the discovery service that the annotation is correct.
      void setExplanation​(java.lang.String explanation)
      Set up the explanation for the annotation.
      void setExpression​(java.lang.String expression)
      Set up the expression that represent the relationship between the annotation and the asset.
      void setJsonProperties​(java.lang.String jsonProperties)
      Set up the JSON properties associated with the annotation.
      void setNumAttachedAnnotations​(int number)
      Set up the number of annotations attached to the this annotation.
      void setReviewComment​(java.lang.String reviewComment)
      Set up any comments made by the steward during the review.
      void setReviewDate​(java.util.Date reviewDate)
      Set up the date that this annotation was reviewed.
      void setSteward​(java.lang.String steward)
      Set up the name of the steward that reviewed the annotation.
      void setSummary​(java.lang.String summary)
      Set up the summary description for the annotation.
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • 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 java.lang.String getAnnotationType()
        Return the informal name for the type of annotation.
        Returns:
        String annotation type
      • setAnnotationType

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

        public java.lang.String getSummary()
        Return the summary description for the annotation.
        Returns:
        String summary of annotation
      • setSummary

        public void setSummary​(java.lang.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 java.lang.String getExpression()
        Return the expression that represent the relationship between the annotation and the asset.
        Returns:
        String expression
      • setExpression

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

        public java.lang.String getExplanation()
        Return the explanation for the annotation.
        Returns:
        String explanation
      • setExplanation

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

        public java.lang.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​(java.lang.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 java.lang.String getJsonProperties()
        Return the JSON properties associated with the annotation.
        Returns:
        String JSON properties of annotation
      • setJsonProperties

        public void setJsonProperties​(java.lang.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 java.util.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​(java.util.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 java.lang.String getSteward()
        Return the name of the steward that reviewed the annotation.
        Returns:
        String steward's name.
      • setSteward

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

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

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

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

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

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

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class java.lang.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 java.lang.Object
        Returns:
        int hash code