Class SemanticAnnotation

  • All Implemented Interfaces:
    java.io.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
    • Constructor Detail

      • SemanticAnnotation

        public SemanticAnnotation()
        Default constructor
      • SemanticAnnotation

        public SemanticAnnotation​(SemanticAnnotation template)
        Copy clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getInformalTerm

        public java.lang.String getInformalTerm()
        Return a string that describes the meaning of this data.
        Returns:
        string name
      • setInformalTerm

        public void setInformalTerm​(java.lang.String informalTerm)
        Set up a string that describes the meaning of this data.
        Parameters:
        informalTerm - string name
      • getInformalTopic

        public java.lang.String getInformalTopic()
        Return a string that describes the topic that this data is about.
        Returns:
        string name
      • setInformalTopic

        public void setInformalTopic​(java.lang.String informalTopic)
        Set up a string that describes the topic that this data is about.
        Parameters:
        informalTopic - string name
      • getCandidateGlossaryTermGUIDs

        public java.util.List<java.lang.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​(java.util.List<java.lang.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 java.util.List<java.lang.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​(java.util.List<java.lang.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 java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class DataFieldAnnotation
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.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