SparkseeNet  5.1.0
Public Member Functions | Static Public Attributes | List of all members
com.sparsity.sparksee.gdb.Value Class Reference

Value class. More...

Public Member Functions

void SetLongVoid (long value)
 Sets the Value. More...
 
System.DateTime GetTimestampAsDateTime ()
 Gets the Value as a DateTime instance. More...
 
long GetOID ()
 Gets OID Value. More...
 
com.sparsity.sparksee.gdb.Value SetBoolean (bool value)
 Sets the Value. More...
 
 Value (com.sparsity.sparksee.gdb.Value value)
 Copy constructor. More...
 
bool GetBoolean ()
 Gets Boolean Value. More...
 
int CompareTo (com.sparsity.sparksee.gdb.Value other)
 Compares the current instance with another object of the same type. More...
 
void SetNullVoid ()
 Sets the Value to NULL.
 
void SetTimestampVoid (long value)
 Sets the Value. More...
 
void SetStringVoid (System.String value)
 Sets the Value. More...
 
 Value ()
 Creates a new instance. More...
 
void SetIntegerVoid (int value)
 Sets the Value. More...
 
string ToString ()
 Gets a string representation of the Value.
 
com.sparsity.sparksee.gdb.Value SetDouble (double value)
 Sets the Value. More...
 
com.sparsity.sparksee.gdb.Value Set (com.sparsity.sparksee.gdb.Value value)
 Sets the Value. More...
 
com.sparsity.sparksee.gdb.DataType GetDataType ()
 Gets the DataType. More...
 
com.sparsity.sparksee.gdb.Value SetOID (long value)
 Sets the Value. More...
 
System.String GetString ()
 Gets String Value. More...
 
void SetDoubleVoid (double value)
 Sets the Value. More...
 
bool Equals (com.sparsity.sparksee.gdb.Value value)
 Compares with the given Value. More...
 
bool IsNull ()
 Gets if this is a NULL Value. More...
 
void SetVoid (com.sparsity.sparksee.gdb.Value value)
 Sets the Value. More...
 
void SetTimestampVoid (int year, int month, int day, int hour, int minutes, int seconds, int millisecs)
 Sets the Value. More...
 
void SetOIDVoid (long value)
 Sets the OID Value. More...
 
com.sparsity.sparksee.gdb.Value SetString (string value)
 Sets the Value. More...
 
double GetDouble ()
 Gets Double Value. More...
 
com.sparsity.sparksee.gdb.Value SetLong (long value)
 Sets the Value. More...
 
com.sparsity.sparksee.gdb.Value SetTimestamp (System.DateTime dt)
 Sets the Value. More...
 
int Compare (com.sparsity.sparksee.gdb.Value value)
 Compares with the given Value. More...
 
long GetLong ()
 Gets Long Value. More...
 
void SetBooleanVoid (bool value)
 Sets the Value. More...
 
com.sparsity.sparksee.gdb.Value SetInteger (int value)
 Sets the Value. More...
 
int CompareTo (System.Object other)
 Compares the current instance with another object of the same type. More...
 
com.sparsity.sparksee.gdb.Value SetNull ()
 Sets the Value to NULL. More...
 
long GetTimestamp ()
 Gets Timestamp Value. More...
 
com.sparsity.sparksee.gdb.Value SetTimestamp (int year, int month, int day, int hour, int minutes, int seconds, int millisec)
 Sets the Value. More...
 
bool Equals (System.Object other)
 Indicates whether the current object is equal to another object. More...
 
int GetInteger ()
 Gets Integer Value. More...
 

Static Public Attributes

static int MaxLengthString
 Maximum number of characters allowed for a String.
 

Detailed Description

Value class.

It is a container which stores a value and its data type (domain). A Value can be NULL.

Author
Sparsity Technologies http://www.sparsity-technologies.com

Constructor & Destructor Documentation

com.sparsity.sparksee.gdb.Value.Value ( com.sparsity.sparksee.gdb.Value  value)

Copy constructor.

Parameters
value[in] Value to be copied.
com.sparsity.sparksee.gdb.Value.Value ( )

Creates a new instance.

It creates a NULL Value.

Member Function Documentation

int com.sparsity.sparksee.gdb.Value.Compare ( com.sparsity.sparksee.gdb.Value  value)

Compares with the given Value.

It does not work if the given Value objects does not have the same DataType.

Parameters
valueGiven value to compare to.
Returns
0 if this Value is equal to the given one; a value less than 0 if this Value is less than the given one; and a value greater than 0 if this Value is greater than the given one.
int com.sparsity.sparksee.gdb.Value.CompareTo ( com.sparsity.sparksee.gdb.Value  other)

Compares the current instance with another object of the same type.

Parameters
otherAnother Value to compare with this instance.
Returns
Less than zero, if the instance is less than other; Zero, if the instance is equal to other; and greater than zero if the instance is greater than other.
int com.sparsity.sparksee.gdb.Value.CompareTo ( System.Object  other)

Compares the current instance with another object of the same type.

Parameters
otherAn object to compare with this instance.
Returns
Less than zero, if the instance is less than other; Zero, if the instance is equal to other; and greater than zero if the instance is greater than other.
bool com.sparsity.sparksee.gdb.Value.Equals ( com.sparsity.sparksee.gdb.Value  value)

Compares with the given Value.

It does not work if the given Value objects does not have the same DataType.

Parameters
valueGiven value to compare to.
Returns
TRUE if this Value is equal to the given one; FALSE otherwise.
bool com.sparsity.sparksee.gdb.Value.Equals ( System.Object  other)

Indicates whether the current object is equal to another object.

Parameters
otherAn object to compare with this instance.
Returns
TRUE if the current object is equal to the other; otherwise, FALSE.
bool com.sparsity.sparksee.gdb.Value.GetBoolean ( )

Gets Boolean Value.

This must be a non-NULL Boolean Value.

Returns
The Boolean Value.
com.sparsity.sparksee.gdb.DataType com.sparsity.sparksee.gdb.Value.GetDataType ( )

Gets the DataType.

Value cannot be NULL.

Returns
The DataType.
double com.sparsity.sparksee.gdb.Value.GetDouble ( )

Gets Double Value.

This must be a non-NULL Double Value.

Returns
The Double Value.
int com.sparsity.sparksee.gdb.Value.GetInteger ( )

Gets Integer Value.

This must be a non-NULL Integer Value.

Returns
The Integer Value.
long com.sparsity.sparksee.gdb.Value.GetLong ( )

Gets Long Value.

This must be a non-NULL Long Value.

Returns
The Long Value.
long com.sparsity.sparksee.gdb.Value.GetOID ( )

Gets OID Value.

This must be an non-NULL OID Value.

Returns
The OID Value.
System.String com.sparsity.sparksee.gdb.Value.GetString ( )

Gets String Value.

This must be a non-NULL String Value.

Returns
The String Value.
long com.sparsity.sparksee.gdb.Value.GetTimestamp ( )

Gets Timestamp Value.

This must be a non-NULL Timestamp Value.

Returns
The Timestamp Value.
System.DateTime com.sparsity.sparksee.gdb.Value.GetTimestampAsDateTime ( )

Gets the Value as a DateTime instance.

Returns
The returning DateTime instance.
bool com.sparsity.sparksee.gdb.Value.IsNull ( )

Gets if this is a NULL Value.

Returns
TRUE if this is a NULL Value, FALSE otherwise.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.Set ( com.sparsity.sparksee.gdb.Value  value)

Sets the Value.

Parameters
valueNew value.
Returns
The calling instance.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.SetBoolean ( bool  value)

Sets the Value.

Parameters
valueNew value.
Returns
The calling instance.
void com.sparsity.sparksee.gdb.Value.SetBooleanVoid ( bool  value)

Sets the Value.

Parameters
value[in] New Boolean value.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.SetDouble ( double  value)

Sets the Value.

Parameters
valueNew value.
Returns
The calling instance.
void com.sparsity.sparksee.gdb.Value.SetDoubleVoid ( double  value)

Sets the Value.

Parameters
value[in] New Double value.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.SetInteger ( int  value)

Sets the Value.

Parameters
valueNew value.
Returns
The calling instance.
void com.sparsity.sparksee.gdb.Value.SetIntegerVoid ( int  value)

Sets the Value.

Parameters
value[in] New Integer value.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.SetLong ( long  value)

Sets the Value.

Parameters
valueNew value.
Returns
The calling instance.
void com.sparsity.sparksee.gdb.Value.SetLongVoid ( long  value)

Sets the Value.

Parameters
value[in] New Long value.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.SetNull ( )

Sets the Value to NULL.

Returns
The calling instance.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.SetOID ( long  value)

Sets the Value.

Parameters
valueNew value.
Returns
The calling instance.
void com.sparsity.sparksee.gdb.Value.SetOIDVoid ( long  value)

Sets the OID Value.

Parameters
value[in] New OID value.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.SetString ( string  value)

Sets the Value.

Parameters
valueNew value.
Returns
The calling instance.
void com.sparsity.sparksee.gdb.Value.SetStringVoid ( System.String  value)

Sets the Value.

Parameters
value[in] New String value.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.SetTimestamp ( System.DateTime  dt)

Sets the Value.

Parameters
dtNew value.
Returns
The calling instance.
com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.SetTimestamp ( int  year,
int  month,
int  day,
int  hour,
int  minutes,
int  seconds,
int  millisec 
)

Sets the Value.

Parameters
yearThe year (>=1970).
monthThe month ([1..12]).
dayThe day of the month ([1..31]).
hourThe hour ([0..23]).
minutesThe minutes ([0..59]).
secondsThe seconds ([0..59]).
millisecThe milliseconds ([0..999]).
Returns
The calling instance.
void com.sparsity.sparksee.gdb.Value.SetTimestampVoid ( long  value)

Sets the Value.

Parameters
value[in] New Timestamp value.
void com.sparsity.sparksee.gdb.Value.SetTimestampVoid ( int  year,
int  month,
int  day,
int  hour,
int  minutes,
int  seconds,
int  millisecs 
)

Sets the Value.

Parameters
year[in] The year (>=1970).
month[in] The month ([1..12]).
day[in] The of the month ([1..31]).
hour[in] The hour ([0..23]).
minutes[in] The minutes ([0..59]).
seconds[in] The seconds ([0..59]).
millisecs[in] The milliseconds ([0..999]).
void com.sparsity.sparksee.gdb.Value.SetVoid ( com.sparsity.sparksee.gdb.Value  value)

Sets the Value.

Parameters
value[in] New value.