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

Class ArrayPropertyValue

java.lang.Object

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

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

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

All Implemented Interfaces:

Serializable

public class ArrayPropertyValue
extends InstancePropertyValue

ArrayPropertyValue stores the values of an array within an entity or relationship properties. The elements of the array are stored in an InstanceProperties map where the property name is set to the element number and the property value is set to the value of the element in the array.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ArrayPropertyValue()	Default constructor sets the array to empty.
ArrayPropertyValue(ArrayPropertyValue template)	Copy/clone constructor set up the array using the supplied template.

Method Summary

Modifier and Type	Method	Description
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.
int	getArrayCount()	Return the number of elements in the array.
InstanceProperties	getArrayValues()	Return a copy of the array elements.
int	hashCode()	Return a hash code based on the property values
void	setArrayCount(int arrayCount)	Set up the number of elements in the array.
void	setArrayValue(int elementNumber, InstancePropertyValue propertyValue)	Add or update an element in the array.
void	setArrayValues(InstanceProperties arrayValues)	Set up the array elements in one call.
String	toString()	Standard toString method.
Object	valueAsObject()	Return the object version of the value - used for comparisons.
String	valueAsString()	Return the string version of the value - used for error logging.

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstancePropertyValue

getInstancePropertyCategory, getTypeGUID, getTypeName, mapValuesAsObject, mapValuesAsString, setInstancePropertyCategory, setTypeGUID, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayPropertyValue

public ArrayPropertyValue()

Default constructor sets the array to empty.

ArrayPropertyValue

public ArrayPropertyValue(ArrayPropertyValue template)

Copy/clone constructor set up the array using the supplied template.

Parameters:

template - ArrayPropertyValue

Method Detail

cloneFromSubclass

public InstancePropertyValue cloneFromSubclass()

Delegate the process of cloning to the subclass.

Specified by:

cloneFromSubclass in class InstancePropertyValue

Returns:

subclass of InstancePropertyValue

valueAsString

public String valueAsString()

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

Specified by:

valueAsString in class InstancePropertyValue

Returns:

string value

valueAsObject

public Object valueAsObject()

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

Specified by:

valueAsObject in class InstancePropertyValue

Returns:

object value

getArrayCount

public int getArrayCount()

Return the number of elements in the array.

Returns:

int array size

setArrayCount

public void setArrayCount(int arrayCount)

Set up the number of elements in the array.

Parameters:

arrayCount - int array size

getArrayValues

public InstanceProperties getArrayValues()

Return a copy of the array elements.

Returns:

InstanceProperties containing the array elements

setArrayValue

public void setArrayValue(int elementNumber,
                          InstancePropertyValue propertyValue)

Add or update an element in the array.

Parameters:

elementNumber - index number of the element in the array

propertyValue - value to store

setArrayValues

public void setArrayValues(InstanceProperties arrayValues)

Set up the array elements in one call.

Parameters:

arrayValues - InstanceProperties containing the array elements

toString

public String toString()

Standard toString method.

Overrides:

toString in class InstancePropertyValue

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 InstancePropertyValue

Parameters:

objectToCompare - object

Returns:

boolean result

hashCode

public int hashCode()

Return a hash code based on the property values

Overrides:

hashCode in class InstancePropertyValue

Returns:

int hash code