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

Class DataClassAnnotation

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.DataClassAnnotation

public class DataClassAnnotation
extends DataFieldAnnotation

DataClassAnnotation recommends a data class that potentially matches this data field.

Field Summary

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

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
DataClassAnnotation()	Default constructor
DataClassAnnotation(DataClassAnnotation 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.
List<String>	getCandidateDataClassGUIDs()	Return the identifiers of data classes that seem to match the values in this data field.
long	getMatchingValues()	Return the count of matching values that match the specification of these data classes.
long	getNonMatchingValues()	Return the count of values that do not match the specification of these data classes.
int	hashCode()	Create a hash code for this element type.
void	setCandidateDataClassGUIDs(List<String> candidateDataClassGUIDs)	Set up the identifiers of data classes that seem to match the values in this data field.
void	setMatchingValues(long matchingValues)	Set up the count of matching values that match the specification of these data classes.
void	setNonMatchingValues(long nonMatchingValues)	Set up the count of values that do not match the specification of these data classes.
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

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DataClassAnnotation

public DataClassAnnotation()

Default constructor

DataClassAnnotation

public DataClassAnnotation(DataClassAnnotation template)

Copy clone constructor

Parameters:

template - object to copy

Method Details

getCandidateDataClassGUIDs

public List<String> getCandidateDataClassGUIDs()

Return the identifiers of data classes that seem to match the values in this data field.

Returns:

list of unique identifiers for data classes

setCandidateDataClassGUIDs

public void setCandidateDataClassGUIDs(List<String> candidateDataClassGUIDs)

Set up the identifiers of data classes that seem to match the values in this data field.

Parameters:

candidateDataClassGUIDs - list of guids

getMatchingValues

public long getMatchingValues()

Return the count of matching values that match the specification of these data classes.

Returns:

long

setMatchingValues

public void setMatchingValues(long matchingValues)

Set up the count of matching values that match the specification of these data classes.

Parameters:

matchingValues - long

getNonMatchingValues

public long getNonMatchingValues()

Return the count of values that do not match the specification of these data classes.

Returns:

long

setNonMatchingValues

public void setNonMatchingValues(long nonMatchingValues)

Set up the count of values that do not match the specification of these data classes.

Parameters:

nonMatchingValues - long

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