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

Class AttributeTypeDef

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CollectionDef, EnumDef, PrimitiveDef

public abstract class AttributeTypeDef
extends TypeDefElementHeader

The AttributeTypeDef class is used to identify the type of an attribute. These can be:

• PrimitiveDef
• CollectionDef
• EnumDef

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AttributeTypeDefCategory	category
protected String	description
protected String	descriptionGUID
protected String	guid
protected String	name
protected long	version
protected String	versionName

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

CURRENT_TYPE_DEF_HEADER_VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AttributeTypeDef() Default constructor
protected	AttributeTypeDef(AttributeTypeDef template) Copy/clone constructor copies the values from the supplied template.
protected	AttributeTypeDef(AttributeTypeDefCategory category) Minimal constructor is passed the category of the attribute type.
protected	AttributeTypeDef(AttributeTypeDefCategory category, String guid, String name) Typical constructor is passed the values that describe the type.

Method Summary

Modifier and Type	Method and Description
abstract AttributeTypeDef	cloneFromSubclass() Delegate the process of cloning to the subclass.
boolean	equals(Object object) Validated that the GUID, name and version number of a AttributeTypeDef are equal.
AttributeTypeDefCategory	getCategory() Return the category of the TypeDef.
String	getDescription() Return the short description of this AttributeTypeDef.
String	getDescriptionGUID() Return the unique identifier of the glossary term that describes this AttributeTypeDef.
String	getGUID() Return the unique identifier for this TypeDef.
String	getName() Return the type name for this TypeDef.
long	getVersion() Return the version of the AttributeTypeDef.
String	getVersionName() Return the version name, which is a more of a human readable form of the version number.
int	hashCode() Using the GUID as a hashcode.
void	setCategory(AttributeTypeDefCategory category) Set up the category of the TypeDef.
void	setDescription(String description) Set up the short description of this AttributeTypeDef.
void	setDescriptionGUID(String descriptionGUID) Set up the unique identifier of the glossary term that describes this AttributeTypeDef.
void	setGUID(String guid) Set up the unique identifier for this TypeDef.
void	setName(String name) Set up the type name for this TypeDef.
void	setVersion(long version) Set up the version of the AttributeTypeDef.
void	setVersionName(String versionName) Set up the version name, which is a more of a human readable form of the version number.
String	toString() Standard toString method.

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

getHeaderVersion, setHeaderVersion

Methods inherited from class java.lang.Object

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

Field Detail

version

protected long version

versionName

protected String versionName

category

protected AttributeTypeDefCategory category

guid

protected String guid

name

protected String name

description

protected String description

descriptionGUID

protected String descriptionGUID

Constructor Detail

AttributeTypeDef

protected AttributeTypeDef()

Default constructor

AttributeTypeDef

protected AttributeTypeDef(AttributeTypeDefCategory category)

Minimal constructor is passed the category of the attribute type. Note that since AttributeTypeDef is an abstract class, this method can only be called from a subclass.

Parameters:

category - category of this TypeDef

AttributeTypeDef

protected AttributeTypeDef(AttributeTypeDefCategory category,
                           String guid,
                           String name)

Typical constructor is passed the values that describe the type. Note that since AttributeTypeDef is an abstract class, this method can only be called from a subclass.

Parameters:

category - category of this TypeDef

guid - unique id for the TypeDef

name - unique name for the TypeDef

AttributeTypeDef

protected AttributeTypeDef(AttributeTypeDef template)

Copy/clone constructor copies the values from the supplied template. Note that since AttributeTypeDef is an abstract class, this method can only be called from a subclass.

Parameters:

template - AttributeTypeDef

Method Detail

cloneFromSubclass

public abstract AttributeTypeDef cloneFromSubclass()

Delegate the process of cloning to the subclass.

Returns:

subclass of AttributeTypeDef

getVersion

public long getVersion()

Return the version of the AttributeTypeDef. Versions are created when an AttributeTypeDef's properties are changed. If a description is updated, then this does not create a new version.

Returns:

String version number

setVersion

public void setVersion(long version)

Set up the version of the AttributeTypeDef. Versions are created when an AttributeTypeDef's properties are changed. If a description is updated, then this does not create a new version.

Parameters:

version - long version number

getVersionName

public String getVersionName()

Return the version name, which is a more of a human readable form of the version number. It can be used to show whether the change is a minor or major update.

Returns:

String version name

setVersionName

public void setVersionName(String versionName)

Set up the version name, which is a more of a human readable form of the version number. It can be used to show whether the change is a minor or major update.

Parameters:

versionName - String version name

getCategory

public AttributeTypeDefCategory getCategory()

Return the category of the TypeDef.

Returns:

AttributeTypeDefCategory enum

setCategory

public void setCategory(AttributeTypeDefCategory category)

Set up the category of the TypeDef.

Parameters:

category - AttributeTypeDefCategory enum

getGUID

public String getGUID()

Return the unique identifier for this TypeDef.

Returns:

String guid

setGUID

public void setGUID(String guid)

Set up the unique identifier for this TypeDef.

Parameters:

guid - String guid

getName

public String getName()

Return the type name for this TypeDef. In simple environments, the type name is unique but where metadata repositories from different vendors are in operation it is possible that 2 types may have a name clash. The GUID is the reliable unique identifier.

Returns:

String name

setName

public void setName(String name)

Set up the type name for this TypeDef. In simple environments, the type name is unique but where metadata repositories from different vendors are in operation it is possible that 2 types may have a name clash. The GUID is the reliable unique identifier.

Parameters:

name - String name

getDescription

public String getDescription()

Return the short description of this AttributeTypeDef.

Returns:

String description

setDescription

public void setDescription(String description)

Set up the short description of this AttributeTypeDef.

Parameters:

description - String description

getDescriptionGUID

public String getDescriptionGUID()

Return the unique identifier of the glossary term that describes this AttributeTypeDef. Null means there is no known glossary term.

Returns:

String guid

setDescriptionGUID

public void setDescriptionGUID(String descriptionGUID)

Set up the unique identifier of the glossary term that describes this AttributeTypeDef. Null means there is no known glossary term.

Parameters:

descriptionGUID - String guid

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

JSON style description of variables.

equals

public boolean equals(Object object)

Validated that the GUID, name and version number of a AttributeTypeDef are equal.

Overrides:

equals in class Object

Parameters:

object - to test

Returns:

boolean flag to say object is the same TypeDefSummary

hashCode

public int hashCode()

Using the GUID as a hashcode. It should be unique if all connected metadata repositories are behaving properly.

Overrides:

hashCode in class Object

Returns:

int hash code