org.odpi.openmetadata.frameworks.connectors.properties

Class AssetAnnotation

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyElementBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

org.odpi.openmetadata.frameworks.connectors.properties.AssetAnnotation

All Implemented Interfaces:

Serializable

public class AssetAnnotation
extends AssetElementHeader

An annotation describes the results of an analysis undertaken by an Open Discovery Framework (ODF) discovery service. It describes when the analysis happened, the type of analysis and the results.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Annotation	annotationBean

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

parentAsset

Constructor Summary

Constructors

Constructor and Description
AssetAnnotation(Annotation annotationBean) Bean constructor
AssetAnnotation(AssetDescriptor parentAsset, Annotation annotationBean) Bean constructor with parent asset
AssetAnnotation(AssetDescriptor parentAsset, AssetAnnotation templateAnnotation) Copy/clone Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
AdditionalProperties	getAdditionalProperties() Return the additional properties for the Annotation.
AdditionalProperties	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.
protected Annotation	getAnnotationBean() Return the bean containing all of the properties - used in the cloning process.
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.

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetElementHeader

getAssetClassifications, getElementHeaderBean, getGUID, getType, getURL, hashCode, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.properties.AssetPropertyBase

getParentAsset, getParentAssetName, getParentAssetTypeName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

annotationBean

protected Annotation annotationBean

Constructor Detail

AssetAnnotation

public AssetAnnotation(Annotation annotationBean)

Bean constructor

Parameters:

annotationBean - bean containing all of the properties

AssetAnnotation

public AssetAnnotation(AssetDescriptor parentAsset,
                       Annotation annotationBean)

Bean constructor with parent asset

Parameters:

parentAsset - description of the asset that this annotation is attached to.

annotationBean - bean containing all of the properties

AssetAnnotation

public AssetAnnotation(AssetDescriptor parentAsset,
                       AssetAnnotation templateAnnotation)

Copy/clone Constructor

Parameters:

parentAsset - description of the asset that this annotation is attached to.

templateAnnotation - template object to copy.

Method Detail

getAnnotationBean

protected Annotation getAnnotationBean()

Return the bean containing all of the properties - used in the cloning process.

Returns:

Annotation bean

getReportName

public String getReportName()

Return the name of the discovery analysis report that created this annotation.

Returns:

String report name

getReportDescription

public String getReportDescription()

Return the discovery analysis report description that this annotation is a part of.

Returns:

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.

getAnalysisParameters

public AdditionalProperties getAnalysisParameters()

Return the properties that hold the parameters used to drive the discovery service's analysis.

Returns:

AdditionalProperties object storing the analysis parameters

getAnnotationType

public String getAnnotationType()

Return the informal name for the type of annotation.

Returns:

String annotation type

getSummary

public String getSummary()

Return the summary description for the annotation.

Returns:

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

getExpression

public String getExpression()

Return the expression that represent the relationship between the annotation and the asset.

Returns:

String expression

getExplanation

public String getExplanation()

Return the explanation for the annotation.

Returns:

String 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

getJsonProperties

public String getJsonProperties()

Return the JSON properties associated with the annotation.

Returns:

String JSON properties of annotation

getAnnotationStatus

public AnnotationStatus getAnnotationStatus()

Return the current status of the annotation.

Returns:

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

getSteward

public String getSteward()

Return the name of the steward that reviewed the annotation.

Returns:

String steward's name.

getReviewComment

public String getReviewComment()

Return any comments made by the steward during the review.

Returns:

String review comment

getAdditionalProperties

public AdditionalProperties getAdditionalProperties()

Return the additional properties for the Annotation.

Returns:

AdditionalProperties additional properties object

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class AssetElementHeader

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison