sparksee.KeyValues Class Reference

Value set class. More...

Public Member Functions
	next (self)
	Gets the next KeyValue pair.
	next (self, kv)
	Gets the next KeyValue pair.
	has_next (self)
	Checks if the KeyValues has more KeyValue pairs.
	close (self)
	Closes the KeyValues instance.
	__next__ (self)
	Return the next item from the container.
	is_closed (self)
	Gets if KeyValues instance has been closed or not.

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

__next__()

sparksee.KeyValues.__next__

(

self

)

Return the next item from the container.

If there are no further items, raise the StopIteration exception.

Returns

The next element

close()

sparksee.KeyValues.close

(

self

)

Closes the KeyValues instance.

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

has_next()

sparksee.KeyValues.has_next

(

self

)

Checks if the KeyValues has more KeyValue pairs.

Returns

Returns ture if there are more KeyValue pairs

is_closed()

sparksee.KeyValues.is_closed

(

self

)

Gets if KeyValues instance has been closed or not.

See also

close()

Returns

TRUE if the KeyValues instance has been closed, FALSE otherwise.

next() [1/2]

sparksee.KeyValues.next

(

self

)

Gets the next KeyValue pair.

Returns

Returns the next KeyValue pair

next() [2/2]

sparksee.KeyValues.next	(		self,
			kv )

Gets the next KeyValue pair.

Parameters

kv	Returns the next KeyValue pair