org.odpi.openmetadata.frameworks.discovery.properties

Class SemanticAnnotation

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

All Implemented Interfaces:

Serializable

public class SemanticAnnotation
extends DataFieldAnnotation

SemanticAnnotation provides a recommendation as to the likely meaning of data. This can be expressed informally with explicit strings, or via lists of GUIDs that match elements in a formal glossary. It can be attached to an asset or a data field within an asset.

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 and Description
SemanticAnnotation() Default constructor
SemanticAnnotation(SemanticAnnotation template) 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.
List<String>	getCandidateGlossaryCategoryGUIDs() Return a list of unique identifiers of glossary categories that describe the topic of the data.
List<String>	getCandidateGlossaryTermGUIDs() Return a list of unique identifiers of glossary terms that describe the meaning of the data.
String	getInformalTerm() Return a string that describes the meaning of this data.
String	getInformalTopic() Return a string that describes the topic that this data is about.
int	hashCode() Create a hash code for this element type.
void	setCandidateGlossaryCategoryGUIDs(List<String> candidateGlossaryCategoryGUIDs) Set up a list of unique identifiers of glossary categories that describe the topic of the data.
void	setCandidateGlossaryTermGUIDs(List<String> candidateGlossaryTermGUIDs) Set up a list of unique identifiers of glossary terms that describe the meaning of the data.
void	setInformalTerm(String informalTerm) Set up a string that describes the meaning of this data.
void	setInformalTopic(String informalTopic) Set up a string that describes the topic that this data is about.
String	toString() 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

Methods inherited from class java.lang.Object

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

Constructor Detail

SemanticAnnotation

public SemanticAnnotation()

Default constructor

SemanticAnnotation

public SemanticAnnotation(SemanticAnnotation template)

Copy clone constructor

Parameters:

template - object to copy

Method Detail

getInformalTerm

public String getInformalTerm()

Return a string that describes the meaning of this data.

Returns:

string name

setInformalTerm

public void setInformalTerm(String informalTerm)

Set up a string that describes the meaning of this data.

Parameters:

informalTerm - string name

getInformalTopic

public String getInformalTopic()

Return a string that describes the topic that this data is about.

Returns:

string name

setInformalTopic

public void setInformalTopic(String informalTopic)

Set up a string that describes the topic that this data is about.

Parameters:

informalTopic - string name

getCandidateGlossaryTermGUIDs

public List<String> getCandidateGlossaryTermGUIDs()

Return a list of unique identifiers of glossary terms that describe the meaning of the data.

Returns:

list of guids

setCandidateGlossaryTermGUIDs

public void setCandidateGlossaryTermGUIDs(List<String> candidateGlossaryTermGUIDs)

Set up a list of unique identifiers of glossary terms that describe the meaning of the data.

Parameters:

candidateGlossaryTermGUIDs - list of guids

getCandidateGlossaryCategoryGUIDs

public List<String> getCandidateGlossaryCategoryGUIDs()

Return a list of unique identifiers of glossary categories that describe the topic of the data.

Returns:

list of guids

setCandidateGlossaryCategoryGUIDs

public void setCandidateGlossaryCategoryGUIDs(List<String> candidateGlossaryCategoryGUIDs)

Set up a list of unique identifiers of glossary categories that describe the topic of the data.

Parameters:

candidateGlossaryCategoryGUIDs - list of guids

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