Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs

Class ClassificationDef

java.lang.Object

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.RepositoryElementHeader

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.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

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef

createdBy, createTime, description, descriptionGUID, descriptionWiki, externalStandardMappings, initialStatus, options, origin, propertiesDefinition, superType, updatedBy, updateTime, validInstanceStatusList

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary

category, version, versionName

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink

guid, name, replacedByTypeGUID, replacedByTypeName, status

Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefElementHeader

CURRENT_TYPE_DEF_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
ClassificationDef()	Minimal constructor sets up an empty ClassificationDef.
ClassificationDef(ClassificationDef template)	Copy/clone constructor copies values from the supplied template.
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.

Method Summary

Modifier and Type	Method	Description
TypeDef	cloneFromSubclass()	Delegate the process of cloning to the subclass.
boolean	equals(Object objectToCompare)	Validate that an object is equal depending on their stored values.
List<TypeDefLink>	getValidEntityDefs()	Return the list of identifiers for the types of entities that this type of Classification can be connected to.
int	hashCode()	Return a hash code based on the values of this object.
boolean	isPropagatable()	Return whether this classification should propagate to other entities if the relationship linking them allows classification propagation.
void	setPropagatable(boolean propagatable)	Sets up whether this classification should propagate to other entities if the relationship linking them allows classification propagation.
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.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef

getCreatedBy, getCreateTime, getDescription, getDescriptionGUID, getDescriptionWiki, getExternalStandardMappings, getInitialStatus, getOptions, getOrigin, getPropertiesDefinition, getSuperType, getUpdatedBy, getUpdateTime, getValidInstanceStatusList, setCreatedBy, setCreateTime, setDescription, setDescriptionGUID, setDescriptionWiki, setExternalStandardMappings, setInitialStatus, setOptions, setOrigin, setPropertiesDefinition, setSuperType, setUpdatedBy, setUpdateTime, setValidInstanceStatusList

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary

getCategory, getVersion, getVersionName, setCategory, setVersion, setVersionName

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefLink

getGUID, getName, getReplacedByTypeGUID, getReplacedByTypeName, getStatus, setGUID, setName, setReplacedByTypeGUID, setReplacedByTypeName, setStatus

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.RepositoryElementHeader

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

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 Details

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