sparksee.Value Class Reference

Value class. More...

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

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

__init__() [1/2]

sparksee.Value.__init__

(

self

)

Creates a new instance.

It creates a NULL Value.

__init__() [2/2]

sparksee.Value.__init__	(		self,
			value )

Copy constructor.

Parameters

value

[in] Value to be copied.

Member Function Documentation

compare()

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.

equals()

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.

get_boolean()

sparksee.Value.get_boolean

(

self

)

Gets Boolean Value.

This must be a non-NULL Boolean Value.

Returns

The Boolean Value.

get_data_type()

sparksee.Value.get_data_type

(

self

)

Gets the DataType.

Value cannot be NULL.

Returns

The DataType.

get_double()

sparksee.Value.get_double

(

self

)

Gets Double Value.

This must be a non-NULL Double Value.

Returns

The Double Value.

get_integer()

sparksee.Value.get_integer

(

self

)

Gets Integer Value.

This must be a non-NULL Integer Value.

Returns

The Integer Value.

get_long()

sparksee.Value.get_long

(

self

)

Gets Long Value.

This must be a non-NULL Long Value.

Returns

The Long Value.

get_oid()

sparksee.Value.get_oid

(

self

)

Gets OID Value.

This must be an non-NULL OID Value.

Returns

The OID Value.

get_string()

sparksee.Value.get_string

(

self

)

Gets String Value.

This must be a non-NULL String Value.

Returns

The String Value.

get_timestamp()

sparksee.Value.get_timestamp

(

self

)

Gets Timestamp Value.

This must be a non-NULL Timestamp Value.

Returns

The Timestamp Value.

is_null()

sparksee.Value.is_null

(

self

)

Gets if this is a NULL Value.

Returns

TRUE if this is a NULL Value, FALSE otherwise.

operator()

sparksee.Value.operator	(		self,
			value )

Assignment operator.

Parameters

value

[in] Value to be copied.

Returns

Returns the Value reference.

set_boolean()

sparksee.Value.set_boolean	(		self,
			value )

Sets the Value.

Parameters

value

[in] Nex Boolean value.

Returns

The calling instance.

set_boolean_void()

sparksee.Value.set_boolean_void	(		self,
			value )

Sets the Value.

Parameters

value

[in] New Boolean value.

set_double()

sparksee.Value.set_double	(		self,
			value )

Sets the Value.

Parameters

value

[in] New Double value.

Returns

The calling instance.

set_double_void()

sparksee.Value.set_double_void	(		self,
			value )

Sets the Value.

Parameters

value

[in] New Double value.

set_integer()

sparksee.Value.set_integer	(		self,
			value )

Sets the Value.

Parameters

value

[in] New Integer value.

Returns

The calling instance.

set_integer_void()

sparksee.Value.set_integer_void	(		self,
			value )

Sets the Value.

Parameters

value

[in] New Integer value.

set_long()

sparksee.Value.set_long	(		self,
			value )

Sets the Value.

Parameters

value

[in] New Long value.

Returns

The calling instance.

set_long_void()

sparksee.Value.set_long_void	(		self,
			value )

Sets the Value.

Parameters

value

[in] New Long value.

set_null()

sparksee.Value.set_null

(

self

)

Sets the Value to NULL.

Returns

The calling instance.

set_oid()

sparksee.Value.set_oid	(		self,
			value )

Sets the Value.

Parameters

value

[in] New OID Value.

Returns

The calling instance.

set_oid_void()

sparksee.Value.set_oid_void	(		self,
			value )

Sets the OID Value.

Parameters

value

[in] New OID value.

set_string()

sparksee.Value.set_string	(		self,
			value )

Sets the Value.

Parameters

value

[in] New String value.

Returns

The calling instance.

set_string_void()

sparksee.Value.set_string_void	(		self,
			value )

Sets the Value.

Parameters

value

[in] New String value.

set_timestamp() [1/2]

sparksee.Value.set_timestamp	(		self,
			value )

Sets the Value.

Parameters

value

[in] New Timestamp value.

Returns

The calling instance.

set_timestamp() [2/2]

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.

set_timestamp_void() [1/2]

sparksee.Value.set_timestamp_void	(		self,
			value )

Sets the Value.

Parameters

value

[in] New Timestamp value.

set_timestamp_void() [2/2]

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

set_void()

sparksee.Value.set_void	(		self,
			value )

Sets the Value.

Parameters

value

[in] New value.