fr.gael.drb.value
Class Decimal

java.lang.Object
  fr.gael.drb.value.Decimal

All Implemented Interfaces:

DrbItem, Arithmetic, Comparison, Logic, Numeric, Sumable, Value, Serializable, Comparable

public class Decimal
extends Object

The Decimal class is a generic wrapper for decimal values.

See Also:

Serialized Form

Field Summary

static int	PRIORITY The Decimal priority.
protected BigDecimal	value The Decimal value.

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

protected	Decimal(BigDecimal val) Constructs a Decimal object initialized to the specified decimal value.
	Decimal(double val) Constructs a Decimal object initialized to the specified decimal value.
	Decimal(String val) Constructs a Decimal object initialized to the specified decimal value.

Method Summary

Value	add(Value x) Compute an addition.
boolean	and(Value x) Compute a logical AND.
void	assign(boolean value) Assign a boolean value.
void	assign(byte value) Assign a byte value.
void	assign(double value) Assign a double value.
void	assign(float value) Assign a float value.
void	assign(int value) Assign an int value.
void	assign(long value) Assign a long value.
void	assign(short value) Assign short value.
void	assign(Value v) Assign a new Value.
boolean	booleanValue() Returns this value as a boolean
byte	byteValue() Returns this value as a byte (signed 8 bits).
int	compareTo(Object obj) Compares this object with the specified object for order.
int	compareTo(Value x) Compare this value with another value.
Value	convertTo(int type) Convert the value into the specified type.
protected BigDecimal	decimalValue() Returns this value as a BigDecimal.
Value	divide(Value x) Compute a division.
double	doubleValue() Returns this value as a double (signed 64 bits IEEE 754).
boolean	equals(Object obj) Indicates whether this value is "equal to" to another value.
float	floatValue() Returns this value as a float (signed 32 bits IEEE 754).
int	getItemType() A code that identifies the value items.
String	getName() Name of the item.
String	getNamespaceURI() Get namespace URI.
int	getPriority() Returns the Decimal priority
int	getType() The type identifier of this Decimal value.
Value	getValue() The value of the item.
int	hashCode() Returns a hash code value for the object.
protected BigInteger	integerValue() Returns this value as a BigInteger.
int	intValue() Returns this value as an integer (signed 32 bits).
long	longValue() Returns this value as a long integer (signed 64 bits).
Value	modulus(Value x) Compute a modulus.
Value	multiply(Value x) Compute a multiplication.
boolean	or(Value x) Compute a logical OR.
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() Returns this value as a short integer (signed 16 bits).
Value	sub(Value x) Compute a substraction.
Numeric	toNumeric() Convert the value into the numeric type.
String	toString() Returns a new String object representing this Decimal.
Value	unaryMinus() Compute the unary minus of this value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface fr.gael.drb.DrbItem

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

Field Detail

PRIORITY

public static final int PRIORITY

The Decimal priority.

See Also:

Constant Field Values

value

protected BigDecimal value

The Decimal value.

Constructor Detail

Decimal

public Decimal(String val)

Constructs a Decimal object initialized to the specified decimal value.

Parameters:

val - the value of the Decimal.

Decimal

public Decimal(double val)

Constructs a Decimal object initialized to the specified decimal value.

Parameters:

val - the value of the Decimal.

Decimal

protected Decimal(BigDecimal val)

Constructs a Decimal object initialized to the specified decimal value.

Parameters:

val - the value of the Decimal.

Method Detail

toString

public String toString()

Returns a new String object representing this Decimal.

Overrides:

toString in class Object

Returns:

a string representation of the object.

getType

public int getType()

The type identifier of this Decimal value.

Specified by:

getType in interface Value

Returns:

an identifier of the Decimal type.

getPriority

public final int getPriority()

Returns the Decimal priority

Returns:

the Decimal priority

convertTo

public Value convertTo(int type)
                throws ClassCastException

Convert the value into the specified type. In case of identity conversion the value itself is returned. If the conversion is not allowed a ClassCastException is thrown. The type must be a number (BOOLEAN_ID to DOUBLE_ID) or an array.

Specified by:

convertTo in interface Value

Parameters:

type - The target type.

Returns:

The converted value.

Throws:

ClassCastException - the conversion is impossible

assign

public void assign(Value v)

Assign a new Value. An implicit conversion may be performed to make the assignment. This assignment may result in a loss of precision (ex : float to int).

Parameters:

v - the value to be assigned.

unaryMinus

public Value unaryMinus()

Compute the unary minus of this value.

Returns:

The unary minus of this value.

add

public final Value add(Value x)

Compute an addition.

Parameters:

x - another value.

Returns:

the sum of the two values.

sub

public Value sub(Value x)

Compute a substraction.

Parameters:

x - another value.

Returns:

the difference between the two values.

multiply

public Value multiply(Value x)

Compute a multiplication.

Parameters:

x - another value.

Returns:

the product of the two values.

divide

public final Value divide(Value x)

Compute a division.

Parameters:

x - another value.

Returns:

the ratio of the two values.

modulus

public Value modulus(Value x)

Compute a modulus.

Parameters:

x - another value.

Returns:

the modulus of the values.

compareTo

public int compareTo(Value x)

Compare this value with another value.

Parameters:

x - another value.

Returns:

The returned value is :

• negative if this value is lower than another value
• zero if the two values are equal
• positive if this value is greater than another value

booleanValue

public final boolean booleanValue()

Returns this value as a boolean

Returns:

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

byteValue

public final byte byteValue()

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

Returns:

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

shortValue

public final short shortValue()

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

Returns:

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

intValue

public final int intValue()

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

Returns:

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

longValue

public final long longValue()

Returns this value as a long integer (signed 64 bits).

Returns:

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

floatValue

public final float floatValue()

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

Returns:

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

doubleValue

public final double doubleValue()

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

Returns:

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

integerValue

protected final BigInteger integerValue()

Returns this value as a BigInteger. The conversion may result in a loss of precision.

Returns:

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

decimalValue

protected final BigDecimal decimalValue()

Returns this value as a BigDecimal. The conversion may result in a loss of precision.

Returns:

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

assign

public final void assign(boolean value)

Assign a boolean value.

Parameters:

value - another value.

assign

public final void assign(byte value)

Assign a byte value.

Parameters:

value - another value.

assign

public final void assign(short value)

Assign short value.

Parameters:

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

assign

public final void assign(int value)

Assign an int value.

Parameters:

value - another value.

assign

public final void assign(long value)

Assign a long value.

Parameters:

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

assign

public final void assign(float value)

Assign a float value.

Parameters:

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

assign

public final void assign(double value)

Assign a double value.

Parameters:

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

equals

public boolean equals(Object obj)

Indicates whether this value is "equal to" to another value. See Object.equals() for the general contract of this method.

Overrides:

equals in class Object

Parameters:

obj - another value.

Returns:

true if this object is the same as the obj argument

hashCode

public int hashCode()

Returns a hash code value for the object. See Object.hashCode() for the general contract of this method.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

compareTo

public int compareTo(Object obj)

Compares this object with the specified object for order. See Comparable.compareTo() for the general contract of this method.

Specified by:

compareTo in interface Comparable

Parameters:

obj - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

toNumeric

public final 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

and

public final boolean and(Value x)

Compute a logical AND.

Specified by:

and in interface Logic

Parameters:

x - another value.

Returns:

logical AND of the two values.

or

public final boolean or(Value x)

Compute a logical OR.

Specified by:

or in interface Logic

Parameters:

x - another value.

Returns:

logical OR of the two values.

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.