Package org.odpi.openmetadata.frameworks.openmetadata.enums

Enum Class ClassificationOrigin

java.lang.Object
java.lang.Enum<ClassificationOrigin>
org.odpi.openmetadata.frameworks.openmetadata.enums.ClassificationOrigin
All Implemented Interfaces:
Serializable, Comparable<ClassificationOrigin>, Constable, OpenMetadataEnum
public enum ClassificationOrigin extends Enum<ClassificationOrigin> implements OpenMetadataEnum
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.

Note: the repository services have no mechanism to automatically propagate classifications. This is set up by higher level services working with knowledge of the specific instance types of metadata and their significance.

  • Enum Constant Details

    • ASSIGNED

      public static final ClassificationOrigin ASSIGNED
      The classification is explicitly assigned to the entity.

    • PROPAGATED

      public static final ClassificationOrigin PROPAGATED
      The classification has propagated along a relationship to this entity.

  • Method Details

    • values

      public static ClassificationOrigin[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ClassificationOrigin valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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.
      Specified by:
      getOrdinal in interface OpenMetadataEnum
      Returns:
      int ordinal

    • getName

      public String getName()
      Return the default name of the classification origin.
      Specified by:
      getName in interface OpenMetadataEnum
      Returns:
      String name

    • getDescription

      public String getDescription()
      Return the default description of the classification origin.
      Specified by:
      getDescription in interface OpenMetadataEnum
      Returns:
      String description

    • getDescriptionGUID

      public String getDescriptionGUID()
      Return the unique identifier for the valid value that represents the enum value.
      Specified by:
      getDescriptionGUID in interface OpenMetadataEnum
      Returns:
      guid

    • isDefault

      public boolean isDefault()
      Return whether the enum is the default value or not.
      Specified by:
      isDefault in interface OpenMetadataEnum
      Returns:
      boolean

    • toString

      public String toString()
      toString() JSON-style
      Overrides:
      toString in class Enum<ClassificationOrigin>
      Returns:
      string description