Package gen :: Package db :: Module cursor :: Class GrampsCursor

Class GrampsCursor

Provide a basic iterator that allows the user to cycle through the elements in a particular map.

A cursor should never be directly instantiated. Instead, in should be created by the database class.

A cursor should only be used for a single pass through the database. If multiple passes are needed, multiple cursors should be used.

Instance Methods

first(self)
Return the first (index, data) pair in the database.

source code

next(self)
Return the next (index, data) pair in the database.

source code

close(self)
Close the cursor.

source code

get_length(self)
Return the number of records in the table referenced by the cursor.

source code

Method Details

first(self)

source code

Return the first (index, data) pair in the database.

This should be called before the first call to next(). Note that the data return is in the format of the serialized format stored in the database, not in the more usable class object. The data should be converted to a class using the class's unserialize method.

If no data is available, None is returned.

next(self)

source code

Return the next (index, data) pair in the database.

Like the first() method, the data return is in the format of the serialized format stored in the database, not in the more usable class object. The data should be converted to a class using the class's unserialize method.

None is returned when no more data is available.

close(self)

source code

Close the cursor.

This should be called when the user is finished using the cursor, freeing up the cursor's resources.