fr.gael.drb.value
Class ByteArray

java.lang.Object
  fr.gael.drb.value.AbstractValueArray
      fr.gael.drb.value.AbstractNumericArray
          fr.gael.drb.value.ByteArray

All Implemented Interfaces:

DrbItem, DrbSequence, Comparison, NumericArray, Value, ValueArray, ValueFormat, Serializable

public class ByteArray
extends AbstractNumericArray
implements ValueFormat

The ByteArray class is a generic wrapper for byte array values.

See Also:

Serialized Form

Field Summary

Fields inherited from interface fr.gael.drb.value.Value

ARRAY_ID, BINARY_ID, BINARY_INTEGER_ID, BOOLEAN_ID, BYTE_ID, DATE_ID, DATE_TIME_ID, DAY_ID, DAY_TIME_DURATION_ID, DECIMAL_ID, DOUBLE_ID, DURATION_ID, FLOAT_ID, INT_ID, INTEGER_ID, LONG_ID, MONTH_DAY_ID, MONTH_ID, NULL_ID, NUMERIC_ID, OTHER_ID, SHORT_ID, STRING_ID, TIME_ID, UNKNOWN_ID, UNSIGNED_BYTE_ID, UNSIGNED_INT_ID, UNSIGNED_LONG_ID, UNSIGNED_SHORT_ID, YEAR_ID, YEAR_MONTH_DURATION_ID, YEAR_MONTH_ID

Fields inherited from interface fr.gael.drb.DrbItem

ATTRIBUTE_ITEM, NODE_ITEM, UNDEFINED_ITEM, VALUE_ITEM

Constructor Summary

ByteArray(byte[] src)
Build an ByteArray value.

ByteArray(int size)
Build an ByteArray value.

Method Summary

void	assign(int index, boolean value) Assign a boolean value.
void	assign(int index, byte value) Assign a byte value.
void	assign(int index, double value) Assign a double value.
void	assign(int index, float value) Assign a float value.
void	assign(int index, int value) Assign an int value.
void	assign(int index, long value) Assign a long value.
void	assign(int index, short value) Assign short value.
void	assign(int index, Value element) Replace the element at the specified position in the array with the specified element.
void	assign(Value v) Assign a value.
boolean	booleanValue(int index) Returns this value as a boolean.
byte	byteValue(int index) Returns this value as a byte (signed 8 bits).
byte[]	byteValues() Returns this value as a byte (signed 8 bits).
Value	convertTo(int type) Convert the value into the specified type.
double	doubleValue(int index) Returns this value as a double (signed 64 bits IEEE 754).
float	floatValue(int index) Returns this value as a float (signed 32 bits IEEE 754).
int	getArrayType() The type of the values embedded in the array.
byte[]	getData() Returns the underlying object for optimization.
Value	getElement(int index) The value of the element located at the specified index.
byte[]	getFormattedBuffer() Return a byte buffer containing the value in a fixed format.
String	getFormattedString(int length) Return a string containing the value with a fixed format.
int	getItemType() A code that identifies the value items.
String	getName() Name of the item.
String	getNamespaceURI() Get namespace URI.
int	getPriority() Returns the ByteArray priority
int	getType() The type identifier of this BooleanArray value.
Value	getValue() The value of the item.
int	intValue(int index) Returns this value as an integer (signed 32 bits).
int	length() Returns the number of elements in this array.
long	longValue(int index) Returns this value as a long integer (signed 64 bits).
void	rename(String name) Changes the name of the item.
void	setNamespaceURI(String namespace_uri) Sets a namespace resource identifier.
Value	setValue(Value value) Changes the value of the item.
short	shortValue(int index) Returns this value as a short integer (signed 16 bits).
Numeric	toNumeric() Convert the value into the numeric type.
String	toString() Returns a new String object representing this ByteArray.

Methods inherited from class fr.gael.drb.value.AbstractNumericArray

booleanValues, convertArrayTo, doubleValues, floatValues, intValues, longValues, shortValues

Methods inherited from class fr.gael.drb.value.AbstractValueArray

addItem, atomize, compareTo, getItem, getLength, main, removeItem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface fr.gael.drb.DrbItem

getItemType, getName, getNamespaceURI, getValue, rename, setNamespaceURI, setValue

Methods inherited from interface fr.gael.drb.DrbSequence

addItem, atomize, getItem, getLength, removeItem

Methods inherited from interface fr.gael.drb.value.Comparison

compareTo

Constructor Detail

ByteArray

public ByteArray(byte[] src)

Build an ByteArray value.

Parameters:

src - the byte array source

ByteArray

public ByteArray(int size)

Build an ByteArray value.

Parameters:

size - the array size

Method Detail

getData

public final byte[] getData()

Returns the underlying object for optimization.

Specified by:

getData in class AbstractNumericArray

Returns:

a backing array.

byteValues

public byte[] byteValues()

Returns this value as a byte (signed 8 bits). The conversion may result in a loss of precision.

Overrides:

byteValues in class AbstractNumericArray

Returns:

the numeric value represented by this object after conversion to type byte.

getFormattedString

public String getFormattedString(int length)

Return a string containing the value with a fixed format.

Specified by:

getFormattedString in interface ValueFormat

Overrides:

getFormattedString in class AbstractNumericArray

Parameters:

length - The expected length of the output string

Returns:

The formatted string.

getFormattedBuffer

public byte[] getFormattedBuffer()

Return a byte buffer containing the value in a fixed format. This implementation is optimized to return directly the array because it contains already the bytes.

Specified by:

getFormattedBuffer in interface ValueFormat

Overrides:

getFormattedBuffer in class AbstractNumericArray

Returns:

The buffer which is the byte array of the value.

getType

public final int getType()

The type identifier of this BooleanArray value.

Specified by:

getType in interface Value

Returns:

an identifier of the array type, namely ARRAY_ID

getPriority

public final int getPriority()

Returns the ByteArray priority

Specified by:

getPriority in interface Value

Returns:

the ByteArray priority

convertTo

public final Value convertTo(int type)
                      throws ClassCastException

Convert the value into the specified type. The type must be ARRAY_ID or STRING_ID otherwise a ClassCastException is thrown.

Specified by:

convertTo in interface Value

Overrides:

convertTo in class AbstractValueArray

Parameters:

type - The target type.

Returns:

The converted value.

Throws:

ClassCastException - if the conversion is impossible.

assign

public final void assign(Value v)
                  throws ClassCastException

Assign a value.

Specified by:

assign in interface Value

Parameters:

v - the value to be assigned.

Throws:

ClassCastException - if the value is not an instance of NumericArray

getArrayType

public final int getArrayType()

The type of the values embedded in the array.

Specified by:

getArrayType in interface ValueArray

Overrides:

getArrayType in class AbstractNumericArray

Returns:

an identifier of the element type.

getElement

public final Value getElement(int index)

The value of the element located at the specified index.

Specified by:

getElement in interface ValueArray

Parameters:

index - position where to retrieve the value.

Returns:

The element located at the index.

assign

public final void assign(int index,
                         Value element)

Replace the element at the specified position in the array with the specified element.

Specified by:

assign in interface ValueArray

Parameters:

index - index of element to replace.

element - element to be stored at the specified position.

length

public final int length()

Returns the number of elements in this array.

Specified by:

length in interface ValueArray

Returns:

the number of elements in this array.

booleanValue

public final boolean booleanValue(int index)

Returns this value as a boolean.

Specified by:

booleanValue in interface NumericArray

Overrides:

booleanValue in class AbstractNumericArray

Parameters:

index - position where to retrieve the value.

Returns:

the numeric value represented by this object after conversion to type byte.

byteValue

public final byte byteValue(int index)

Returns this value as a byte (signed 8 bits).

Specified by:

byteValue in interface NumericArray

Overrides:

byteValue in class AbstractNumericArray

Parameters:

index - position where to retrieve the value.

Returns:

the numeric value represented by this object after conversion to type byte.

intValue

public final int intValue(int index)

Returns this value as an integer (signed 32 bits).

Specified by:

intValue in interface NumericArray

Overrides:

intValue in class AbstractNumericArray

Parameters:

index - position where to retrieve the value.

Returns:

the numeric value represented by this object after conversion to type int.

longValue

public final long longValue(int index)

Returns this value as a long integer (signed 64 bits). The conversion may result in a loss of precision.

Specified by:

longValue in interface NumericArray

Overrides:

longValue in class AbstractNumericArray

Parameters:

index - position where to retrieve the value.

Returns:

the numeric value represented by this object after conversion to type long.

shortValue

public final short shortValue(int index)

Returns this value as a short integer (signed 16 bits).

Specified by:

shortValue in interface NumericArray

Overrides:

shortValue in class AbstractNumericArray

Parameters:

index - position where to retrieve the value.

Returns:

the numeric value represented by this object after conversion to type short.

floatValue

public final float floatValue(int index)

Returns this value as a float (signed 32 bits IEEE 754). The conversion may result in a loss of precision.

Specified by:

floatValue in interface NumericArray

Overrides:

floatValue in class AbstractNumericArray

Parameters:

index - position where to retrieve the value.

Returns:

the numeric value represented by this object after conversion to type float.

doubleValue

public final double doubleValue(int index)

Returns this value as a double (signed 64 bits IEEE 754). The conversion may result in a loss of precision.

Specified by:

doubleValue in interface NumericArray

Overrides:

doubleValue in class AbstractNumericArray

Parameters:

index - position where to retrieve the value.

Returns:

the numeric value represented by this object after conversion to type double.

assign

public final void assign(int index,
                         boolean value)

Assign a boolean value.

Specified by:

assign in interface NumericArray

Overrides:

assign in class AbstractNumericArray

Parameters:

index - index of element to replace.

value - another value.

assign

public final void assign(int index,
                         byte value)

Assign a byte value.

Specified by:

assign in interface NumericArray

Overrides:

assign in class AbstractNumericArray

Parameters:

index - index of element to replace.

value - another value. The conversion may result in a loss of precision.

assign

public final void assign(int index,
                         int value)

Assign an int value.

Specified by:

assign in interface NumericArray

Overrides:

assign in class AbstractNumericArray

Parameters:

index - index of element to replace.

value - another value. The conversion may result in a loss of precision.

assign

public final void assign(int index,
                         short value)

Assign short value.

Specified by:

assign in interface NumericArray

Overrides:

assign in class AbstractNumericArray

Parameters:

index - index of element to replace.

value - another value. The conversion may result in a loss of precision.

assign

public final void assign(int index,
                         long value)

Assign a long value.

Specified by:

assign in interface NumericArray

Overrides:

assign in class AbstractNumericArray

Parameters:

index - index of element to replace.

value - another value. The conversion may result in a loss of precision.

assign

public final void assign(int index,
                         float value)

Assign a float value.

Specified by:

assign in interface NumericArray

Overrides:

assign in class AbstractNumericArray

Parameters:

index - index of element to replace.

value - another value. The conversion may result in a loss of precision.

assign

public final void assign(int index,
                         double value)

Assign a double value.

Specified by:

assign in interface NumericArray

Overrides:

assign in class AbstractNumericArray

Parameters:

index - index of element to replace.

value - another value. The conversion may result in a loss of precision.

toString

public String toString()

Returns a new String object representing this ByteArray.

Overrides:

toString in class Object

Returns:

a string representation of the object.

getItemType

public int getItemType()

A code that identifies the value items.

Specified by:

getItemType in interface DrbItem

Returns:

The code of value items.

getName

public String getName()

Name of the item. This method always returns null.

Specified by:

getName in interface DrbItem

Returns:

null

rename

public void rename(String name)
            throws NullPointerException,
                   UnsupportedOperationException

Changes the name of the item. This method always throw an UnsupportedOperationException.

Specified by:

rename in interface DrbItem

Parameters:

name - Reference to the new name.

Throws:

UnsupportedOperationException - This exception always raised because the name property is not defined for values.

NullPointerException - This exception is overriden by an UnsupportedOperationException.

getNamespaceURI

public String getNamespaceURI()

Get namespace URI. This method always returns null.

Specified by:

getNamespaceURI in interface DrbItem

Returns:

null.

setNamespaceURI

public void setNamespaceURI(String namespace_uri)
                     throws NullPointerException,
                            UnsupportedOperationException

Sets a namespace resource identifier. This method always throw an UnsupportedOperationException.

Specified by:

setNamespaceURI in interface DrbItem

Parameters:

namespace_uri - A reference to the new namespace identifier.

Throws:

UnsupportedOperationException - This exception always raised because the name property is not defined for values.

NullPointerException - This exception is overriden by an UnsupportedOperationException.

getValue

public Value getValue()

The value of the item. The value is expressed according to one of the types supported by the fr.gael.drb.value package. Generally these types correspond to primitive types (e.g. integer, floatting points, etc.) or very low level types (e.g. string, date, etc.). On the contrary to DOM implementation all the types are allowed even the arrays, date etc. Only the Value.NULL_ID type is forbidden.

Specified by:

getValue in interface DrbItem

Returns:

The value of the attribute.

setValue

public Value setValue(Value value)
               throws NullPointerException,
                      ClassCastException,
                      UnsupportedOperationException

Changes the value of the item. This operation sets a new value of the current item.The value type of the item shall be compatible with the item implementation. If the type does not match exactly it is casted to a compatible one based on the the fr.gael.drb.value capabilities. A reference to the effectivelly assigned value is returned by the operation so it is possible to check if a cast has been performed and therefore assess the accuracy of the assignement. If the cast is not possible the operation raises an UnsupportedOperationException. If the assignment is possible and the item implementation has a physical representation the value is updated in the physical source in order to persist among sessions. It therefore possible that this operation consumses an variable time.

Specified by:

setValue in interface DrbItem

Parameters:

value - The new value of the node. This value shall not be null.

Returns:

The effectivelly assigned value. The type of this value may differ from the input one.

Throws:

NullPointerException - This exception is raised when the passed reference to the value is null. This exception may be overriden by an UnsupportedOperationException.

ClassCastException - This exception is raised when the implementation has not succeeded to cast the input value in a type compatible with the current node.

UnsupportedOperationException - This exception is raised when the implementation does not support the requested assignment for any reason.

toNumeric

public Numeric toNumeric()
                  throws ClassCastException

Convert the value into the numeric type. In case of identity conversion the value itself should be returned. If the conversion is not allowed a ClassCastException is thrown.

Returns:

The converted value.

Throws:

ClassCastException - is the convertion is impossible