TwoDimensionalValueObject (ErgoTech VIB/TransSECS Scripting API)

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

All Implemented Interfaces:

ValueObjectInterface, java.lang.Cloneable
```
public class TwoDimensionalValueObject
extends ValueObject
```
This is a object that can hold a two dimensional array of ValueObjects. This makes it convenient to store values from a database table. The data is stored in column format with each column being represented by a vector. There are n of these where n is the number of rows. All these are stored in a single vector "values". That is, the size of the Vector is the number of rows of the data. That is, the organization is: Vector 'Values' (size()== number of columns) VectorColumn0 [Row0Value, Row1Value, ...] (size() = number of rows) VectorColumn1 [Row0Value, Row1Value, ...] VectorColumn2 [Row0Value, Row1Value, ...] .. getColumnCount() returns values.size() getRowCount() returns values.elementAt(0)).size() The data is square, that is, no column values are missing, no rows are short.

Field Summary

Fields
Modifier and Type Field and Description

static char SLIM_FORMAT_TYPE

static java.lang.String TIME_COLUMN_NAME
Property identifier for the "has time" property.
- 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

Fields
Modifier and Type	Field and Description
`static char`	`SLIM_FORMAT_TYPE`
`static java.lang.String`	`TIME_COLUMN_NAME` Property identifier for the "has time" property.

Constructor Summary

Constructors
Constructor and Description
`TwoDimensionalValueObject()` This is the generic constructor.
`TwoDimensionalValueObject(int columns)` This is the generic constructor , it creates an object in the default locale.
`TwoDimensionalValueObject(int columns, java.util.Locale locale)` This is the generic constructor.
`TwoDimensionalValueObject(java.util.Locale locale)` This is the generic constructor.
`TwoDimensionalValueObject(java.util.Vector<java.util.Vector<ValueObjectInterface>> values, java.util.Locale locale)` This is the generic constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRow(java.util.Vector<ValueObjectInterface> newValues)` This will add a new row.
`ValueObjectInterface`	`copy()` Returns a deep copy of the value object.
`void`	`deleteRow(int rowIndex)` Deletes the row.
`boolean`	`equals(java.lang.Object obj)` Compare the string values
`boolean`	`getBoolValue()` Returns the current value represented as a boolean.
`byte`	`getByteValue()` Returns the current value represented as an byte.
`char`	`getCharValue()` Returns the current value represented as a char.
`int`	`getColumnCount()` This will return the number of columns.
`java.util.Vector<ValueObjectInterface>`	`getColumnData(int columnIndex)` This is used to get all the data for a specific column.
`java.lang.String`	`getColumnName(int columnIndex)` This will return the name of a sepecific column.
`java.util.Vector<java.lang.String>`	`getColumnNames()` This will return the vector of names.
`double`	`getDoubleValue()` Returns the current value represented as a float.
`float`	`getFloatValue()` Returns the current value represented as an float.
`int`	`getIntValue()` Returns the current value represented as an integer.
`java.util.Locale`	`getLocale()` This method returns the Locale that this object was created in.
`long`	`getLongValue()` Returns the current value represented as a long.
`double`	`getNumericValue()` Returns the double value, but will throw an exception if the object isn't convertable.
`java.lang.Object`	`getObjectValue()` Returns the current value represented as an Object.
`java.util.Vector<ValueObjectInterface>`	`getRow(int rowIndex)` This will return a Vector of values for the given row.
`int`	`getRowCount()` This will return the number of rows.
`short`	`getShortValue()` Returns the current value represented as a short.
`java.lang.String`	`getStringValue()` Returns the current value represented as an String.
`java.lang.String`	`getTimeColumnName()` Returns the "HAS_TIME" property of the value object.
`ValueObjectInterface`	`getValueAt(int rowIndex, int columnIndex)` This will return the value at a specific location.
`int`	`hashCode()`
`boolean`	`hasTimeColumn()` Return whether the TwoDimensionalValueObject has a time column
`boolean`	`isCellEditable(int rowIndex, int columnIndex)` This will return false.
`boolean`	`isEncodeFat()`
`void`	`setColumn(int columns)` This will set the column count to "columns" and reset any data inside the 2d value object.
`void`	`setColumnAt(java.util.Vector<ValueObjectInterface> column, int index)` This will replace the column at the give index with the new column.
`void`	`setColumnName(java.lang.String name, int columnIndex)` This will set the applicationName of a specific column.
`void`	`setColumnNames(java.util.Vector<java.lang.String> names)` This will return the vector of names.
`void`	`setEncodeFat(boolean encodeFat)`
`void`	`setTimeColumnName(java.lang.String timeColumnName)` Sets the "HAS_TIME" property of the value object.
`void`	`setValueAt(ValueObjectInterface aValue, int rowIndex, int columnIndex)` The new value replaces the existing value at the row and column index provided.
`void`	`sort(int column, boolean descending)` Sort the values.
`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`	`toSlimJSON()`

Methods inherited from class com.ergotech.vib.valueobjects.ValueObject
acquireLatestPropertiesFrom, acquirePropertiesFrom, attributeNames, compareTo, convertToLowestPrecisionNumber, decrementTTL, escapeJSON, getAlwaysSend, getBinaryValue, 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, setQuality, setTimeMillis, setTTL, setType, setValueForTrue, shouldTrace, toJSON, toJSON, toString

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

- Field Detail
  - SLIM_FORMAT_TYPE
```
public static final char SLIM_FORMAT_TYPE
```
    See Also:
    
    Constant Field Values
  - TIME_COLUMN_NAME
```
public static final java.lang.String TIME_COLUMN_NAME
```
    Property identifier for the "has time" property.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TwoDimensionalValueObject
```
public TwoDimensionalValueObject()
```
    This is the generic constructor. This HAS to have setColumn called afterwards or it will throw many null pointer exceptions. This creates an object in the default locale.
  - TwoDimensionalValueObject
```
public TwoDimensionalValueObject(int columns)
```
    This is the generic constructor , it creates an object in the default locale.
  - TwoDimensionalValueObject
```
public TwoDimensionalValueObject(int columns,
                                 java.util.Locale locale)
```
    This is the generic constructor. This creates the object in the provided locale.
  - TwoDimensionalValueObject
```
public TwoDimensionalValueObject(java.util.Locale locale)
```
    This is the generic constructor. This HAS to have setColumn called afterwards or it will throw many null pointer exceptions. This creates an object in the provide locale.
  - TwoDimensionalValueObject
```
public TwoDimensionalValueObject(java.util.Vector<java.util.Vector<ValueObjectInterface>> values,
                                 java.util.Locale locale)
```
    This is the generic constructor. This creates the object in the provided locale, setting the columns to the provided values
- Method Detail
  - addRow
```
public void addRow(java.util.Vector<ValueObjectInterface> newValues)
```
    This will add a new row. This will check to make sure that all the values or of the right classes for their column.
  - copy
```
public ValueObjectInterface copy()
```
    Returns a deep copy of the value object.
    
    Returns:
    
    a deep copy of the value object
  - deleteRow
```
public void deleteRow(int rowIndex)
```
    Deletes the row.
    
    Parameters:
    
    rowIndex - the row to delete
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Description copied from class: ValueObject
    
    Compare the string values
    
    Specified by:
    
    equals in interface ValueObjectInterface
    
    Overrides:
    
    equals in class ValueObject
    
    Returns:
    
    a boolean result of the equals operation
  - getBoolValue
```
public boolean getBoolValue()
```
    Returns the current value represented as a boolean.
    
    Returns:
    
    the current value as a boolean
  - getByteValue
```
public byte getByteValue()
```
    Returns the current value represented as an byte.
    
    Returns:
    
    the current value as a byte
  - getCharValue
```
public char getCharValue()
```
    Returns the current value represented as a char.
    
    Returns:
    
    the current value as a char
  - getColumnCount
```
public int getColumnCount()
```
    This will return the number of columns.
  - getColumnData
```
public java.util.Vector<ValueObjectInterface> getColumnData(int columnIndex)
```
    This is used to get all the data for a specific column.
  - getColumnName
```
public java.lang.String getColumnName(int columnIndex)
```
    This will return the name of a sepecific column.
  - getColumnNames
```
public java.util.Vector<java.lang.String> getColumnNames()
```
    This will return the vector of names.
  - getDoubleValue
```
public double getDoubleValue()
```
    Returns the current value represented as a float.
    
    Returns:
    
    the current value as a double
    
    See Also:
    
    ValueObjectInterface.getNumericValue()
  - getFloatValue
```
public float getFloatValue()
```
    Returns the current value represented as an float.
    
    Returns:
    
    the current value as an float
  - getIntValue
```
public int getIntValue()
```
    Returns the current value represented as an integer.
    
    Returns:
    
    the current value as an integer
  - 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()
```
    Returns the current value represented as a long.
    
    Returns:
    
    the current value as a long
  - getNumericValue
```
public double getNumericValue()
                       throws java.lang.NumberFormatException
```
    Returns the double value, but will throw an exception if the object isn't convertable.
    
    Returns:
    
    the current value as a double
    
    Throws:
    
    java.lang.NumberFormatException
    
    See Also:
    
    ValueObjectInterface.getDoubleValue()
  - getObjectValue
```
public java.lang.Object getObjectValue()
```
    Returns the current value represented as an Object.
    
    Returns:
    
    the current value as an Object
  - getRow
```
public java.util.Vector<ValueObjectInterface> getRow(int rowIndex)
```
    This will return a Vector of values for the given row.
  - getRowCount
```
public int getRowCount()
```
    This will return the number of rows.
  - getShortValue
```
public short getShortValue()
```
    Returns the current value represented as a short.
    
    Returns:
    
    the current value as a short
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns the current value represented as an String.
    
    Returns:
    
    the current value as a String
  - getTimeColumnName
```
public java.lang.String getTimeColumnName()
```
    Returns the "HAS_TIME" property of the value object. The column name may be null, which indicates that this object does not have a time column.
    
    Returns:
    
    the name of the time column, which may be null
  - getValueAt
```
public ValueObjectInterface getValueAt(int rowIndex,
                                       int columnIndex)
```
    This will return the value at a specific location. If there aren't that many rows or columns, it will return null;
    
    Parameters:
    
    rowIndex - zero-based row index.
    
    columnIndex - zero-based column index.
    
    Returns:
    
    the value at the given row,column or null if that location does not exist
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class ValueObject
  - hasTimeColumn
```
public boolean hasTimeColumn()
```
    Return whether the TwoDimensionalValueObject has a time column
    
    Returns:
  - isCellEditable
```
public boolean isCellEditable(int rowIndex,
                              int columnIndex)
```
    This will return false.
  - isEncodeFat
```
public boolean isEncodeFat()
```
    Returns:
    
    the encodeFat
  - setColumn
```
public void setColumn(int columns)
```
    This will set the column count to "columns" and reset any data inside the 2d value object.
  - setColumnAt
```
public void setColumnAt(java.util.Vector<ValueObjectInterface> column,
                        int index)
```
    This will replace the column at the give index with the new column. It is permissible to use this to add a column, but in this case, the column index must be equal to the current column count. That is, the columns must be added sequentially, there cannot be gaps in the column indices. Whether adding or replacing a column, the size of the column Vector must be the same as the number of rows currently in the value object.
    
    Parameters:
    
    column - the new data
    
    index - the index of the column to replace.
  - setColumnName
```
public void setColumnName(java.lang.String name,
                          int columnIndex)
```
    This will set the applicationName of a specific column. This can be used in conjunction with setColumnAt to increase the size of the data stored. ColumnIndex must be <= the column count. If columnIndex is == the column count then a new column will be added.
  - setColumnNames
```
public void setColumnNames(java.util.Vector<java.lang.String> names)
```
    This will return the vector of names.
  - setEncodeFat
```
public void setEncodeFat(boolean encodeFat)
```
    Parameters:
    
    encodeFat - the encodeFat to set
  - setTimeColumnName
```
public void setTimeColumnName(java.lang.String timeColumnName)
```
    Sets the "HAS_TIME" property of the value object. The column name may be null, which indicates that this object does not have a time column.
    
    Parameters:
    
    timeColumnName - the name of the time column, which may be null
  - setValueAt
```
public void setValueAt(ValueObjectInterface aValue,
                       int rowIndex,
                       int columnIndex)
```
    The new value replaces the existing value at the row and column index provided.
    
    Parameters:
    
    aValue - the new value for the given location
    
    rowIndex - the row index for the new value
    
    columnIndex - the column index for the new value
  - sort
```
public void sort(int column,
                 boolean descending)
```
    Sort the values. This will rearrange all the rows so that the values in the given column are sorted in the correct order. This is a fairly expensive operation it is much preferable to specify a sort or in, for example, a SQL query, than to sort the value after the query.
    
    Parameters:
    
    column - the column to use for the sort ordering
    
    descending - true if the value should go from high to low
  - toJSON
```
public java.lang.String toJSON(boolean incFormatted,
                               boolean stringDate,
                               java.lang.String dateFormat)
```
    Description copied from class: ValueObject
    
    Build a json representation of the object, structured: { "type": "object"|"array"|"2d", "value": \, "timestamp": \, {"header": \} }
    
    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 string
  - toSlimJSON
```
public java.lang.String toSlimJSON()
```

Class TwoDimensionalValueObject

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

SLIM_FORMAT_TYPE

TIME_COLUMN_NAME

Constructor Detail

TwoDimensionalValueObject

TwoDimensionalValueObject

TwoDimensionalValueObject

TwoDimensionalValueObject

TwoDimensionalValueObject

Method Detail

addRow

copy

deleteRow

equals

getBoolValue

getByteValue

getCharValue

getColumnCount

getColumnData

getColumnName

getColumnNames

getDoubleValue

getFloatValue

getIntValue

getLocale

getLongValue

getNumericValue

getObjectValue

getRow

getRowCount

getShortValue

getStringValue

getTimeColumnName

getValueAt

hashCode

hasTimeColumn

isCellEditable

isEncodeFat

setColumn

setColumnAt

setColumnName

setColumnNames

setEncodeFat

setTimeColumnName

setValueAt

sort

toJSON

toSlimJSON