Value class. More...

Public Member Functions
long	GetTimestamp ()
	Gets Timestamp Value.

com.sparsity.sparksee.gdb.Value	Set (com.sparsity.sparksee.gdb.Value value)
	Sets the Value.

long	GetLong ()
	Gets Long Value.

com.sparsity.sparksee.gdb.Value	SetDouble (double value)
	Sets the Value.

void	SetDoubleVoid (double value)
	Sets the Value.

	Value ()
	Creates a new instance.

int	GetInteger ()
	Gets Integer Value.

com.sparsity.sparksee.gdb.Value	SetOID (long value)
	Sets the Value.

void	SetTimestampVoid (int year, int month, int day, int hour, int minutes, int seconds, int millisecs)
	Sets the Value.

bool	Equals (com.sparsity.sparksee.gdb.Value value)
	Compares with the given Value.

void	SetBooleanVoid (bool value)
	Sets the Value.

void	SetOIDVoid (long value)
	Sets the OID Value.

com.sparsity.sparksee.gdb.Value	SetInteger (int value)
	Sets the Value.

com.sparsity.sparksee.gdb.Value	SetLong (long value)
	Sets the Value.

void	SetLongVoid (long value)
	Sets the Value.

int	CompareTo (com.sparsity.sparksee.gdb.Value other)
	Compares the current instance with another object of the same type.

int	CompareTo (System.Object other)
	Compares the current instance with another object of the same type.

int	Compare (com.sparsity.sparksee.gdb.Value value)
	Compares with the given Value.

long	GetOID ()
	Gets OID Value.

com.sparsity.sparksee.gdb.Value	SetString (string value)
	Sets the Value.

bool	GetBoolean ()
	Gets Boolean Value.

com.sparsity.sparksee.gdb.Value	SetTimestamp (int year, int month, int day, int hour, int minutes, int seconds, int millisec)
	Sets the Value.

com.sparsity.sparksee.gdb.DataType	GetDataType ()
	Gets the DataType.

bool	Equals (System.Object other)
	Indicates whether the current object is equal to another object.

com.sparsity.sparksee.gdb.Value	SetBoolean (bool value)
	Sets the Value.

com.sparsity.sparksee.gdb.Value	SetNull ()
	Sets the Value to NULL.

System.DateTime	GetTimestampAsDateTime ()
	Gets the Value as a DateTime instance.

double	GetDouble ()
	Gets Double Value.

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

void	SetStringVoid (System.String value)
	Sets the Value.

void	SetVoid (com.sparsity.sparksee.gdb.Value value)
	Sets the Value.

void	SetTimestampVoid (long value)
	Sets the Value.

void	SetIntegerVoid (int value)
	Sets the Value.

com.sparsity.sparksee.gdb.Value	SetTimestamp (System.DateTime dt)
	Sets the Value.

string	ToString ()
	Gets a string representation of the Value.

bool	IsNull ()
	Gets if this is a NULL Value.

System.String	GetString ()
	Gets String Value.

void	SetNullVoid ()
	Sets the Value to NULL.

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

◆ Value() [1/2]

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

Creates a new instance.

It creates a NULL Value.

◆ Value() [2/2]

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

Copy constructor.

Parameters

value [in] Value to be copied.

Member Function Documentation

◆ Compare()

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

value Given 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.

◆ CompareTo() [1/2]

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

other Another 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.

◆ CompareTo() [2/2]

int com.sparsity.sparksee.gdb.Value.CompareTo ( System.Object other )

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

Parameters

other An 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.

◆ Equals() [1/2]

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

value Given value to compare to.

Returns: TRUE if this Value is equal to the given one; FALSE otherwise.

◆ Equals() [2/2]

bool com.sparsity.sparksee.gdb.Value.Equals ( System.Object other )

Indicates whether the current object is equal to another object.

Parameters

other An object to compare with this instance.

Returns: TRUE if the current object is equal to the other; otherwise, FALSE.

◆ GetBoolean()

bool com.sparsity.sparksee.gdb.Value.GetBoolean ( )

Gets Boolean Value.

This must be a non-NULL Boolean Value.

Returns: The Boolean Value.

◆ GetDataType()

com.sparsity.sparksee.gdb.DataType com.sparsity.sparksee.gdb.Value.GetDataType ( )

Gets the DataType.

Value cannot be NULL.

Returns: The DataType.

◆ GetDouble()

double com.sparsity.sparksee.gdb.Value.GetDouble ( )

Gets Double Value.

This must be a non-NULL Double Value.

Returns: The Double Value.

◆ GetInteger()

int com.sparsity.sparksee.gdb.Value.GetInteger ( )

Gets Integer Value.

This must be a non-NULL Integer Value.

Returns: The Integer Value.

◆ GetLong()

long com.sparsity.sparksee.gdb.Value.GetLong ( )

Gets Long Value.

This must be a non-NULL Long Value.

Returns: The Long Value.

◆ GetOID()

long com.sparsity.sparksee.gdb.Value.GetOID ( )

Gets OID Value.

This must be an non-NULL OID Value.

Returns: The OID Value.

◆ GetString()

System.String com.sparsity.sparksee.gdb.Value.GetString ( )

Gets String Value.

This must be a non-NULL String Value.

Returns: The String Value.

◆ GetTimestamp()

long com.sparsity.sparksee.gdb.Value.GetTimestamp ( )

Gets Timestamp Value.

This must be a non-NULL Timestamp Value.

Returns: The Timestamp Value.

◆ GetTimestampAsDateTime()

System.DateTime com.sparsity.sparksee.gdb.Value.GetTimestampAsDateTime ( )

Gets the Value as a DateTime instance.

Returns: The returning DateTime instance.

◆ IsNull()

bool com.sparsity.sparksee.gdb.Value.IsNull ( )

Gets if this is a NULL Value.

Returns: TRUE if this is a NULL Value, FALSE otherwise.

◆ Set()

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

Sets the Value.

Parameters

value New value.

Returns: The calling instance.

◆ SetBoolean()

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

Sets the Value.

Parameters

value New value.

Returns: The calling instance.

◆ SetBooleanVoid()

void com.sparsity.sparksee.gdb.Value.SetBooleanVoid ( bool value )

Sets the Value.

Parameters

value [in] New Boolean value.

◆ SetDouble()

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

Sets the Value.

Parameters

value New value.

Returns: The calling instance.

◆ SetDoubleVoid()

void com.sparsity.sparksee.gdb.Value.SetDoubleVoid ( double value )

Sets the Value.

Parameters

value [in] New Double value.

◆ SetInteger()

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

Sets the Value.

Parameters

value New value.

Returns: The calling instance.

◆ SetIntegerVoid()

void com.sparsity.sparksee.gdb.Value.SetIntegerVoid ( int value )

Sets the Value.

Parameters

value [in] New Integer value.

◆ SetLong()

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

Sets the Value.

Parameters

value New value.

Returns: The calling instance.

◆ SetLongVoid()

void com.sparsity.sparksee.gdb.Value.SetLongVoid ( long value )

Sets the Value.

Parameters

value [in] New Long value.

◆ SetNull()

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

Sets the Value to NULL.

Returns: The calling instance.

◆ SetOID()

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

Sets the Value.

Parameters

value New value.

Returns: The calling instance.

◆ SetOIDVoid()

void com.sparsity.sparksee.gdb.Value.SetOIDVoid ( long value )

Sets the OID Value.

Parameters

value [in] New OID value.

◆ SetString()

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

Sets the Value.

Parameters

value New value.

Returns: The calling instance.

◆ SetStringVoid()

void com.sparsity.sparksee.gdb.Value.SetStringVoid ( System.String value )

Sets the Value.

Parameters

value [in] New String value.

◆ SetTimestamp() [1/2]

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

year	The year (>=1970).
month	The month ([1..12]).
day	The day of the month ([1..31]).
hour	The hour ([0..23]).
minutes	The minutes ([0..59]).
seconds	The seconds ([0..59]).
millisec	The milliseconds ([0..999]).

Returns: The calling instance.

◆ SetTimestamp() [2/2]

com.sparsity.sparksee.gdb.Value com.sparsity.sparksee.gdb.Value.SetTimestamp ( System.DateTime dt )

Sets the Value.

Parameters

dt	New value.

Returns: The calling instance.

◆ SetTimestampVoid() [1/2]

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]).

◆ SetTimestampVoid() [2/2]

void com.sparsity.sparksee.gdb.Value.SetTimestampVoid ( long value )

Sets the Value.

Parameters

value [in] New Timestamp value.

◆ SetVoid()

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

Sets the Value.

Parameters

value [in] New value.

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Value() [1/2]

◆ Value() [2/2]

Member Function Documentation

◆ Compare()

◆ CompareTo() [1/2]

◆ CompareTo() [2/2]

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetBoolean()

◆ GetDataType()

◆ GetDouble()

◆ GetInteger()

◆ GetLong()

◆ GetOID()

◆ GetString()

◆ GetTimestamp()

◆ GetTimestampAsDateTime()

◆ IsNull()

◆ Set()

◆ SetBoolean()

◆ SetBooleanVoid()

◆ SetDouble()

◆ SetDoubleVoid()

◆ SetInteger()

◆ SetIntegerVoid()

◆ SetLong()

◆ SetLongVoid()

◆ SetNull()

◆ SetOID()

◆ SetOIDVoid()

◆ SetString()

◆ SetStringVoid()

◆ SetTimestamp() [1/2]

◆ SetTimestamp() [2/2]

◆ SetTimestampVoid() [1/2]

◆ SetTimestampVoid() [2/2]

◆ SetVoid()