Class Classification
- java.lang.Object
-
- org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceElementHeader
-
- org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader
-
- org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.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
-
-
Field Summary
-
Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader
CURRENT_AUDIT_HEADER_VERSION
-
-
Constructor Summary
Constructors Constructor Description Classification()Default constructor for automated generation tools.Classification(Classification template)Copy/clone constructor sets up new classification using values from the template
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object objectToCompare)Validate that an object is equal depending on their stored values.ClassificationOrigingetClassificationOrigin()Return the origin of the classification.StringgetClassificationOriginGUID()Return the guid of the entity where a propagate classification came from.StringgetName()Return the name of the classification.InstancePropertiesgetProperties()Returns a collection of the additional stored properties for the classification.inthashCode()Return a hash code based on the values of this object.voidsetClassificationOrigin(ClassificationOrigin classificationOrigin)Set up the origin of the classification.voidsetClassificationOriginGUID(String classificationOriginGUID)Set up the guid of the entity where a propagate classification came from.voidsetName(String classificationName)Set up the name of the classification.voidsetProperties(InstanceProperties classificationProperties)Set up a collection of the additional stored properties for the classification.StringtoString()Standard toString method.-
Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader
getCreatedBy, getCreateTime, getHeaderVersion, getInstanceLicense, getInstanceProvenanceType, getMaintainedBy, getMappingProperties, getMetadataCollectionId, getMetadataCollectionName, getReplicatedBy, getStatus, getStatusOnDelete, getType, getUpdatedBy, getUpdateTime, getVersion, setCreatedBy, setCreateTime, setHeaderVersion, setInstanceLicense, setInstanceProvenanceType, setMaintainedBy, setMappingProperties, setMetadataCollectionId, setMetadataCollectionName, setReplicatedBy, setStatus, setStatusOnDelete, setType, setUpdatedBy, setUpdateTime, setVersion
-
-
-
-
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 a propagate 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 a propagate classification came from.- Parameters:
classificationOriginGUID- unique identifier of the classification's origin
-
toString
public String toString()
Standard toString method.- Overrides:
toStringin classInstanceAuditHeader- Returns:
- JSON style description of variables.
-
equals
public boolean equals(Object objectToCompare)
Validate that an object is equal depending on their stored values.- Overrides:
equalsin classInstanceAuditHeader- Parameters:
objectToCompare- object- Returns:
- boolean result
-
hashCode
public int hashCode()
Return a hash code based on the values of this object.- Overrides:
hashCodein classInstanceAuditHeader- Returns:
- in hash code
-
-