Class QualityAnnotation
- java.lang.Object
-
- org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase
-
- org.odpi.openmetadata.frameworks.discovery.properties.Annotation
-
- org.odpi.openmetadata.frameworks.discovery.properties.DataFieldAnnotation
-
- org.odpi.openmetadata.frameworks.discovery.properties.QualityAnnotation
-
- All Implemented Interfaces:
Serializable
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.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase
CURRENT_AUDIT_HEADER_VERSION
-
-
Constructor Summary
Constructors Constructor Description QualityAnnotation()Default constructorQualityAnnotation(QualityAnnotation template)Copy clone constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object objectToCompare)Compare the values of the supplied object with those stored in the current object.StringgetQualityDimension()Return the type of quality being measured.intgetQualityScore()Return a quality score between 0 and 100 - 100 is the best.inthashCode()Create a hash code for this element type.voidsetQualityDimension(String qualityDimension)Set up the type of quality being measured.voidsetQualityScore(int qualityScore)Set up a quality score between 0 and 100 - 100 is the best.StringtoString()Standard toString method.-
Methods inherited from class org.odpi.openmetadata.frameworks.discovery.properties.Annotation
getAdditionalProperties, getAnalysisStep, getAnnotationStatus, getAnnotationType, getConfidenceLevel, getExplanation, getExpression, getJsonProperties, getNumAttachedAnnotations, getReviewComment, getReviewDate, getSteward, getSummary, setAdditionalProperties, setAnalysisStep, setAnnotationStatus, setAnnotationType, setConfidenceLevel, setExplanation, setExpression, setJsonProperties, setNumAttachedAnnotations, setReviewComment, setReviewDate, setSteward, setSummary
-
Methods inherited from class org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase
getElementHeader, getExtendedProperties, getHeaderVersion, getTypeName, setElementHeader, setExtendedProperties, setHeaderVersion, setTypeName
-
-
-
-
Constructor Detail
-
QualityAnnotation
public QualityAnnotation()
Default constructor
-
QualityAnnotation
public QualityAnnotation(QualityAnnotation template)
Copy clone constructor- Parameters:
template- object to copy
-
-
Method Detail
-
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:
toStringin classDataFieldAnnotation- 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:
equalsin classAnnotation- Parameters:
objectToCompare- supplied object- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()
Create a hash code for this element type.- Overrides:
hashCodein classAnnotation- Returns:
- int hash code
-
-