com.tivoli.twg.libs
Interface DataValue

All Known Implementing Classes:
TWGBoolean, TWGBooleanArray, TWGByte, TWGByteArray, TWGDate, TWGDouble, TWGDoubleArray, TWGFloat, TWGFloatArray, TWGInteger, TWGIntegerArray, TWGLong, TWGLongArray, TWGNLSString, TWGShort, TWGShortArray, TWGString, TWGStringArray

public interface DataValue

Interface for various "sendable" and "storable" data types. These are intended for use when data needs to be communicated to and from both Java and non-Java code.


Field Summary
static int BOOLEAN_ARRAY_TYPE
          Standard DataValue type - TWGBooleanArray
static int BOOLEAN_TYPE
          Standard DataValue type - TWGBoolean
static int BYTE_ARRAY_TYPE
          Standard DataValue type - TWGByteArray
static int BYTE_TYPE
          Standard DataValue type - TWGByte
static int DATE_TYPE
          Standard DataValue type - TWGDate
static int DOUBLE_ARRAY_TYPE
          Standard DataValue type - TWGDoubleArray
static int DOUBLE_TYPE
          Standard DataValue type - TWGDouble
static int FLOAT_ARRAY_TYPE
          Standard DataValue type - TWGFloatArray
static int FLOAT_TYPE
          Standard DataValue type - TWGFloat
static int FORMATTED_STRING_TYPE
          Standard DataValue type - TWGFormattedString (as of V2.11)
static int INTEGER_ARRAY_TYPE
          Standard DataValue type - TWGIntegerArray
static int INTEGER_TYPE
          Standard DataValue type - TWGInteger
static int LOCALESPECSTRING_TYPE
          Standard DataValue type - TWGLocaleSpecificString (as of V2.11)
static int LONG_ARRAY_TYPE
          Standard DataValue type - TWGLongArray
static int LONG_TYPE
          Standard DataValue type - TWGLong
static int NLSSTRING_TYPE
          Standard DataValue type - TWGNLSString
static int NONE_TYPE
          Standard DataValue type - none
static int SHORT_ARRAY_TYPE
          Standard DataValue type - TWGShortArray
static int SHORT_TYPE
          Standard DataValue type - TWGShort
static int STRING_ARRAY_TYPE
          Standard DataValue type - TWGStringArray
static int STRING_TYPE
          Standard DataValue type - TWGString
 
Method Summary
 int getDataValueType()
          Get DataValue type
 int readDataValue(byte[] buf, int start)
          Read value from byte array into object
 java.lang.String toNLSString(java.util.Locale loc)
          Get NLS-specific string representation
 int writeDataValue(byte[] buf, int start)
          Write value into byte array : used for sending data value
 int writeDataValueLength()
          Get length needed to write value into byte array : used for sending data value
 

Field Detail

STRING_TYPE

public static final int STRING_TYPE
Standard DataValue type - TWGString

See Also:
Constant Field Values

STRING_ARRAY_TYPE

public static final int STRING_ARRAY_TYPE
Standard DataValue type - TWGStringArray

See Also:
Constant Field Values

LONG_TYPE

public static final int LONG_TYPE
Standard DataValue type - TWGLong

See Also:
Constant Field Values

LONG_ARRAY_TYPE

public static final int LONG_ARRAY_TYPE
Standard DataValue type - TWGLongArray

See Also:
Constant Field Values

INTEGER_TYPE

public static final int INTEGER_TYPE
Standard DataValue type - TWGInteger

See Also:
Constant Field Values

INTEGER_ARRAY_TYPE

public static final int INTEGER_ARRAY_TYPE
Standard DataValue type - TWGIntegerArray

See Also:
Constant Field Values

SHORT_TYPE

public static final int SHORT_TYPE
Standard DataValue type - TWGShort

See Also:
Constant Field Values

SHORT_ARRAY_TYPE

public static final int SHORT_ARRAY_TYPE
Standard DataValue type - TWGShortArray

See Also:
Constant Field Values

BYTE_TYPE

public static final int BYTE_TYPE
Standard DataValue type - TWGByte

See Also:
Constant Field Values

BYTE_ARRAY_TYPE

public static final int BYTE_ARRAY_TYPE
Standard DataValue type - TWGByteArray

See Also:
Constant Field Values

BOOLEAN_TYPE

public static final int BOOLEAN_TYPE
Standard DataValue type - TWGBoolean

See Also:
Constant Field Values

BOOLEAN_ARRAY_TYPE

public static final int BOOLEAN_ARRAY_TYPE
Standard DataValue type - TWGBooleanArray

See Also:
Constant Field Values

DATE_TYPE

public static final int DATE_TYPE
Standard DataValue type - TWGDate

See Also:
Constant Field Values

DOUBLE_TYPE

public static final int DOUBLE_TYPE
Standard DataValue type - TWGDouble

See Also:
Constant Field Values

DOUBLE_ARRAY_TYPE

public static final int DOUBLE_ARRAY_TYPE
Standard DataValue type - TWGDoubleArray

See Also:
Constant Field Values

FLOAT_TYPE

public static final int FLOAT_TYPE
Standard DataValue type - TWGFloat

See Also:
Constant Field Values

FLOAT_ARRAY_TYPE

public static final int FLOAT_ARRAY_TYPE
Standard DataValue type - TWGFloatArray

See Also:
Constant Field Values

NLSSTRING_TYPE

public static final int NLSSTRING_TYPE
Standard DataValue type - TWGNLSString

See Also:
Constant Field Values

LOCALESPECSTRING_TYPE

public static final int LOCALESPECSTRING_TYPE
Standard DataValue type - TWGLocaleSpecificString (as of V2.11)

See Also:
Constant Field Values

FORMATTED_STRING_TYPE

public static final int FORMATTED_STRING_TYPE
Standard DataValue type - TWGFormattedString (as of V2.11)

See Also:
Constant Field Values

NONE_TYPE

public static final int NONE_TYPE
Standard DataValue type - none

See Also:
Constant Field Values
Method Detail

writeDataValue

public int writeDataValue(byte[] buf,
                          int start)
Write value into byte array : used for sending data value

Parameters:
buf - - buffer to write data into
start - - starting index for data write in 'buf'
Returns:
index of byte after last byte writted to 'buf'

writeDataValueLength

public int writeDataValueLength()
Get length needed to write value into byte array : used for sending data value

Returns:
bytes needed

readDataValue

public int readDataValue(byte[] buf,
                         int start)
Read value from byte array into object

Parameters:
buf - - buffer to read from
start - - index of start of data to be read
Returns:
index of byte after last byte read

getDataValueType

public int getDataValueType()
Get DataValue type

Returns:
type code for DataValue subclass

toNLSString

public java.lang.String toNLSString(java.util.Locale loc)
Get NLS-specific string representation

Parameters:
loc - - locale