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

Class InstancePropertyValue

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ArrayPropertyValue, EnumPropertyValue, MapPropertyValue, PrimitivePropertyValue, StructPropertyValue

public abstract class InstancePropertyValue
extends InstanceElementHeader

InstancePropertyValue provides a common class for holding an instance type and value.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InstancePropertyValue() Default constructor for Jackson
protected	InstancePropertyValue(InstancePropertyCategory instancePropertyCategory) Typical constructor initializes the instance property value to nulls.
protected	InstancePropertyValue(InstancePropertyValue template) Copy/clone constructor initializes the instance property value from the supplied template.

Method Summary

Modifier and Type	Method and Description
abstract InstancePropertyValue	cloneFromSubclass() Delegate the process of cloning to the subclass.
boolean	equals(Object objectToCompare) Validate that an object is equal depending on their stored values.
InstancePropertyCategory	getInstancePropertyCategory() Return the category of this instance property's type.
String	getTypeGUID() Return the unique GUID for the type.
String	getTypeName() Return the name of the type.
int	hashCode() Return a hash code based on the property values
protected <K,V extends InstancePropertyValue> Map<K,Object>	mapValuesAsObject(Map<K,V> valMap) Default method for "valueAsString".
protected <K,V extends InstancePropertyValue> Map<K,String>	mapValuesAsString(Map<K,V> valMap) Default method for "valueAsObject".
void	setInstancePropertyCategory(InstancePropertyCategory instancePropertyCategory) Set up the category for this instance property.
void	setTypeGUID(String typeGUID) Set up the unique GUID of the type.
void	setTypeName(String typeName) Set up the name of the type.
String	toString() Standard toString method.
abstract Object	valueAsObject() Return the object version of the value - used for comparisons.
abstract String	valueAsString() Return the string version of the value - used for error logging.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstancePropertyValue

protected InstancePropertyValue()

Default constructor for Jackson

InstancePropertyValue

protected InstancePropertyValue(InstancePropertyCategory instancePropertyCategory)

Typical constructor initializes the instance property value to nulls.

Parameters:

instancePropertyCategory - InstancePropertyCategory Enum

InstancePropertyValue

protected InstancePropertyValue(InstancePropertyValue template)

Copy/clone constructor initializes the instance property value from the supplied template.

Parameters:

template - InstancePropertyValue

Method Detail

cloneFromSubclass

public abstract InstancePropertyValue cloneFromSubclass()

Delegate the process of cloning to the subclass.

Returns:

subclass of InstancePropertyValue

valueAsString

public abstract String valueAsString()

Return the string version of the value - used for error logging.

Returns:

string value

valueAsObject

public abstract Object valueAsObject()

Return the object version of the value - used for comparisons.

Returns:

object value

mapValuesAsObject

protected <K,V extends InstancePropertyValue> Map<K,Object> mapValuesAsObject(Map<K,V> valMap)

Default method for "valueAsString". Return the object version of the value - used for comparisons.

Type Parameters:

K - key

V - value

Parameters:

valMap - mapping

Returns:

Map object values

mapValuesAsString

protected <K,V extends InstancePropertyValue> Map<K,String> mapValuesAsString(Map<K,V> valMap)

Default method for "valueAsObject". Return the object version of the value - used for comparisons.

Type Parameters:

K - key

V - value

Parameters:

valMap - mapping

Returns:

Map string values

getInstancePropertyCategory

public InstancePropertyCategory getInstancePropertyCategory()

Return the category of this instance property's type.

Returns:

TypeDefCategory enum value

setInstancePropertyCategory

public void setInstancePropertyCategory(InstancePropertyCategory instancePropertyCategory)

Set up the category for this instance property. This is used on the JSON deserialization.

Parameters:

instancePropertyCategory - new category

getTypeGUID

public String getTypeGUID()

Return the unique GUID for the type.

Returns:

String unique identifier

setTypeGUID

public void setTypeGUID(String typeGUID)

Set up the unique GUID of the type.

Parameters:

typeGUID - String unique identifier

getTypeName

public String getTypeName()

Return the name of the type.

Returns:

String type name

setTypeName

public void setTypeName(String typeName)

Set up the name of the type.

Parameters:

typeName - String type name

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 that an object is equal depending on their stored values.

Overrides:

equals in class Object

Parameters:

objectToCompare - object

Returns:

boolean result

hashCode

public int hashCode()

Return a hash code based on the property values

Overrides:

hashCode in class Object

Returns:

int hash code