Package org.odpi.openmetadata.frameworks.surveyaction.properties

Class QualityAnnotation

java.lang.Object

org.odpi.openmetadata.frameworks.surveyaction.properties.PropertyBase

org.odpi.openmetadata.frameworks.surveyaction.properties.Annotation

org.odpi.openmetadata.frameworks.surveyaction.properties.DataFieldAnnotation

org.odpi.openmetadata.frameworks.surveyaction.properties.QualityAnnotation

public class QualityAnnotation
extends DataFieldAnnotation

QualityAnnotation records a quality assessment of the data. It can be attached to the whole asset or a specific data field. Since there are different aspects of quality, the quality dimension characterizes the type of quality it is measuring. Then there is a score. This is an integer and can be used as needed. However, a suggestion is to use it as a percentage score - so a number between 0 and 100 where 100 is the best.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.surveyaction.properties.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
QualityAnnotation()	Default constructor
QualityAnnotation(QualityAnnotation template)	Copy clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
String	getQualityDimension()	Return the type of quality being measured.
int	getQualityScore()	Return a quality score between 0 and 100 - 100 is the best.
int	hashCode()	Create a hash code for this element type.
void	setQualityDimension(String qualityDimension)	Set up the type of quality being measured.
void	setQualityScore(int qualityScore)	Set up a quality score between 0 and 100 - 100 is the best.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.surveyaction.properties.Annotation

getAdditionalProperties, getAnalysisStep, getAnnotationStatus, getAnnotationSubjects, getAnnotationType, getConfidenceLevel, getExplanation, getExpression, getJsonProperties, getReviewComment, getReviewDate, getSteward, getSummary, setAdditionalProperties, setAnalysisStep, setAnnotationStatus, setAnnotationSubjects, setAnnotationType, setConfidenceLevel, setExplanation, setExpression, setJsonProperties, setReviewComment, setReviewDate, setSteward, setSummary

Methods inherited from class org.odpi.openmetadata.frameworks.surveyaction.properties.PropertyBase

getElementHeader, getExtendedProperties, getHeaderVersion, getOpenMetadataTypeName, setElementHeader, setExtendedProperties, setHeaderVersion, setOpenMetadataTypeName

Methods inherited from class java.lang.Object

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

Constructor Details

QualityAnnotation

public QualityAnnotation()

Default constructor

QualityAnnotation

public QualityAnnotation(QualityAnnotation template)

Copy clone constructor

Parameters:

template - object to copy

Method Details

getQualityDimension

public String getQualityDimension()

Return the type of quality being measured.

Returns:

string name

setQualityDimension

public void setQualityDimension(String qualityDimension)

Set up the type of quality being measured.

Parameters:

qualityDimension - string name

getQualityScore

public int getQualityScore()

Return a quality score between 0 and 100 - 100 is the best.

Returns:

int

setQualityScore

public void setQualityScore(int qualityScore)

Set up a quality score between 0 and 100 - 100 is the best.

Parameters:

qualityScore - int

toString

public String toString()

Standard toString method.

Overrides:

toString in class DataFieldAnnotation

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 Annotation

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 Annotation

Returns:

int hash code