ValueObject (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.valueobjects.ValueObject

All Implemented Interfaces:

ValueObjectInterface, java.lang.Cloneable

Direct Known Subclasses:

ArrayValueObject, BinaryValueObject, BooleanObjectValueObject, DateRangeValueObject, DoubleValueObject, GenericValueObject, LongValueObject, NumberObjectValueObject, PropertyValueObject, SecsFormatValueObject, StringValueObject, TwoDimensionalValueObject
```
public abstract class ValueObject
extends java.lang.Object
implements ValueObjectInterface, java.lang.Cloneable
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`defaultTTL` This is the default "time to live".
`java.util.Locale`	`locale` The Locale that this object was created in.
`static boolean`	`traceDefault` Set to true to force connector tracing.
`static double`	`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

ValueObject()
Generic constructor.

ValueObject(java.util.Locale locale)
Generic constructor.

Constructors
Constructor and Description
`ValueObject()` Generic constructor.
`ValueObject(java.util.Locale locale)` Generic constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`acquireLatestPropertiesFrom(ValueObjectInterface target, ValueObjectInterface source1, ValueObjectInterface source2)` This method will do an "acquirePropertiesFrom" on both the incoming values.
`void`	`acquirePropertiesFrom(ValueObjectInterface source)` Copies many of the attributes from this object to the target object.
`java.util.Enumeration<java.lang.String>`	`attributeNames()` This will return an enumeration of all the current keys.
`int`	`compareTo(ValueObjectInterface otherValueObject)` This is our implementation (for JDK 1.1 compatibility) of the Comparable interface of Java 2.
`ValueObjectInterface`	`convertToLowestPrecisionNumber()` This returns the ValueObject unadulterated.
`int`	`decrementTTL()` Decrements and returns the current value of the ttl field.
`boolean`	`equals(java.lang.Object obj)` Compare the string values
`static java.lang.String`	`escapeJSON(java.lang.String original)`
`boolean`	`getAlwaysSend()` This is if you always want this value to be send to the client...
`byte[]`	`getBinaryValue()` This will return the current value of the ValueObject as a byte array.
`java.awt.Color`	`getColor()` This will return the color associated with the current value.
`java.util.Date`	`getDate()` This is the date and time when the value was created.
`java.util.Locale`	`getLocale()` This method returns the Locale that this object was created in.
`static ValueObjectInterface`	`getLowestPrecisionValueObject(java.lang.String value)` Returns the lowest precision value object that the string can be converted to.
`java.util.Map<java.lang.String,java.lang.Object>`	`getProperties()` Return a copy of the properties map.
`java.lang.Object`	`getProperty(java.lang.String attribute)` This is additional information that is sent with the property.
`int`	`getQuality()` This is the quality of the reading.
`static java.lang.String`	`getQualityString(int quality)` Returns a descriptive string for the given quality.
`double`	`getTime()` this will return the date as a double ((double)date.getTime())/1000
`long`	`getTimeMillis()` This will return the number of milliseconds since Jan 1st 1970.
`int`	`getTTL()`
`char`	`getType()` Returns a 'C','Z', 'B', 'I', 'F', 'J', 'S', 'D', 'L', or 's' depending on if the currentValue was set as a char, boolean, byte, int, float, long, short, double, serializable object, or a string.
`static ValueObjectInterface`	`getValueObject(boolean newValue)` Static method that will return a LongValueObject generated from the newValue.
`static ValueObjectInterface`	`getValueObject(byte newValue)` Static method that will return a LongValueObject generated from the newValue.
`static ValueObjectInterface`	`getValueObject(char newValue)` Static method that will return a LongValueObject generated from the newValue.
`static ValueObjectInterface`	`getValueObject(java.awt.Color color)` Static method that will return a GenericValueObject generated from the Color.
`static ValueObjectInterface`	`getValueObject(double newValue)` Static method that will return a DoubleValueObject generated from the newValue.
`static ValueObjectInterface`	`getValueObject(float newValue)` Static method that will return a DoubleValueObject generated from the newValue.
`static ValueObjectInterface`	`getValueObject(int newValue)` Static method that will return a LongValueObject generated from the newValue.
`static ValueObjectInterface`	`getValueObject(long newValue)` Static method that will return a LongValueObject generated from the newValue.
`static ValueObjectInterface`	`getValueObject(java.lang.Object newValue)`
`static ValueObjectInterface`	`getValueObject(short newValue)` Static method that will return a LongValueObject generated from the newValue.
`static ValueObjectInterface`	`getValueObject(java.lang.String newValue)` Static method that will return a StringValueObject generated from the newValue.
`int`	`hashCode()`
`boolean`	`replaces(ValueObjectInterface oldValue, double deadband)` this is used to determine if we should send this valueobject to replace oldValue.
`void`	`setAlwaysSend(boolean newValue)` This is if you always want this value to be send to the client...
`void`	`setColor(java.awt.Color newColor)` Sets the color object.
`void`	`setDate(java.util.Date newValue)` This is the date and time when the value was created.
`void`	`setLocale(java.util.Locale locale)` Sets the locale.
`void`	`setProperty(java.lang.String attribute, java.lang.Object value)` This is additional information that is sent with the property.
`void`	`setQuality(int quality)` This is the quality of the reading.
`void`	`setTimeMillis(long timeMillis)` This will set the time as the number of milliseconds since Jan 1st 1970.
`void`	`setTTL(int ttl)`
`void`	`setType(char newValue)` This allows people to specify what type a specific subclass represents.
`static void`	`setValueForTrue(double newValue)` This will change the default value for true (when someone creates a valueobject sending the parameter of true, or the default hi value on a box.
`static boolean`	`shouldTrace(ValueObjectInterface value)` Returns true if the TRACE parameter is set and starts with a 'y' or 'Y'
`java.lang.String`	`toJSON()` Build a json representation of the object, structured: { "type": "object"\|"array"\|"2d", "value": \, "timestamp": \, {"header": \} }
`java.lang.String`	`toJSON(boolean incFormatted, boolean stringDate)` Build a json representation of the object, structured: { "type": "object"\|"array"\|"2d", "value": \, "timestamp": \, {"header": \} }
`java.lang.String`	`toJSON(boolean incFormatted, boolean stringDate, java.lang.String dateFormat)` Build a json representation of the object, structured: { "type": "object"\|"array"\|"2d", "value": \, "timestamp": \, {"header": \} }
`java.lang.String`	`toString()` This will display the value as a string.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ergotech.vib.valueobjects.ValueObjectInterface
copy, getBoolValue, getByteValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getNumericValue, getObjectValue, getShortValue, getStringValue

- Field Detail
  - defaultTTL
```
public static int defaultTTL
```
    This is the default "time to live". This value can be set with -Dvalueobject.ttl=xxx where xxx is the ttl value.
    
    See Also:
    
    ttl
  - locale
```
public java.util.Locale locale
```
    The Locale that this object was created in. This impacts number formatting. For example, in the US locale, "1.3" is a valid number, but in the GERMAN locale the equivelent is "1,3" and "1.3" is invalid. So, we must use the locale that the object was created in to perform the numeric conversions.
  - traceDefault
```
public static boolean traceDefault
```
    Set to true to force connector tracing.
  - valueForTrue
```
public static double valueForTrue
```
- Constructor Detail
  - ValueObject
```
public ValueObject()
```
    Generic constructor.
  - ValueObject
```
public ValueObject(java.util.Locale locale)
```
    Generic constructor.
- Method Detail
  - acquireLatestPropertiesFrom
```
public static void acquireLatestPropertiesFrom(ValueObjectInterface target,
                                               ValueObjectInterface source1,
                                               ValueObjectInterface source2)
```
    This method will do an "acquirePropertiesFrom" on both the incoming values. The "acquirePropertiesFrom" methods will be called in time order, with the value with the oldest timestamp being called first. This means that the properties from the newest object will take precedence over the properties of the oldest object. If the timestamps are identical, then the properties of source2 predominate. This method is called by any manipulator that has two inputs where neither input is a "trigger" examples include the calculations (add, subtract, etc.) and comparators (greater than, less than, etc.).
  - acquirePropertiesFrom
```
public void acquirePropertiesFrom(ValueObjectInterface source)
```
    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
    
    Parameters:
    
    target - the target of the copy
  - attributeNames
```
public java.util.Enumeration<java.lang.String> attributeNames()
```
    This will return an enumeration of all the current keys.
    
    Specified by:
    
    attributeNames in interface ValueObjectInterface
  - compareTo
```
public int compareTo(ValueObjectInterface otherValueObject)
```
    This is our implementation (for JDK 1.1 compatibility) of the Comparable interface of Java 2. The implementation corresponds to that of the Comparable interace compareTo method. The "otherValueObject" is a ValueObject to be compared to this ValueObject. If the "otherValueObject" is less than this, then a -1 is returned. If the "otherValueObject" is equal to this, then a 0 is returned. Otherwise a 1 is returned for the "otherValueObject" being greater than this.
    
    If the ValueObjects can both be converted to doubles, the comparison will be done numerically. Otherwise, if the ValueObjects are compared as Strings.
    
    Specified by:
    
    compareTo in interface ValueObjectInterface
    
    Parameters:
    
    otherValueObject - the object to be compared to
    
    Returns:
    
    an int (either -1, 0, or 1) depending on the comparison result.
  - convertToLowestPrecisionNumber
```
public ValueObjectInterface convertToLowestPrecisionNumber()
```
    This returns the ValueObject unadulterated. Special cases are handled by their own ValueObject types, such as StringValueObjects.
    
    Specified by:
    
    convertToLowestPrecisionNumber in interface ValueObjectInterface
    
    Returns:
    
    a ValueObject converted to a number of lowest precision
    
    See Also:
    
    StringValueObject
  - decrementTTL
```
public int decrementTTL()
```
    Decrements and returns the current value of the ttl field.
    
    Specified by:
    
    decrementTTL in interface ValueObjectInterface
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Compare the string values
    
    Specified by:
    
    equals in interface ValueObjectInterface
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    a boolean result of the equals operation
  - escapeJSON
```
public static java.lang.String escapeJSON(java.lang.String original)
```
  - getAlwaysSend
```
public boolean getAlwaysSend()
```
    This is if you always want this value to be send to the client... Event if the value appears to be the same.
    
    Specified by:
    
    getAlwaysSend in interface ValueObjectInterface
    
    Returns:
    
    a boolean stating if the data is to always be sent even if its value hasn't changed
    
    See Also:
    
    ValueObjectInterface.setAlwaysSend(boolean)
  - getBinaryValue
```
public byte[] getBinaryValue()
```
    This will return the current value of the ValueObject as a byte array. In this default implementation it returns getStringValue().getBytes();
    
    Specified by:
    
    getBinaryValue in interface ValueObjectInterface
    
    Returns:
    
    the value as a String
  - getColor
```
public java.awt.Color getColor()
```
    This will return the color associated with the current value. WARNING: This will, in many cases, be null. You should always assume that the value could be null. Not all data servers are required to change the color.
    
    Specified by:
    
    getColor in interface ValueObjectInterface
    
    Returns:
    
    the Color for the current value, if any
  - getDate
```
public java.util.Date getDate()
```
    This is the date and time when the value was created.
    
    Specified by:
    
    getDate in interface ValueObjectInterface
    
    Returns:
    
    the date the value was created
    
    See Also:
    
    setDate(java.util.Date)
  - getLocale
```
public java.util.Locale getLocale()
```
    This method returns the Locale that this object was created in. It may return null if the This object has no interest in Locales.
    
    Specified by:
    
    getLocale in interface ValueObjectInterface
  - getLowestPrecisionValueObject
```
public static ValueObjectInterface getLowestPrecisionValueObject(java.lang.String value)
```
    Returns the lowest precision value object that the string can be converted to. If the string does not convert to a number then a string value object containing the string is returned. If the string converts to an integer than a LongValueObject is returned, otherwise a DoubleValueObject.
    
    Returns:
    
    Returns the lowest precision value object that the string can be converted to
  - getProperties
```
public java.util.Map<java.lang.String,java.lang.Object> getProperties()
```
    Return a copy of the properties map.
    
    Returns:
    
    a copy of the properties map.
  - getProperty
```
public java.lang.Object getProperty(java.lang.String attribute)
```
    This is additional information that is sent with the property.
    
    Specified by:
    
    getProperty in interface ValueObjectInterface
    
    Parameters:
    
    attribute - additional information
    
    See Also:
    
    setProperty(java.lang.String, java.lang.Object)
  - getQuality
```
public int getQuality()
```
    This is the quality of the reading.
    
    Specified by:
    
    getQuality in interface ValueObjectInterface
    
    Returns:
    
    the data quality
    
    See Also:
    
    ValueObjectInterface.setQuality(int)
  - getQualityString
```
public static java.lang.String getQualityString(int quality)
```
    Returns a descriptive string for the given quality.
  - getTime
```
public double getTime()
```
    this will return the date as a double ((double)date.getTime())/1000
    
    Specified by:
    
    getTime in interface ValueObjectInterface
  - getTimeMillis
```
public long getTimeMillis()
```
    This will return the number of milliseconds since Jan 1st 1970.
    
    Specified by:
    
    getTimeMillis in interface ValueObjectInterface
  - getTTL
```
public int getTTL()
```
    Specified by:
    
    getTTL in interface ValueObjectInterface
    
    Returns:
    
    Returns the ttl.
  - getType
```
public char getType()
```
    Returns a 'C','Z', 'B', 'I', 'F', 'J', 'S', 'D', 'L', or 's' depending on if the currentValue was set as a char, boolean, byte, int, float, long, short, double, serializable object, or a string.
    
    Specified by:
    
    getType in interface ValueObjectInterface
    
    Returns:
    
    the type
  - getValueObject
```
public static ValueObjectInterface getValueObject(boolean newValue)
```
    Static method that will return a LongValueObject generated from the newValue.
  - getValueObject
```
public static ValueObjectInterface getValueObject(byte newValue)
```
    Static method that will return a LongValueObject generated from the newValue.
  - getValueObject
```
public static ValueObjectInterface getValueObject(char newValue)
```
    Static method that will return a LongValueObject generated from the newValue.
  - getValueObject
```
public static ValueObjectInterface getValueObject(java.awt.Color color)
```
    Static method that will return a GenericValueObject generated from the Color. The color, as returned by getColor will be the color parameter as will the value of the value object.
    
    Parameters:
    
    color - the color stored in the value object as well as the value of the object
  - getValueObject
```
public static ValueObjectInterface getValueObject(double newValue)
```
    Static method that will return a DoubleValueObject generated from the newValue.
  - getValueObject
```
public static ValueObjectInterface getValueObject(float newValue)
```
    Static method that will return a DoubleValueObject generated from the newValue.
  - getValueObject
```
public static ValueObjectInterface getValueObject(int newValue)
```
    Static method that will return a LongValueObject generated from the newValue.
  - getValueObject
```
public static ValueObjectInterface getValueObject(long newValue)
```
    Static method that will return a LongValueObject generated from the newValue.
  - getValueObject
```
public static ValueObjectInterface getValueObject(java.lang.Object newValue)
```
  - getValueObject
```
public static ValueObjectInterface getValueObject(short newValue)
```
    Static method that will return a LongValueObject generated from the newValue.
  - getValueObject
```
public static ValueObjectInterface getValueObject(java.lang.String newValue)
```
    Static method that will return a StringValueObject generated from the newValue.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - replaces
```
public boolean replaces(ValueObjectInterface oldValue,
                        double deadband)
```
    this is used to determine if we should send this valueobject to replace oldValue. Values are compared, but deadband was added since it is significant criterea for determining if the new value should be replaced. If the deadband does not matter, send a 0.00. The deadband is taken as an absolute difference of the numbers as doubles, and is therefore not used for Strings (unless they convert to numbers) AVOs and 2DVOs. Other factors that influence "repaces" are the quality (if it is different) and the Color.
    
    Specified by:
    
    replaces in interface ValueObjectInterface
  - setAlwaysSend
```
public void setAlwaysSend(boolean newValue)
```
    This is if you always want this value to be send to the client... Event if the value appears to be the same.
    
    Specified by:
    
    setAlwaysSend in interface ValueObjectInterface
    
    Parameters:
    
    newValue - a boolean setting the "always send" state
    
    See Also:
    
    ValueObjectInterface.getAlwaysSend()
  - setColor
```
public void setColor(java.awt.Color newColor)
```
    Sets the color object.
    
    Specified by:
    
    setColor in interface ValueObjectInterface
    
    Parameters:
    
    newColor - The color associated with the current value.
  - setDate
```
public void setDate(java.util.Date newValue)
```
    This is the date and time when the value was created.
    
    Specified by:
    
    setDate in interface ValueObjectInterface
    
    See Also:
    
    getDate()
  - setLocale
```
public void setLocale(java.util.Locale locale)
```
    Sets the locale. This is useful when the locale from a trigger must be preserved.
    
    Parameters:
    
    locale - The locale to set.
  - setProperty
```
public void setProperty(java.lang.String attribute,
                        java.lang.Object value)
```
    This is additional information that is sent with the property.
    
    Specified by:
    
    setProperty in interface ValueObjectInterface
    
    Parameters:
    
    attribute - the attribute String
    
    value - the Serializable value of this attribute
    
    See Also:
    
    #getValue
  - setQuality
```
public void setQuality(int quality)
```
    This is the quality of the reading.
    
    Specified by:
    
    setQuality in interface ValueObjectInterface
    
    Parameters:
    
    quality - the data quality
    
    See Also:
    
    ValueObjectInterface.getQuality()
  - setTimeMillis
```
public void setTimeMillis(long timeMillis)
```
    This will set the time as the number of milliseconds since Jan 1st 1970.
    
    Specified by:
    
    setTimeMillis in interface ValueObjectInterface
  - setTTL
```
public void setTTL(int ttl)
```
    Specified by:
    
    setTTL in interface ValueObjectInterface
    
    Parameters:
    
    ttl - The ttl to set.
  - setType
```
public void setType(char newValue)
```
    This allows people to specify what type a specific subclass represents.
    
    Specified by:
    
    setType in interface ValueObjectInterface
  - setValueForTrue
```
public static void setValueForTrue(double newValue)
```
    This will change the default value for true (when someone creates a valueobject sending the parameter of true, or the default hi value on a box. WARNING: This will NOT effect objects that are already created.
  - shouldTrace
```
public static boolean shouldTrace(ValueObjectInterface value)
```
    Returns true if the TRACE parameter is set and starts with a 'y' or 'Y'
    
    Returns:
    
    true if the TRACE parameter is set and starts with a 'y' or 'Y'
  - toJSON
```
public java.lang.String toJSON()
```
    Description copied from interface: ValueObjectInterface
    
    Build a json representation of the object, structured: { "type": "object"|"array"|"2d", "value": \, "timestamp": \, {"header": \} }
    
    Specified by:
    
    toJSON in interface ValueObjectInterface
    
    Returns:
    
    A json string
  - toJSON
```
public java.lang.String toJSON(boolean incFormatted,
                               boolean stringDate)
```
    Build a json representation of the object, structured: { "type": "object"|"array"|"2d", "value": \, "timestamp": \, {"header": \} }
    
    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 string
  - toJSON
```
public java.lang.String toJSON(boolean incFormatted,
                               boolean stringDate,
                               java.lang.String dateFormat)
```
    Build a json representation of the object, structured: { "type": "object"|"array"|"2d", "value": \, "timestamp": \, {"header": \} }
    
    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 string
  - toString
```
public java.lang.String toString()
```
    This will display the value as a string.
    
    Overrides:
    
    toString in class java.lang.Object

Class ValueObject

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

defaultTTL

locale

traceDefault

valueForTrue

Constructor Detail

ValueObject

ValueObject

Method Detail

acquireLatestPropertiesFrom

acquirePropertiesFrom

attributeNames

compareTo

convertToLowestPrecisionNumber

decrementTTL

equals

escapeJSON

getAlwaysSend

getBinaryValue

getColor

getDate

getLocale

getLowestPrecisionValueObject

getProperties

getProperty

getQuality

getQualityString

getTime

getTimeMillis

getTTL

getType

getValueObject

getValueObject

getValueObject

getValueObject

getValueObject

getValueObject

getValueObject

getValueObject

getValueObject

getValueObject

getValueObject

hashCode

replaces

setAlwaysSend

setColor

setDate

setLocale

setProperty

setQuality

setTimeMillis

setTTL

setType

setValueForTrue

shouldTrace

toJSON

toJSON

toJSON

toString