Enum ClassificationOrigin

  • All Implemented Interfaces:
    Serializable, Comparable<ClassificationOrigin>

    public enum ClassificationOrigin
    extends Enum<ClassificationOrigin>
    implements Serializable
    ClassificationOrigin describes the provenance of a classification attached to an entity. Most classifications are explicitly assigned to an entity. However, it is possible for some classifications to flow along relationships to other entities. These are the propagated classifications. Each entity can only have one classification of a certain type. A propagated classification can not override an assigned classification. Classifications can only be attached to entities of specific types. However a propagated classification can flow through an entity that does not support the particular type of classification and then on to other relationships attached to the entity. The ClassificationPropagateRule in the relationship's RelationshipDef defines where the classification can flow to.
    • Method Detail

      • values

        public static ClassificationOrigin[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ClassificationOrigin c : ClassificationOrigin.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ClassificationOrigin valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • getOrdinal

        public int getOrdinal()
        Return the numeric representation of the classification origin.
        Returns:
        int ordinal
      • getName

        public String getName()
        Return the default name of the classification origin.
        Returns:
        String name
      • getDescription

        public String getDescription()
        Return the default description of the classification origin.
        Returns:
        String description