Annotation (Discovery Engine OMAS API 1.0 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.discoveryengine.properties.PropertyBase
- - org.odpi.openmetadata.accessservices.discoveryengine.properties.ElementHeader
  - - org.odpi.openmetadata.accessservices.discoveryengine.properties.Annotation

All Implemented Interfaces:

Serializable
```
public class Annotation
extends ElementHeader
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`additionalProperties`
`protected Map<String,Object>`	`analysisParameters`
`protected String`	`analysisStep`
`protected AnnotationStatus`	`annotationStatus`
`protected String`	`annotationType`
`protected int`	`confidenceLevel`
`protected Date`	`creationDate`
`protected String`	`explanation`
`protected String`	`expression`
`protected String`	`jsonProperties`
`protected String`	`reportDescription`
`protected String`	`reportName`
`protected String`	`reviewComment`
`protected Date`	`reviewDate`
`protected String`	`steward`
`protected String`	`summary`

Fields inherited from class org.odpi.openmetadata.accessservices.discoveryengine.properties.ElementHeader
classifications, guid, type, url

Constructor Summary

Constructors
Constructor and Description

Annotation()
Default constructor used by subclasses

Annotation(Annotation templateAnnotation)
Copy/clone Constructor

Constructors
Constructor and Description
`Annotation()` Default constructor used by subclasses
`Annotation(Annotation templateAnnotation)` Copy/clone Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Compare the values of the supplied object with those stored in the current object.
`Map<String,Object>`	`getAdditionalProperties()` Return the additional properties for the Annotation.
`Map<String,Object>`	`getAnalysisParameters()` Return the properties that hold the parameters used to drive the discovery service's analysis.
`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.
`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.
`Date`	`getCreationDate()` Return the creation date for the annotation.
`String`	`getExplanation()` Return the explanation for the annotation.
`String`	`getExpression()` Return the expression that represent the relationship between the annotation and the asset.
`String`	`getJsonProperties()` Return the JSON properties associated with the annotation.
`String`	`getReportDescription()` Return the discovery analysis report description that this annotation is a part of.
`String`	`getReportName()` Return the name of the discovery analysis report that created this annotation.
`String`	`getReviewComment()` Return any comments made by the steward during the review.
`Date`	`getReviewDate()` Return the date that this annotation was reviewed.
`String`	`getSteward()` Return the name of the steward that reviewed the annotation.
`String`	`getSummary()` Return the summary description for the annotation.
`void`	`setAdditionalProperties(Map<String,Object> additionalProperties)` Set up the additional properties for the Annotation.
`void`	`setAnalysisParameters(Map<String,Object> analysisParameters)` Set up the properties that hold the parameters used to drive the discovery service's analysis.
`void`	`setAnalysisStep(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(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`	`setCreationDate(Date creationDate)` Set up the creation date for the annotation.
`void`	`setExplanation(String explanation)` Set up the explanation for the annotation.
`void`	`setExpression(String expression)` Set up the expression that represent the relationship between the annotation and the asset.
`void`	`setJsonProperties(String jsonProperties)` Set up the JSON properties associated with the annotation.
`void`	`setReportDescription(String reportDescription)` Set up the discovery analysis report description that this annotation is a part of.
`void`	`setReportName(String reportName)` Set up the name of the discovery analysis report that created this annotation.
`void`	`setReviewComment(String reviewComment)` Set up any comments made by the steward during the review.
`void`	`setReviewDate(Date reviewDate)` Set up the date that this annotation was reviewed.
`void`	`setSteward(String steward)` Set up the name of the steward that reviewed the annotation.
`void`	`setSummary(String summary)` Set up the summary description for the annotation.
`String`	`toString()` Standard toString method.

Methods inherited from class org.odpi.openmetadata.accessservices.discoveryengine.properties.ElementHeader
getClassifications, getGUID, getType, getURL, hashCode, setClassifications, setGUID, setType, setURL

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - reportName
```
protected String reportName
```
  - reportDescription
```
protected String reportDescription
```
  - creationDate
```
protected Date creationDate
```
  - analysisParameters
```
protected Map<String,Object> analysisParameters
```
  - annotationType
```
protected String annotationType
```
  - summary
```
protected String summary
```
  - confidenceLevel
```
protected int confidenceLevel
```
  - expression
```
protected String expression
```
  - explanation
```
protected String explanation
```
  - analysisStep
```
protected String analysisStep
```
  - jsonProperties
```
protected String jsonProperties
```
  - annotationStatus
```
protected AnnotationStatus annotationStatus
```
  - reviewDate
```
protected Date reviewDate
```
  - steward
```
protected String steward
```
  - reviewComment
```
protected String reviewComment
```
  - additionalProperties
```
protected Map<String,Object> additionalProperties
```
- Constructor Detail
  - Annotation
```
public Annotation()
```
    Default constructor used by subclasses
  - Annotation
```
public Annotation(Annotation templateAnnotation)
```
    Copy/clone Constructor
    
    Parameters:
    
    templateAnnotation - template object to copy.
- Method Detail
  - getReportName
```
public String getReportName()
```
    Return the name of the discovery analysis report that created this annotation.
    
    Returns:
    
    String report name
  - setReportName
```
public void setReportName(String reportName)
```
    Set up the name of the discovery analysis report that created this annotation.
    
    Parameters:
    
    reportName - String report name
  - getReportDescription
```
public String getReportDescription()
```
    Return the discovery analysis report description that this annotation is a part of.
    
    Returns:
    
    String report description
  - setReportDescription
```
public void setReportDescription(String reportDescription)
```
    Set up the discovery analysis report description that this annotation is a part of.
    
    Parameters:
    
    reportDescription - String report description
  - getCreationDate
```
public Date getCreationDate()
```
    Return the creation date for the annotation. If this date is not known then null is returned.
    
    Returns:
    
    Date that the annotation was created.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    Set up the creation date for the annotation. If this date is not known then null is returned.
    
    Parameters:
    
    creationDate - Date that the annotation was created.
  - getAnalysisParameters
```
public Map<String,Object> getAnalysisParameters()
```
    Return the properties that hold the parameters used to drive the discovery service's analysis.
    
    Returns:
    
    AdditionalProperties object storing the analysis parameters
  - setAnalysisParameters
```
public void setAnalysisParameters(Map<String,Object> analysisParameters)
```
    Set up the properties that hold the parameters used to drive the discovery service's analysis.
    
    Parameters:
    
    analysisParameters - AdditionalProperties object storing the analysis parameters
  - 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
  - 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,Object> getAdditionalProperties()
```
    Return the additional properties for the Annotation.
    
    Returns:
    
    AdditionalProperties additional properties object
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```
    Set up the additional properties for the Annotation.
    
    Parameters:
    
    additionalProperties - additional properties object
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class ElementHeader
    
    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 ElementHeader
    
    Parameters:
    
    objectToCompare - supplied object
    
    Returns:
    
    boolean result of comparison

Class Annotation

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.discoveryengine.properties.ElementHeader

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.accessservices.discoveryengine.properties.ElementHeader

Methods inherited from class java.lang.Object

Field Detail

reportName

reportDescription

creationDate

analysisParameters

annotationType

summary

confidenceLevel

expression

explanation

analysisStep

jsonProperties

annotationStatus

reviewDate

steward

reviewComment

additionalProperties

Constructor Detail

Annotation

Annotation

Method Detail

getReportName

setReportName

getReportDescription

setReportDescription

getCreationDate

setCreationDate

getAnalysisParameters

setAnalysisParameters

getAnnotationType

setAnnotationType

getSummary

setSummary

getConfidenceLevel

setConfidenceLevel

getExpression

setExpression

getExplanation

setExplanation

getAnalysisStep

setAnalysisStep

getJsonProperties

setJsonProperties

getAnnotationStatus

setAnnotationStatus

getReviewDate

setReviewDate

getSteward

setSteward

getReviewComment

setReviewComment

getAdditionalProperties

setAdditionalProperties

toString

equals