SparkseePython  6.0.2
Public Member Functions | List of all members
sparksee.KeyValues Class Reference

Value set class. More...

Public Member Functions

def next (self)
 Gets the next KeyValue pair. More...
 
def next (self, kv)
 Gets the next KeyValue pair. More...
 
def has_next (self)
 Checks if the KeyValues has more KeyValue pairs. More...
 
def close (self)
 Closes the KeyValues instance. More...
 
def __next__ (self)
 Used in next() More...
 
def is_closed (self)
 Gets if KeyValues instance has been closed or not. More...
 

Detailed Description

Value set class.

This is a set of Value instances, that is there is no duplicated elements.

Use a ValuesIterator to traverse all the elements into the set.

When the Values instance is closed, it closes all existing and non-closed ValuesIterator instances too.

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

Member Function Documentation

def sparksee.KeyValues.__next__ (   self)

Used in next()

Returns
The next element
def sparksee.KeyValues.close (   self)

Closes the KeyValues instance.

It must be called to ensure the integrity of all data.

def sparksee.KeyValues.has_next (   self)

Checks if the KeyValues has more KeyValue pairs.

Returns
Returns ture if there are more KeyValue pairs
def sparksee.KeyValues.is_closed (   self)

Gets if KeyValues instance has been closed or not.

See also
close()
Returns
TRUE if the Values instance has been closed, FALSE otherwise.
def sparksee.KeyValues.next (   self)

Gets the next KeyValue pair.

Returns
Returns the next KeyValue pair

Referenced by sparksee.KeyValues.next().

def sparksee.KeyValues.next (   self,
  kv 
)

Gets the next KeyValue pair.

Parameters
kvReturns the next KeyValue pair

References sparksee.KeyValues.next().