Class ArrayPropertyValue

  • All Implemented Interfaces:
    Serializable

    public class ArrayPropertyValue
    extends PropertyValue
    ArrayPropertyValue stores the values of an array within an entity or relationship properties. The elements of the array are stored in an ElementProperties 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 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

      • valueAsString

        public String valueAsString()
        Return the string version of the value - used for error logging.
        Specified by:
        valueAsString in class PropertyValue
        Returns:
        string value
      • valueAsObject

        public Object valueAsObject()
        Return the object version of the value - used for comparisons.
        Specified by:
        valueAsObject in class PropertyValue
        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 ElementProperties getArrayValues()
        Return a copy of the array elements.
        Returns:
        ElementProperties containing the array elements
      • setArrayValue

        public void setArrayValue​(int elementNumber,
                                  PropertyValue 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​(ElementProperties arrayValues)
        Set up the array elements in one call.
        Parameters:
        arrayValues - ElementProperties containing the array elements
      • toString

        public String toString()
        Standard toString method.
        Overrides:
        toString in class PropertyValue
        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 PropertyValue
        Parameters:
        objectToCompare - object
        Returns:
        boolean result
      • hashCode

        public int hashCode()
        Return a hash code based on the property values
        Overrides:
        hashCode in class PropertyValue
        Returns:
        int hash code