Package org.odpi.openmetadata.frameworks.openmetadata.properties

Class OpenMetadataClassificationDef

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataTypeDefElementHeader

org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataTypeDefLink

org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataTypeDefSummary

org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataTypeDef

org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataClassificationDef

public class OpenMetadataClassificationDef
extends OpenMetadataTypeDef

OpenMetadataClassificationDef stores the properties for the definition of a type of classification. Many of the properties are inherited from OpenMetadataTypeDef. OpenMetadataClassificationDef adds a list of Entity Types that this Classification can be connected to and a boolean to indicate if this classification is propagatable.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataTypeDef

attributeDefinitions, beanClassName, createdBy, createTime, description, descriptionGUID, descriptionWiki, externalStandardTypeMappings, initialStatus, options, origin, superType, updatedBy, updateTime, validElementStatusList

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataTypeDefSummary

category, version, versionName

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataTypeDefLink

guid, name, replacedByTypeGUID, replacedByTypeName, status

Fields inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataTypeDefElementHeader

CURRENT_TYPE_DEF_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
OpenMetadataClassificationDef()	Minimal constructor sets up an empty OpenMetadataClassificationDef.
OpenMetadataClassificationDef(OpenMetadataClassificationDef template)	Copy/clone constructor copies values from the supplied template.
OpenMetadataClassificationDef(OpenMetadataTypeDefCategory 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
OpenMetadataTypeDef	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<OpenMetadataTypeDefLink>	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<OpenMetadataTypeDefLink> 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.frameworks.openmetadata.properties.OpenMetadataTypeDef

getAttributeDefinitions, getBeanClassName, getCreatedBy, getCreateTime, getDescription, getDescriptionGUID, getDescriptionWiki, getExternalStandardTypeMappings, getInitialStatus, getOptions, getOrigin, getSuperType, getUpdatedBy, getUpdateTime, getValidElementStatusList, setAttributeDefinitions, setBeanClassName, setCreatedBy, setCreateTime, setDescription, setDescriptionGUID, setDescriptionWiki, setExternalStandardTypeMappings, setInitialStatus, setOptions, setOrigin, setSuperType, setUpdatedBy, setUpdateTime, setValidElementStatusList

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataTypeDefSummary

getCategory, getVersion, getVersionName, setCategory, setVersion, setVersionName

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.properties.OpenMetadataTypeDefLink

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

Methods inherited from class java.lang.Object

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

Constructor Details

OpenMetadataClassificationDef

public OpenMetadataClassificationDef()

Minimal constructor sets up an empty OpenMetadataClassificationDef.

OpenMetadataClassificationDef

public OpenMetadataClassificationDef(OpenMetadataTypeDefCategory 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 OpenMetadataTypeDef

guid - unique id for the OpenMetadataTypeDef

name - unique name for the OpenMetadataTypeDef

version - active version number for the OpenMetadataTypeDef

versionName - name for active version of the OpenMetadataTypeDef

OpenMetadataClassificationDef

public OpenMetadataClassificationDef(OpenMetadataClassificationDef template)

Copy/clone constructor copies values from the supplied template.

Parameters:

template - template to copy

Method Details

cloneFromSubclass

public OpenMetadataTypeDef cloneFromSubclass()

Delegate the process of cloning to the subclass.

Specified by:

cloneFromSubclass in class OpenMetadataTypeDef

Returns:

subclass of OpenMetadataTypeDef

getValidEntityDefs

public List<OpenMetadataTypeDefLink> 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<OpenMetadataTypeDefLink> 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 OpenMetadataTypeDef

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 OpenMetadataTypeDef

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 OpenMetadataTypeDef

Returns:

in hash code