com.ergotech.vib.valueobjects

Class ArrayValueObject

java.lang.Object

com.ergotech.vib.valueobjects.ValueObject

com.ergotech.vib.valueobjects.ArrayValueObject

All Implemented Interfaces:

ValueObjectInterface, java.lang.Cloneable, java.lang.Iterable<ValueObjectInterface>, java.util.Collection<ValueObjectInterface>, java.util.List<ValueObjectInterface>

Direct Known Subclasses:

HistoricalValueObject

public class ArrayValueObject
extends ValueObject
implements java.util.List<ValueObjectInterface>

This will store an array of objects. These will be everything we need to fill in a historical strip chart from a client. This will be the ONLY class (including subclasses) that the historical strip chart will accept.

Field Summary

Fields inherited from class com.ergotech.vib.valueobjects.ValueObject

defaultTTL, locale, traceDefault, valueForTrue

Fields inherited from interface com.ergotech.vib.valueobjects.ValueObjectInterface

ANYTYPE, ARRAYTYPE, BINARYTYPE, BOOLEANTYPE, BYTETYPE, CHARTYPE, DISPLAYVALUE, DOUBLETYPE, FLOATTYPE, GROUP_NAME, INITIALVALUE, INTTYPE, LOG_MESSAGE, LONGTYPE, NAME, OBJECTTYPE, ORDER, PASSWORD_DIGEST, PROPERTYTYPE, QUALITY_BAD, QUALITY_COMM_FAILURE, QUALITY_DEVICE_FAILURE, QUALITY_EGU_EXCEEDED, QUALITY_EVALUATION_EXPIRED, QUALITY_GOOD, QUALITY_IMPOSSIBLE, QUALITY_INITIAL, QUALITY_LAST_USABLE, QUALITY_OUT_OF_SERVICE, QUALITY_PROPERTYONLY, QUALITY_REMOTE_PROXY_INIT, QUALITY_SIMULATED, QUALITY_SOURCE_REMOVED, QUALITY_TRANSITIONAL, QUALITY_UNKNOWN, QUALITY_WARNING, QUALITY_WORST, QUALITY_WRITE_IN_PROGRESS, REQUESTCURRENTVALUE, REQUESTHISTORICAL, SHORTTYPE, STRINGTYPE, TRACE, TWODTYPE, UNSIGNEDBYTETYPE, UNSIGNEDINTTYPE, UNSIGNEDLONGTYPE, UNSIGNEDSHORTTYPE, USER_NAME

Constructor Summary

Constructors

Constructor and Description
ArrayValueObject()
ArrayValueObject(int size) Create an object with a given size in the default locale.
ArrayValueObject(int size, java.util.Locale locale) Create an object with a given size and in a particular locale.
ArrayValueObject(java.lang.Object[] array) Create a new object from a vector.
ArrayValueObject(java.lang.Object[] array, java.util.Locale locale) Create a new object from a vector.
ArrayValueObject(java.util.Vector<ValueObjectInterface> values)
ArrayValueObject(java.util.Vector<ValueObjectInterface> values, java.util.Locale locale) Create an object from a vector in a given locale.

Method Summary

Modifier and Type	Method and Description
void	acquirePropertiesFrom(ValueObjectInterface source) Copies many of the attributes from this object to the target object.
void	add(int index, ValueObjectInterface element)
boolean	add(ValueObjectInterface e)
boolean	addAll(java.util.Collection<? extends ValueObjectInterface> c)
boolean	addAll(int index, java.util.Collection<? extends ValueObjectInterface> c)
void	addElement(ValueObjectInterface newValue) Adds a value to the array.
void	clear() This clears the Vector using removeAllElements.
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
ValueObjectInterface	copy() This will return a full copy of the ValueObject.
ValueObjectInterface	elementAt(int location) Returns the element at the given location in the array.
boolean	equals(java.lang.Object obj) This method is in every subclass of Object.
ValueObjectInterface	get(int location) Returns the element at the given location in the array.
byte[]	getBinaryValue() This will return the current value of the ValueObject as a byte array by calling getByteValue on each element of the array.
boolean	getBoolValue() This will return the current value of the ValueObject as a boolean.
byte	getByteValue() This will return the current value of the ValueObject as a byte.
char	getCharValue() This will return the current value of the ValueObject as a char.
double	getDoubleValue() This will return the current value of the ValueObject as a double.
char	getElementType()
float	getFloatValue() This will return the current value of the ValueObject as a float.
int	getIntValue() This will return the current value of the ValueObject as a int.
java.util.Locale	getLocale() This method returns the Locale that this object was created in.
long	getLongValue() This will return the current value of the ValueObject as a long.
double	getNumericValue() This will return the current value as a double.
java.lang.Object	getObjectValue() This will return the current value of the ValueObject as a Object.
short	getShortValue() This will return the current value of the ValueObject as a short.
java.lang.String	getStringValue() This will return the current value of the ValueObject as a String.
ValueObjectInterface	getValue(int loc) This returns the ValueObject at the requested index
java.util.Vector<ValueObjectInterface>	getValues() Returns the vector of the array.
int	hashCode()
int	indexOf(java.lang.Object o)
boolean	isEmpty()
java.util.Iterator<ValueObjectInterface>	iterator()
int	lastIndexOf(java.lang.Object o)
java.util.ListIterator<ValueObjectInterface>	listIterator()
java.util.ListIterator<ValueObjectInterface>	listIterator(int index)
ValueObjectInterface	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
ValueObjectInterface	set(int index, ValueObjectInterface element)
void	setElementType(char elementType)
void	setQuality(int newValue) Changing the quality of the array will change the quality of the components in the array such that all values are at least as bad as the array.
void	setTTL(int ttl) Set the TTLs of all the value objects in the array.
void	setValue(ValueObjectInterface newValue)
void	setValues(java.util.Vector<ValueObjectInterface> values) sets the elements of the array from a vector
int	size() This returns the size
java.util.List<ValueObjectInterface>	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
java.lang.String	toJSON(boolean incFormatted, boolean stringDate) Creates a json array.

Methods inherited from class com.ergotech.vib.valueobjects.ValueObject

acquireLatestPropertiesFrom, attributeNames, compareTo, convertToLowestPrecisionNumber, decrementTTL, escapeJSON, getAlwaysSend, getColor, getDate, getLowestPrecisionValueObject, getProperties, getProperty, getQuality, getQualityString, getTime, getTimeMillis, getTTL, getType, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, getValueObject, replaces, setAlwaysSend, setColor, setDate, setLocale, setProperty, setTimeMillis, setType, setValueForTrue, shouldTrace, toJSON, toJSON, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ArrayValueObject

public ArrayValueObject()

ArrayValueObject

public ArrayValueObject(int size)

Create an object with a given size in the default locale.

ArrayValueObject

public ArrayValueObject(int size,
                        java.util.Locale locale)

Create an object with a given size and in a particular locale.

ArrayValueObject

public ArrayValueObject(java.lang.Object[] array)

Create a new object from a vector. Note that the argument is an array of Objects. An array of primatives is not acceptable. The objects will be converted to value objects if they are not already.

ArrayValueObject

public ArrayValueObject(java.lang.Object[] array,
                        java.util.Locale locale)

Create a new object from a vector. Note that the argument is an array of Objects. An array of primatives is not acceptable. The objects will be converted to value objects if they are not already.

ArrayValueObject

public ArrayValueObject(java.util.Vector<ValueObjectInterface> values)

ArrayValueObject

public ArrayValueObject(java.util.Vector<ValueObjectInterface> values,
                        java.util.Locale locale)

Create an object from a vector in a given locale.

Method Detail

acquirePropertiesFrom

public void acquirePropertiesFrom(ValueObjectInterface source)

Description copied from class: ValueObject

Copies many of the attributes from this object to the target object. The Type is not copied. Color is copied if it is not null, Quality is copied if worse. All other properties are copied to the target.

Specified by:

acquirePropertiesFrom in interface ValueObjectInterface

Overrides:

acquirePropertiesFrom in class ValueObject

add

public void add(int index,
                ValueObjectInterface element)

Specified by:

add in interface java.util.List<ValueObjectInterface>

add

public boolean add(ValueObjectInterface e)

Specified by:

add in interface java.util.Collection<ValueObjectInterface>

Specified by:

add in interface java.util.List<ValueObjectInterface>

addAll

public boolean addAll(java.util.Collection<? extends ValueObjectInterface> c)

Specified by:

addAll in interface java.util.Collection<ValueObjectInterface>

Specified by:

addAll in interface java.util.List<ValueObjectInterface>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends ValueObjectInterface> c)

Specified by:

addAll in interface java.util.List<ValueObjectInterface>

addElement

public void addElement(ValueObjectInterface newValue)

Adds a value to the array.

clear

public void clear()

This clears the Vector using removeAllElements. The size is also set to zero.

Specified by:

clear in interface java.util.Collection<ValueObjectInterface>

Specified by:

clear in interface java.util.List<ValueObjectInterface>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<ValueObjectInterface>

Specified by:

contains in interface java.util.List<ValueObjectInterface>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<ValueObjectInterface>

Specified by:

containsAll in interface java.util.List<ValueObjectInterface>

copy

public ValueObjectInterface copy()

This will return a full copy of the ValueObject. This will NOT be a shallow copy. It will be a deep copy. Even the values inside the value will be copied.

Specified by:

copy in interface ValueObjectInterface

elementAt

public ValueObjectInterface elementAt(int location)

Returns the element at the given location in the array.

equals

public boolean equals(java.lang.Object obj)

This method is in every subclass of Object. So, why did we add it to the interface? To remind everyone that we require an equals method to be overridden so that the time is not taken into consideration when deciding its equality. We have some cases that we will make a copy of the valueObject then check to see from the server if it's changed. This can cause an error if the value it just sent us is now different because the times are slightly off. It is also will speed everything up if we don't send updates a millisecond apart if their values are identical.

Specified by:

equals in interface ValueObjectInterface

Specified by:

equals in interface java.util.Collection<ValueObjectInterface>

Specified by:

equals in interface java.util.List<ValueObjectInterface>

Overrides:

equals in class ValueObject

Returns:

a boolean result of the equals operation

get

public ValueObjectInterface get(int location)

Returns the element at the given location in the array.

Specified by:

get in interface java.util.List<ValueObjectInterface>

getBinaryValue

public byte[] getBinaryValue()

This will return the current value of the ValueObject as a byte array by calling getByteValue on each element of the array.

Specified by:

getBinaryValue in interface ValueObjectInterface

Overrides:

getBinaryValue in class ValueObject

Returns:

the value as a String

getBoolValue

public boolean getBoolValue()

This will return the current value of the ValueObject as a boolean.

Specified by:

getBoolValue in interface ValueObjectInterface

Returns:

the value as a boolean

getByteValue

public byte getByteValue()

This will return the current value of the ValueObject as a byte.

Specified by:

getByteValue in interface ValueObjectInterface

Returns:

the value as a byte

getCharValue

public char getCharValue()

This will return the current value of the ValueObject as a char.

getDoubleValue

public double getDoubleValue()

This will return the current value of the ValueObject as a double.

Specified by:

getDoubleValue in interface ValueObjectInterface

Returns:

the value as a double

See Also:

ValueObjectInterface.getNumericValue()

getElementType

public char getElementType()

Returns:

the elementType

getFloatValue

public float getFloatValue()

This will return the current value of the ValueObject as a float.

Specified by:

getFloatValue in interface ValueObjectInterface

Returns:

the value as a float

getIntValue

public int getIntValue()

This will return the current value of the ValueObject as a int.

Specified by:

getIntValue in interface ValueObjectInterface

Returns:

the value as an int

getLocale

public java.util.Locale getLocale()

This method returns the Locale that this object was created in. It may return null if the object has no interest in Locales.

Specified by:

getLocale in interface ValueObjectInterface

Overrides:

getLocale in class ValueObject

getLongValue

public long getLongValue()

This will return the current value of the ValueObject as a long.

Specified by:

getLongValue in interface ValueObjectInterface

Returns:

the value as a long

getNumericValue

public double getNumericValue()
                       throws java.lang.NumberFormatException

This will return the current value as a double. This will throw a NumberFormatException is the current Value can not be converted (if it is a string for instance).

Specified by:

getNumericValue in interface ValueObjectInterface

Returns:

the value as a double

Throws:

java.lang.NumberFormatException

See Also:

ValueObjectInterface.getDoubleValue()

getObjectValue

public java.lang.Object getObjectValue()

This will return the current value of the ValueObject as a Object.

Specified by:

getObjectValue in interface ValueObjectInterface

Returns:

the value as an Object

getShortValue

public short getShortValue()

This will return the current value of the ValueObject as a short.

Specified by:

getShortValue in interface ValueObjectInterface

Returns:

the value as a short

getStringValue

public java.lang.String getStringValue()

This will return the current value of the ValueObject as a String.

Specified by:

getStringValue in interface ValueObjectInterface

Returns:

the value as a String

getValue

public ValueObjectInterface getValue(int loc)

This returns the ValueObject at the requested index

getValues

public java.util.Vector<ValueObjectInterface> getValues()

Returns the vector of the array.

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<ValueObjectInterface>

Specified by:

hashCode in interface java.util.List<ValueObjectInterface>

Overrides:

hashCode in class ValueObject

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<ValueObjectInterface>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<ValueObjectInterface>

Specified by:

isEmpty in interface java.util.List<ValueObjectInterface>

iterator

public java.util.Iterator<ValueObjectInterface> iterator()

Specified by:

iterator in interface java.lang.Iterable<ValueObjectInterface>

Specified by:

iterator in interface java.util.Collection<ValueObjectInterface>

Specified by:

iterator in interface java.util.List<ValueObjectInterface>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<ValueObjectInterface>

listIterator

public java.util.ListIterator<ValueObjectInterface> listIterator()

Specified by:

listIterator in interface java.util.List<ValueObjectInterface>

listIterator

public java.util.ListIterator<ValueObjectInterface> listIterator(int index)

Specified by:

listIterator in interface java.util.List<ValueObjectInterface>

remove

public ValueObjectInterface remove(int index)

Specified by:

remove in interface java.util.List<ValueObjectInterface>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<ValueObjectInterface>

Specified by:

remove in interface java.util.List<ValueObjectInterface>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<ValueObjectInterface>

Specified by:

removeAll in interface java.util.List<ValueObjectInterface>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<ValueObjectInterface>

Specified by:

retainAll in interface java.util.List<ValueObjectInterface>

set

public ValueObjectInterface set(int index,
                                ValueObjectInterface element)

Specified by:

set in interface java.util.List<ValueObjectInterface>

setElementType

public void setElementType(char elementType)

Parameters:

elementType - the elementType to set

setQuality

public void setQuality(int newValue)

Changing the quality of the array will change the quality of the components in the array such that all values are at least as bad as the array. That is, any value in the array that has a quality that is better than the quality that is passed in will be changed so that it has the quality that is passed in. Any component that has a quality that is worse than the quality that is passed in will not be changed.

Specified by:

setQuality in interface ValueObjectInterface

Overrides:

setQuality in class ValueObject

Parameters:

newValue - the data quality

See Also:

ValueObjectInterface.setQuality(int)

setTTL

public void setTTL(int ttl)

Set the TTLs of all the value objects in the array. This solves a problem where values used by an array element filter will expire.

Specified by:

setTTL in interface ValueObjectInterface

Overrides:

setTTL in class ValueObject

Parameters:

ttl - The ttl to set.

setValue

public void setValue(ValueObjectInterface newValue)

setValues

public void setValues(java.util.Vector<ValueObjectInterface> values)

sets the elements of the array from a vector

size

public int size()

This returns the size

Specified by:

size in interface java.util.Collection<ValueObjectInterface>

Specified by:

size in interface java.util.List<ValueObjectInterface>

subList

public java.util.List<ValueObjectInterface> subList(int fromIndex,
                                                    int toIndex)

Specified by:

subList in interface java.util.List<ValueObjectInterface>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<ValueObjectInterface>

Specified by:

toArray in interface java.util.List<ValueObjectInterface>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<ValueObjectInterface>

Specified by:

toArray in interface java.util.List<ValueObjectInterface>

toJSON

public java.lang.String toJSON(boolean incFormatted,
                               boolean stringDate)

Creates a json array.

Overrides:

toJSON in class ValueObject

Parameters:

incFormatted - true if the string value of this value object is to be provided under the "formattedValue" key

stringDate - if true, the "timestamp" key will be a String of the form "yyyy-MM-dd HH:mm:ss.zzz"

Returns:

A json array