Class Classification

  • All Implemented Interfaces:
    Serializable

    public class Classification
    extends InstanceAuditHeader
    The Classification class stores information about a classification assigned to an entity. The Classification has a name and some properties. Some classifications are explicitly added to an entity and other classifications are propagated to an entity along the relationships connected to it. The origin of the classification is also stored. Note: it is not valid to have a classification with a null or blank name.
    See Also:
    Serialized Form
    • Constructor Detail

      • Classification

        public Classification()
        Default constructor for automated generation tools.
      • Classification

        public Classification​(Classification template)
        Copy/clone constructor sets up new classification using values from the template
        Parameters:
        template - object to copy
    • Method Detail

      • getName

        public String getName()
        Return the name of the classification. This name is the type name defined in a ClassificationDef type definition.
        Returns:
        name of classification
      • setName

        public void setName​(String classificationName)
        Set up the name of the classification. This name is the type name defined in a ClassificationDef type definition.
        Parameters:
        classificationName - String name
      • getProperties

        public InstanceProperties getProperties()
        Returns a collection of the additional stored properties for the classification. If no stored properties are present then null is returned.
        Returns:
        properties for the classification
      • setProperties

        public void setProperties​(InstanceProperties classificationProperties)
        Set up a collection of the additional stored properties for the classification.
        Parameters:
        classificationProperties - properties object
      • getClassificationOrigin

        public ClassificationOrigin getClassificationOrigin()
        Return the origin of the classification.
        Returns:
        ClassificationOrigin enum
      • setClassificationOrigin

        public void setClassificationOrigin​(ClassificationOrigin classificationOrigin)
        Set up the origin of the classification.
        Parameters:
        classificationOrigin - ClassificationOrigin enum
      • getClassificationOriginGUID

        public String getClassificationOriginGUID()
        Return the guid of the entity where the propagated classification came from.
        Returns:
        unique identifier of the classification's origin
      • setClassificationOriginGUID

        public void setClassificationOriginGUID​(String classificationOriginGUID)
        Set up the guid of the entity where the propagated classification came from.
        Parameters:
        classificationOriginGUID - unique identifier of the classification's origin
      • equals

        public boolean equals​(Object objectToCompare)
        Validate that an object is equal depending on their stored values.
        Overrides:
        equals in class InstanceAuditHeader
        Parameters:
        objectToCompare - object
        Returns:
        boolean result
      • hashCode

        public int hashCode()
        Return a hash code based on the values of this object.
        Overrides:
        hashCode in class InstanceAuditHeader
        Returns:
        in hash code