sparksee.Value Class Reference

Value class. More...

Public Member Functions
def	set_null (self)
	Sets the Value to NULL. More...
def	get_timestamp (self)
	Gets Timestamp Value. More...
def	get_long (self)
	Gets Long Value. More...
def	operator (self, value)
	Assignment operator. More...
def	set_oid (self, value)
	Sets the Value. More...
def	set_double_void (self, value)
	Sets the Value. More...
def	set_boolean (self, value)
	Sets the Value. More...
def	__init__ (self)
	Creates a new instance. More...
def	get_integer (self)
	Gets Integer Value. More...
def	set_timestamp_void (self, year, month, day, hour, minutes, seconds, millisecs)
	Sets the Value. More...
def	equals (self, value)
	Compares with the given Value. More...
def	set_boolean_void (self, value)
	Sets the Value. More...
def	set_oid_void (self, value)
	Sets the OID Value. More...
def	set_long_void (self, value)
	Sets the Value. More...
def	set_string (self, value)
	Sets the Value. More...
def	compare (self, value)
	Compares with the given Value. More...
def	get_oid (self)
	Gets OID Value. More...
def	get_boolean (self)
	Gets Boolean Value. More...
def	set_timestamp (self, value)
	Sets the Value. More...
def	get_data_type (self)
	Gets the DataType. More...
def	set_long (self, value)
	Sets the Value. More...
def	set_integer (self, value)
	Sets the Value. More...
def	set_double (self, value)
	Sets the Value. More...
def	get_double (self)
	Gets Double Value. More...
def	__init__ (self, value)
	Copy constructor. More...
def	set_timestamp (self, year, month, day, hour, minutes, seconds, millisecs)
	Sets the Value. More...
def	set_string_void (self, value)
	Sets the Value. More...
def	set_void (self, value)
	Sets the Value. More...
def	set_timestamp_void (self, value)
	Sets the Value. More...
def	set_integer_void (self, value)
	Sets the Value. More...
def	is_null (self)
	Gets if this is a NULL Value. More...
def	get_string (self)
	Gets String Value. More...
def	set_null_void (self)
	Sets the Value to NULL.
def	to_string (self)
	Returns a String representation of the Value, used in unicode and str More...

Static Public Attributes
int	MAX_LENGTH_STRING = 2047
	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

def sparksee.Value.__init__

(

self

)

Creates a new instance.

It creates a NULL Value.

Referenced by sparksee.Value.__init__().

def sparksee.Value.__init__	(		self,
			value
	)

Copy constructor.

Parameters

value

[in] Value to be copied.

References sparksee.Value.__init__().

Member Function Documentation

def sparksee.Value.compare	(		self,
			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.

def sparksee.Value.equals	(		self,
			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.

def sparksee.Value.get_boolean

(

self

)

Gets Boolean Value.

This must be a non-NULL Boolean Value.

Returns

The Boolean Value.

def sparksee.Value.get_data_type

(

self

)

Gets the DataType.

Value cannot be NULL.

Returns

The DataType.

def sparksee.Value.get_double

(

self

)

Gets Double Value.

This must be a non-NULL Double Value.

Returns

The Double Value.

def sparksee.Value.get_integer

(

self

)

Gets Integer Value.

This must be a non-NULL Integer Value.

Returns

The Integer Value.

def sparksee.Value.get_long

(

self

)

Gets Long Value.

This must be a non-NULL Long Value.

Returns

The Long Value.

def sparksee.Value.get_oid

(

self

)

Gets OID Value.

This must be an non-NULL OID Value.

Returns

The OID Value.

def sparksee.Value.get_string

(

self

)

Gets String Value.

This must be a non-NULL String Value.

Returns

The String Value.

def sparksee.Value.get_timestamp

(

self

)

Gets Timestamp Value.

This must be a non-NULL Timestamp Value.

Returns

The Timestamp Value.

def sparksee.Value.is_null

(

self

)

Gets if this is a NULL Value.

Returns

TRUE if this is a NULL Value, FALSE otherwise.

def sparksee.Value.operator	(		self,
			value
	)

Assignment operator.

Parameters

value

[in] Value to be copied.

Returns

Returns the Value reference.

def sparksee.Value.set_boolean	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] Nex Boolean value.

Returns

The calling instance.

def sparksee.Value.set_boolean_void	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New Boolean value.

def sparksee.Value.set_double	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New Double value.

Returns

The calling instance.

def sparksee.Value.set_double_void	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New Double value.

def sparksee.Value.set_integer	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New Integer value.

Returns

The calling instance.

def sparksee.Value.set_integer_void	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New Integer value.

def sparksee.Value.set_long	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New Long value.

Returns

The calling instance.

def sparksee.Value.set_long_void	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New Long value.

def sparksee.Value.set_null

(

self

)

Sets the Value to NULL.

Returns

The calling instance.

def sparksee.Value.set_oid	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New OID Value.

Returns

The calling instance.

def sparksee.Value.set_oid_void	(		self,
			value
	)

Sets the OID Value.

Parameters

value

[in] New OID value.

def sparksee.Value.set_string	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New String value.

Returns

The calling instance.

def sparksee.Value.set_string_void	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New String value.

def sparksee.Value.set_timestamp	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New Timestamp value.

Returns

The calling instance.

Referenced by sparksee.Value.set_timestamp().

def sparksee.Value.set_timestamp	(		self,
			year,
			month,
			day,
			hour,
			minutes,
			seconds,
			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]).

Returns

The calling instance.

References sparksee.Value.set_timestamp().

def sparksee.Value.set_timestamp_void	(		self,
			year,
			month,
			day,
			hour,
			minutes,
			seconds,
			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]).

Referenced by sparksee.Value.set_timestamp_void().

def sparksee.Value.set_timestamp_void	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New Timestamp value.

References sparksee.Value.set_timestamp_void().

def sparksee.Value.set_void	(		self,
			value
	)

Sets the Value.

Parameters

value

[in] New value.

def sparksee.Value.to_string

(

self

)

Returns a String representation of the Value, used in unicode and str