Class ClassificationDef

  • All Implemented Interfaces:
    Serializable

    public class ClassificationDef
    extends TypeDef
    ClassificationDef stores the properties for the definition of a type of classification. Many of the properties are inherited from TypeDef. ClassificationDef adds a list of Entity Types that this Classification can be connected to and a boolean to indicate if this classification is propagatable.
    See Also:
    Serialized Form
    • Constructor Detail

      • ClassificationDef

        public ClassificationDef()
        Minimal constructor sets up an empty ClassificationDef.
      • ClassificationDef

        public ClassificationDef​(TypeDefCategory category,
                                 String guid,
                                 String name,
                                 long version,
                                 String versionName)
        Typical constructor is passed the properties of the typedef's super class being constructed.
        Parameters:
        category - category of this TypeDef
        guid - unique id for the TypeDef
        name - unique name for the TypeDef
        version - active version number for the TypeDef
        versionName - name for active version of the TypeDef
      • ClassificationDef

        public ClassificationDef​(ClassificationDef template)
        Copy/clone constructor copies values from the supplied template.
        Parameters:
        template - template to copy
    • Method Detail

      • cloneFromSubclass

        public TypeDef cloneFromSubclass()
        Delegate the process of cloning to the subclass.
        Specified by:
        cloneFromSubclass in class TypeDef
        Returns:
        subclass of TypeDef
      • getValidEntityDefs

        public List<TypeDefLink> getValidEntityDefs()
        Return the list of identifiers for the types of entities that this type of Classification can be connected to.
        Returns:
        List of entity type identifiers
      • setValidEntityDefs

        public void setValidEntityDefs​(List<TypeDefLink> validEntityDefs)
        Set up the list of identifiers for the types of entities that this type of Classification can be connected to.
        Parameters:
        validEntityDefs - List of entity type identifiers
      • isPropagatable

        public boolean isPropagatable()
        Return whether this classification should propagate to other entities if the relationship linking them allows classification propagation.
        Returns:
        boolean flag
      • setPropagatable

        public void setPropagatable​(boolean propagatable)
        Sets up whether this classification should propagate to other entities if the relationship linking them allows classification propagation.
        Parameters:
        propagatable - boolean flag
      • toString

        public String toString()
        Standard toString method.
        Overrides:
        toString in class TypeDef
        Returns:
        JSON style description of variables.
      • equals

        public boolean equals​(Object objectToCompare)
        Validate that an object is equal depending on their stored values.
        Overrides:
        equals in class TypeDef
        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 TypeDef
        Returns:
        in hash code