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

Class TypeDefSummary

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TypeDef

public class TypeDefSummary
extends TypeDefLink

The TypeDefSummary holds basic identifying information for a specific TypeDef. It is used in the registration process between repositories.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected TypeDefCategory	category
protected long	version
protected String	versionName

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

guid, name

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

CURRENT_TYPE_DEF_HEADER_VERSION

Constructor Summary

Constructors

Constructor and Description
TypeDefSummary() Default constructor
TypeDefSummary(TypeDefCategory category, String guid, String name, long version, String versionName) Typical constructor is passed the properties of the typedef being constructed.
TypeDefSummary(TypeDefSummary template) Copy/clone constructor copies the values from the supplied template.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Verify that supplied object has the same properties.
TypeDefCategory	getCategory() Return the category of the TypeDef.
long	getVersion() Return the version of the TypeDef.
String	getVersionName() Return the version name is more of a human readable form of the version number.
void	setCategory(TypeDefCategory category) Set up the category of the TypeDef.
void	setVersion(long version) Set up the version of the TypeDef.
void	setVersionName(String versionName) Set up the version name is 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.TypeDefLink

getGUID, getName, hashCode, setGUID, setName

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 TypeDefCategory category

Constructor Detail

TypeDefSummary

public TypeDefSummary()

Default constructor

TypeDefSummary

public TypeDefSummary(TypeDefCategory category,
                      String guid,
                      String name,
                      long version,
                      String versionName)

Typical constructor is passed the properties of the typedef 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 - active version name for the TypeDef

TypeDefSummary

public TypeDefSummary(TypeDefSummary template)

Copy/clone constructor copies the values from the supplied template.

Parameters:

template - TypeDefSummary

Method Detail

getCategory

public TypeDefCategory getCategory()

Return the category of the TypeDef.

Returns:

TypeDefCategory enum

setCategory

public void setCategory(TypeDefCategory category)

Set up the category of the TypeDef.

Parameters:

category - TypeDefCategory enum

getVersion

public long getVersion()

Return the version of the TypeDef. Versions are created when a TypeDef'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 TypeDef. Versions are created when a TypeDef'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 is 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 is 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

toString

public String toString()

Standard toString method.

Overrides:

toString in class TypeDefLink

Returns:

JSON style description of variables.

equals

public boolean equals(Object objectToCompare)

Verify that supplied object has the same properties.

Overrides:

equals in class TypeDefLink

Parameters:

objectToCompare - object to test

Returns:

result