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

Class InstanceType

java.lang.Object

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceElementHeader

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceType

All Implemented Interfaces:

Serializable

public class InstanceType
extends InstanceElementHeader

InstanceType contains information from the instance's TypeDef that are useful for processing the instance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InstanceType() Default constructor relies on initialization of variables in the declaration.
InstanceType(InstanceType template) Copy/clone constructor
InstanceType(TypeDefCategory typeDefCategory, String typeDefGUID, String typeDefName, long typeDefVersion, String typeDefDescription, String typeDefDescriptionGUID, List<TypeDefLink> typeDefSuperTypes, List<InstanceStatus> validStatusList, List<String> validInstanceProperties) Typical constructor that set all of the properties at once.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Validate if the supplied object equals this object.
TypeDefCategory	getTypeDefCategory() Return the category of this instance.
String	getTypeDefDescription() Return the description for the TypeDef.
String	getTypeDefDescriptionGUID() Return the unique identifier of the glossary term that describes this TypeDef (null if no term defined).
String	getTypeDefGUID() Return the unique identifier for the type of this instance.
String	getTypeDefName() Return the name of this instance's type.
List<TypeDefLink>	getTypeDefSuperTypes() Return the full list of defined super-types for this TypeDef working up the type hierarchy.
long	getTypeDefVersion() Return the version number of this instance's TypeDef.
List<String>	getValidInstanceProperties() Return the list of valid property names that can be stored in this instance.
List<InstanceStatus>	getValidStatusList() Return the list of valid instance statuses supported by this instance.
int	hashCode() Return a hash code based on the values of this object.
void	setTypeDefCategory(TypeDefCategory typeDefCategory) Set up the category of this instance.
void	setTypeDefDescription(String typeDefDescription) Set up the description for the TypeDef.
void	setTypeDefDescriptionGUID(String typeDefDescriptionGUID) Set up the unique identifier of the glossary term that describes this TypeDef (null if no term defined).
void	setTypeDefGUID(String typeDefGUID) Set up the unique identifier for the type of this instance.
void	setTypeDefName(String typeDefName) Set up the name of this instance's type.
void	setTypeDefSuperTypes(List<TypeDefLink> typeDefSuperTypes) Set up the full list of defined super-types for this TypeDef working up the type hierarchy.
void	setTypeDefVersion(long typeDefVersion) Set up the version for the TypeDef.
void	setValidInstanceProperties(List<String> validInstanceProperties) Set up the set of valid property names that can be stored in this instance.
void	setValidStatusList(List<InstanceStatus> validStatusList) Set up the list of valid instance statuses supported by this instance.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceType

public InstanceType()

Default constructor relies on initialization of variables in the declaration.

InstanceType

public InstanceType(TypeDefCategory typeDefCategory,
                    String typeDefGUID,
                    String typeDefName,
                    long typeDefVersion,
                    String typeDefDescription,
                    String typeDefDescriptionGUID,
                    List<TypeDefLink> typeDefSuperTypes,
                    List<InstanceStatus> validStatusList,
                    List<String> validInstanceProperties)

Typical constructor that set all of the properties at once.

Parameters:

typeDefCategory - the category of the type

typeDefGUID - unique identifier of the type

typeDefName - unique name of the type

typeDefVersion - version number of the type

typeDefDescription - short description of the type

typeDefDescriptionGUID - unique identifier of the glossary term describing this type.

typeDefSuperTypes - full list of super types for this type

validStatusList - list of statuses that this instance can have

validInstanceProperties - full list of valid property names that can be put in the instance (including properties from the super types)

InstanceType

public InstanceType(InstanceType template)

Copy/clone constructor

Parameters:

template - instance type to copy

Method Detail

getTypeDefCategory

public TypeDefCategory getTypeDefCategory()

Return the category of this instance. This defines the category of the TypeDef that determines its properties.

Returns:

TypeDefCategory enum

setTypeDefCategory

public void setTypeDefCategory(TypeDefCategory typeDefCategory)

Set up the category of this instance. This defines the category of the TypeDef that determines its properties.

Parameters:

typeDefCategory - enum

getTypeDefGUID

public String getTypeDefGUID()

Return the unique identifier for the type of this instance.

Returns:

String unique identifier

setTypeDefGUID

public void setTypeDefGUID(String typeDefGUID)

Set up the unique identifier for the type of this instance.

Parameters:

typeDefGUID - String unique identifier

getTypeDefName

public String getTypeDefName()

Return the name of this instance's type.

Returns:

String type name

setTypeDefName

public void setTypeDefName(String typeDefName)

Set up the name of this instance's type.

Parameters:

typeDefName - String type name

getTypeDefVersion

public long getTypeDefVersion()

Return the version number of this instance's TypeDef.

Returns:

long version number

setTypeDefVersion

public void setTypeDefVersion(long typeDefVersion)

Set up the version for the TypeDef.

Parameters:

typeDefVersion - long version number

getTypeDefSuperTypes

public List<TypeDefLink> getTypeDefSuperTypes()

Return the full list of defined super-types for this TypeDef working up the type hierarchy.

Returns:

list of types

setTypeDefSuperTypes

public void setTypeDefSuperTypes(List<TypeDefLink> typeDefSuperTypes)

Set up the full list of defined super-types for this TypeDef working up the type hierarchy.

Parameters:

typeDefSuperTypes - list of type names

getTypeDefDescription

public String getTypeDefDescription()

Return the description for the TypeDef.

Returns:

String description

setTypeDefDescription

public void setTypeDefDescription(String typeDefDescription)

Set up the description for the TypeDef.

Parameters:

typeDefDescription - String description

getTypeDefDescriptionGUID

public String getTypeDefDescriptionGUID()

Return the unique identifier of the glossary term that describes this TypeDef (null if no term defined).

Returns:

String unique identifier

setTypeDefDescriptionGUID

public void setTypeDefDescriptionGUID(String typeDefDescriptionGUID)

Set up the unique identifier of the glossary term that describes this TypeDef (null if no term defined).

Parameters:

typeDefDescriptionGUID - String unique identifier

getValidStatusList

public List<InstanceStatus> getValidStatusList()

Return the list of valid instance statuses supported by this instance.

Returns:

InstanceStatus array of supported status.

setValidStatusList

public void setValidStatusList(List<InstanceStatus> validStatusList)

Set up the list of valid instance statuses supported by this instance.

Parameters:

validStatusList - InstanceStatus Array

getValidInstanceProperties

public List<String> getValidInstanceProperties()

Return the list of valid property names that can be stored in this instance.

Returns:

array of property names.

setValidInstanceProperties

public void setValidInstanceProperties(List<String> validInstanceProperties)

Set up the set of valid property names that can be stored in this instance.

Parameters:

validInstanceProperties - array of property names.

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

JSON style description of variables.

equals

public boolean equals(Object objectToCompare)

Validate if the supplied object equals this object.

Overrides:

equals in class Object

Parameters:

objectToCompare - test object

Returns:

boolean evaluation

hashCode

public int hashCode()

Return a hash code based on the values of this object.

Overrides:

hashCode in class Object

Returns:

in hash code