sparksee.Value Class Reference

Value class. More...

List of all members.

Public Member Functions

def set_oid
 Sets the Value.
def set_long_void
 Sets the Value.
def get_oid
 Gets OID Value.
def set_boolean_void
 Sets the Value.
def compare
 Compares with the given Value.
def set_double_void
 Sets the Value.
def get_boolean
 Gets Boolean Value.
def set_timestamp_void
 Sets the Value.
def set_null_void
 Sets the Value to NULL.
def __init__
 Copy constructor.
def __init__
 Creates a new instance.
def set_oid_void
 Sets the OID Value.
def get_data_type
 Gets the DataType.
def get_string
 Gets String Value.
def set_string
 Sets the Value.
def is_null
 Gets if this is a NULL Value.
def set_double
 Sets the Value.
def set_timestamp_void
 Sets the Value.
def equals
 Compares with the given Value.
def get_double
 Gets Double Value.
def set_integer_void
 Sets the Value.
def set_void
 Sets the Value.
def set_boolean
 Sets the Value.
def set_timestamp
 Sets the Value.
def set_integer
 Sets the Value.
def set_long
 Sets the Value.
def set_string_void
 Sets the Value.
def get_long
 Gets Long Value.
def get_timestamp
 Gets Timestamp Value.
def set_null
 Sets the Value to NULL.
def get_integer
 Gets Integer Value.
def set_timestamp
 Sets the Value.
def operator
 Assignment operator.

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

Member Function Documentation

def sparksee.Value.set_oid (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New OID Value.
Returns:
The calling instance.

def sparksee.Value.set_long_void (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New 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.set_boolean_void (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New Boolean value.

def sparksee.Value.compare (   self,
  v 
)

Compares with the given Value.

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

Parameters:
v 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.set_double_void (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New Double value.

def sparksee.Value.get_boolean (   self  ) 

Gets Boolean Value.

This must be a non-NULL Boolean Value.

Returns:
The Boolean Value.

def sparksee.Value.set_timestamp_void (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New Timestamp value.

def sparksee.Value.__init__ (   self,
  v 
)

Copy constructor.

Parameters:
v [in] Value to be copied.

def sparksee.Value.__init__ (   self  ) 

Creates a new instance.

It creates a NULL Value.

def sparksee.Value.set_oid_void (   self,
  v 
)

Sets the OID Value.

Parameters:
v [in] New OID value.

def sparksee.Value.get_data_type (   self  ) 

Gets the DataType.

Value cannot be NULL.

Returns:
The DataType.

def sparksee.Value.get_string (   self  ) 

Gets String Value.

This must be a non-NULL String Value.

Returns:
The String Value.

def sparksee.Value.set_string (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New String value.
Returns:
The calling instance.

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.set_double (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New Double value.
Returns:
The calling instance.

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

def sparksee.Value.equals (   self,
  v 
)

Compares with the given Value.

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

Parameters:
v Given value to compare to.
Returns:
TRUE if this Value is equal to the given one; FALSE otherwise.

def sparksee.Value.get_double (   self  ) 

Gets Double Value.

This must be a non-NULL Double Value.

Returns:
The Double Value.

def sparksee.Value.set_integer_void (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New Integer value.

def sparksee.Value.set_void (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New value.

def sparksee.Value.set_boolean (   self,
  v 
)

Sets the Value.

Parameters:
v [in] Nex Boolean value.
Returns:
The calling instance.

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.

def sparksee.Value.set_integer (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New Integer value.
Returns:
The calling instance.

def sparksee.Value.set_long (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New Long value.
Returns:
The calling instance.

def sparksee.Value.set_string_void (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New String 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_timestamp (   self  ) 

Gets Timestamp Value.

This must be a non-NULL Timestamp Value.

Returns:
The Timestamp Value.

def sparksee.Value.set_null (   self  ) 

Sets the Value to NULL.

Returns:
The calling instance.

def sparksee.Value.get_integer (   self  ) 

Gets Integer Value.

This must be a non-NULL Integer Value.

Returns:
The Integer Value.

def sparksee.Value.set_timestamp (   self,
  v 
)

Sets the Value.

Parameters:
v [in] New Timestamp value.
Returns:
The calling instance.

def sparksee.Value.operator (   self,
  v 
)

Assignment operator.

Parameters:
v [in] Value to be copied.


Generated on Fri Feb 7 13:22:14 2014 for SparkseePython by  doxygen 1.5.6