Trees       Indices       Help   
Project Homepage
Package gen :: Package proxy :: Module dbbase :: Class DbBase
[frames] | no frames]

Class DbBase

source code

A proxy to a Gramps database. This proxy will act like a Gramps database, but all data marked private will be hidden from the user.

Instance Methods
 
set_prefixes(self, person, media, family, source, place, event, repository, note) source code
 
rebuild_secondary(self, callback) source code
 
version_supported(self)
Return True when the file has a supported version		 source code
 
need_upgrade(self) source code
 
gramps_upgrade(self) source code
 
del_person(self, handle) source code
 
del_source(self, handle) source code
 
del_repository(self, handle) source code
 
del_note(self, handle) source code
 
del_place(self, handle) source code
 
del_media(self, handle) source code
 
del_family(self, handle) source code
 
del_event(self, handle) source code
 
create_id(self) source code
 
get_person_cursor(self) source code
 
get_person_cursor_iter(self, msg='Processing Person records') source code
 
get_family_cursor(self) source code
 
get_family_cursor_iter(self, msg='Processing Family records') source code
 
get_event_cursor(self) source code
 
get_event_cursor_iter(self, msg='Processing Event records') source code
 
get_place_cursor(self) source code
 
get_place_cursor_iter(self, msg='Processing Place records') source code
 
get_source_cursor(self) source code
 
get_source_cursor_iter(self, msg='Processing Source records') source code
 
get_media_cursor(self) source code
 
get_media_cursor_iter(self, msg='Processing Media records') source code
 
get_repository_cursor(self) source code
 
get_repository_cursor_iter(self, msg='Processing Repository records') source code
 
get_note_cursor(self) source code
 
get_note_cursor_iter(self, msg='Processing Note records') source code
 
open_undodb(self) source code
 
close_undodb(self) source code
 
load(self, name, callback, mode='w')
Opens the specified database.		 source code
 
load_from(self, other_database, filename, callback)
Loads data from the other database into itself.		 source code
 
close(self)
Closes the specified database.		 source code
 
is_open(self)
Return 1 if the database has been opened.		 source code
 
request_rebuild(self) source code
 
commit_base(self, obj, data_map, key, update_list, add_list, transaction, change_time) source code
 
commit_person(self, person, transaction, change_time=None) source code
 
commit_media_object(self, obj, transaction, change_time=None) source code
 
commit_source(self, source, transaction, change_time=None) source code
 
commit_place(self, place, transaction, change_time=None) source code
 
commit_personal_event(self, event, transaction, change_time=None) source code
 
commit_family_event(self, event, transaction, change_time=None) source code
 
commit_event(self, event, transaction, change_time=None) source code
 
commit_family(self, family, transaction, change_time=None) source code
 
commit_repository(self, repository, transaction, change_time=None) source code
 
commit_note(self, note, transaction, change_time=None) source code
 
find_next_person_gramps_id(self) source code
 
find_next_place_gramps_id(self) source code
 
find_next_event_gramps_id(self) source code
 
find_next_object_gramps_id(self) source code
 
find_next_source_gramps_id(self) source code
 
find_next_family_gramps_id(self) source code
 
find_next_repository_gramps_id(self) source code
 
find_next_note_gramps_id(self) source code
 
get_person_from_handle(self, handle)
Finds a Person in the database from the passed gramps' ID.		 source code
 
get_source_from_handle(self, handle)
Finds a Source in the database from the passed gramps' ID.		 source code
 
get_object_from_handle(self, handle)
Finds an Object in the database from the passed gramps' ID.		 source code
 
get_place_from_handle(self, handle)
Finds a Place in the database from the passed gramps' ID.		 source code
 
get_event_from_handle(self, handle)
Finds a Event in the database from the passed gramps' ID.		 source code
 
get_family_from_handle(self, handle)
Finds a Family in the database from the passed gramps' ID.		 source code
 
get_repository_from_handle(self, handle)
Finds a Repository in the database from the passed gramps' ID.		 source code
 
get_note_from_handle(self, handle)
Finds a Note in the database from the passed gramps' ID.		 source code
 
find_person_from_handle(self, handle, transaction)
Finds a Person in the database from the passed GRAMPS ID.		 source code
 
find_source_from_handle(self, handle, transaction)
Finds a Source in the database from the passed handle.		 source code
 
find_event_from_handle(self, handle, transaction)
Finds a Event in the database from the passed handle.		 source code
 
find_object_from_handle(self, handle, transaction)
Finds an MediaObject in the database from the passed handle.		 source code
 
find_place_from_handle(self, handle, transaction)
Finds a Place in the database from the passed handle.		 source code
 
find_family_from_handle(self, handle, transaction)
Finds a Family in the database from the passed handle.		 source code
 
find_repository_from_handle(self, handle, transaction)
Finds a Repository in the database from the passed handle.		 source code
 
find_note_from_handle(self, handle, transaction)
Finds a Note in the database from the passed handle.		 source code
 
check_person_from_handle(self, handle, transaction)
Checks whether a Person with the passed handle exists in the database.		 source code
 
check_source_from_handle(self, handle, transaction)
Checks whether a Source with the passed handle exists in the database.		 source code
 
check_event_from_handle(self, handle, transaction)
Checks whether an Event with the passed handle exists in the database.		 source code
 
check_object_from_handle(self, handle, transaction)
Checks whether a MediaObject with the passed handle exists in the database.		 source code
 
check_place_from_handle(self, handle, transaction)
Checks whether a Place with the passed handle exists in the database.		 source code
 
check_family_from_handle(self, handle, transaction)
Checks whether a Family with the passed handle exists in the database.		 source code
 
check_repository_from_handle(self, handle, transaction)
Checks whether a Repository with the passed handle exists in the database.		 source code
 
check_note_from_handle(self, handle, transaction)
Checks whether a Note with the passed handle exists in the database.		 source code
 
get_person_from_gramps_id(self, val)
Finds a Person in the database from the passed GRAMPS ID.		 source code
 
get_family_from_gramps_id(self, val)
Finds a Family in the database from the passed GRAMPS ID.		 source code
 
get_event_from_gramps_id(self, val)
Finds an Event in the database from the passed GRAMPS ID.		 source code
 
get_place_from_gramps_id(self, val)
Finds a Place in the database from the passed gramps' ID.		 source code
 
get_source_from_gramps_id(self, val)
Finds a Source in the database from the passed gramps' ID.		 source code
 
get_object_from_gramps_id(self, val)
Finds a MediaObject in the database from the passed gramps' ID.		 source code
 
get_repository_from_gramps_id(self, val)
Finds a Repository in the database from the passed gramps' ID.		 source code
 
get_note_from_gramps_id(self, val)
Finds a Note in the database from the passed gramps' ID.		 source code
 
add_person(self, person, transaction)
Add a Person to the database, assigning internal IDs if they have not already been defined.		 source code
 
add_family(self, family, transaction)
Add a Family to the database, assigning internal IDs if they have not already been defined.		 source code
 
add_source(self, source, transaction)
Add a Source to the database, assigning internal IDs if they have not already been defined.		 source code
 
add_event(self, event, transaction)
Add an Event to the database, assigning internal IDs if they have not already been defined.		 source code
 
add_person_event(self, event, transaction)
Add an Event to the database, assigning internal IDs if they have not already been defined.		 source code
 
add_family_event(self, event, transaction)
Add an Event to the database, assigning internal IDs if they have not already been defined.		 source code
 
add_place(self, place, transaction)
Add a Place to the database, assigning internal IDs if they have not already been defined.		 source code
 
add_object(self, obj, transaction)
Add a MediaObject to the database, assigning internal IDs if they have not already been defined.		 source code
 
add_repository(self, obj, transaction)
Add a Repository to the database, assigning internal IDs if they have not already been defined.		 source code
 
add_note(self, obj, transaction)
Add a Note to the database, assigning internal IDs if they have not already been defined.		 source code
 
get_name_group_mapping(self, name)
Return the default grouping name for a surname		 source code
 
has_name_group_key(self, name)
Return if a key exists in the name_group table		 source code
 
get_name_group_keys(self)
Return the defined names that have been assigned to a default grouping		 source code
 
set_name_group_mapping(self, name, group)
Set the default grouping name for a surname.		 source code
 
get_number_of_people(self)
Return the number of people currently in the databse.		 source code
 
get_number_of_families(self)
Return the number of families currently in the databse.		 source code
 
get_number_of_events(self)
Return the number of events currently in the databse.		 source code
 
get_number_of_places(self)
Return the number of places currently in the databse.		 source code
 
get_number_of_sources(self)
Return the number of sources currently in the databse.		 source code
 
get_number_of_media_objects(self)
Return the number of media objects currently in the databse.		 source code
 
get_number_of_repositories(self)
Return the number of source repositories currently in the databse.		 source code
 
get_number_of_notes(self)
Return the number of notes currently in the databse.		 source code
 
get_person_handles(self, sort_handles=True)
Return a list of database handles, one handle for each Person in the database.		 source code
 
get_place_handles(self, sort_handles=True)
Return a list of database handles, one handle for each Place in the database.		 source code
 
get_source_handles(self, sort_handles=True)
Return a list of database handles, one handle for each Source in the database.		 source code
 
get_media_object_handles(self, sort_handles=True)
Return a list of database handles, one handle for each MediaObject in the database.		 source code
 
get_event_handles(self)
Return a list of database handles, one handle for each Event in the database.		 source code
 
get_family_handles(self)
Return a list of database handles, one handle for each Family in the database.		 source code
 
get_repository_handles(self)
Return a list of database handles, one handle for each Repository in the database.		 source code
 
get_note_handles(self)
Return a list of database handles, one handle for each Note in the database.		 source code
 
get_gramps_ids(self, obj_key) source code
 
has_gramps_id(self, obj_key, gramps_id) source code
 
find_initial_person(self) source code
 
set_person_id_prefix(self, val)
Set the naming template for GRAMPS Person ID values.		 source code
 
set_source_id_prefix(self, val)
Set the naming template for GRAMPS Source ID values.		 source code
 
set_object_id_prefix(self, val)
Set the naming template for GRAMPS MediaObject ID values.		 source code
 
set_place_id_prefix(self, val)
Set the naming template for GRAMPS Place ID values.		 source code
 
set_family_id_prefix(self, val)
Set the naming template for GRAMPS Family ID values.		 source code
 
set_event_id_prefix(self, val)
Set the naming template for GRAMPS Event ID values.		 source code
 
set_repository_id_prefix(self, val)
Set the naming template for GRAMPS Repository ID values.		 source code
 
set_note_id_prefix(self, val)
Set the naming template for GRAMPS Note ID values.		 source code
 
transaction_begin(self, msg='', batch=False, no_magic=False)
Create a new Transaction tied to the current UNDO database.		 source code
 
transaction_commit(self, transaction, msg)
Commits the transaction to the assocated UNDO database.		 source code
 
do_commit(self, add_list, db_map) source code
 
undo_available(self)
returns boolean of whether or not there's a possibility of undo		 source code
 
redo_available(self)
returns boolean of whether or not there's a possibility of redo		 source code
 
undo(self, update_history=True)
Accesses the last committed transaction, and reverts the data to the state before the transaction was committed.		 source code
 
redo(self, update_history=True)
Accesses the last undone transaction, and reverts the data to the state before the transaction was undone.		 source code
 
undo_reference(self, data, handle) source code
 
set_undo_callback(self, callback)
Defines the callback function that is called whenever an undo operation is executed.		 source code
 
set_redo_callback(self, callback)
Defines the callback function that is called whenever an redo operation is executed.		 source code
 
get_surname_list(self)
Return the list of locale-sorted surnames contained in the database.		 source code
 
build_surname_list(self)
Builds the list of locale-sorted surnames contained in the database.		 source code
 
add_to_surname_list(self, person, batch_transaction) source code
 
remove_from_surname_list(self, person)
Check whether there are persons with the same surname left in the database.		 source code
 
get_bookmarks(self)
returns the list of Person handles in the bookmarks		 source code
 
get_family_bookmarks(self)
returns the list of Person handles in the bookmarks		 source code
 
get_event_bookmarks(self)
returns the list of Person handles in the bookmarks		 source code
 
get_place_bookmarks(self)
returns the list of Person handles in the bookmarks		 source code
 
get_source_bookmarks(self)
returns the list of Person handles in the bookmarks		 source code
 
get_media_bookmarks(self)
returns the list of Person handles in the bookmarks		 source code
 
get_repo_bookmarks(self)
returns the list of Person handles in the bookmarks		 source code
 
get_note_bookmarks(self)
returns the list of Note handles in the bookmarks		 source code
 
set_researcher(self, owner)
sets the information about the owner of the database		 source code
 
get_researcher(self)
returns the Researcher instance, providing information about the owner of the database		 source code
 
set_default_person_handle(self, handle)
sets the default Person to the passed instance		 source code
 
get_default_person(self)
returns the default Person of the database		 source code
 
get_default_handle(self)
returns the default Person of the database		 source code
 
get_save_path(self)
returns the save path of the file, or "" if one does not exist		 source code
 
set_save_path(self, path)
sets the save path for the database		 source code
 
get_person_event_types(self)
returns a list of all Event types assocated with Person instances in the database		 source code
 
get_person_attribute_types(self)
returns a list of all Attribute types assocated with Person instances in the database		 source code
 
get_family_attribute_types(self)
returns a list of all Attribute types assocated with Family instances in the database		 source code
 
get_family_event_types(self)
returns a list of all Event types assocated with Family instances in the database		 source code
 
get_marker_types(self)
return a list of all marker types available in the database		 source code
 
get_media_attribute_types(self)
returns a list of all Attribute types assocated with Media and MediaRef instances in the database		 source code
 
get_family_relation_types(self)
returns a list of all relationship types assocated with Family instances in the database		 source code
 
get_child_reference_types(self)
returns a list of all child reference types assocated with Family instances in the database		 source code
 
get_event_roles(self)
returns a list of all custom event role names assocated with Event instances in the database		 source code
 
get_name_types(self)
returns a list of all custom names types assocated with Person instances in the database		 source code
 
get_repository_types(self)
returns a list of all custom repository types assocated with Repository instances in the database		 source code
 
get_note_types(self)
returns a list of all custom note types assocated with Note instances in the database		 source code
 
get_source_media_types(self)
returns a list of all custom source media types assocated with Source instances in the database		 source code
 
get_url_types(self)
returns a list of all custom names types assocated with Url instances in the database		 source code
 
remove_person(self, handle, transaction)
Remove the Person specified by the database handle from the database, preserving the change in the passed transaction.		 source code
 
remove_source(self, handle, transaction)
Remove the Source specified by the database handle from the database, preserving the change in the passed transaction.		 source code
 
remove_event(self, handle, transaction)
Remove the Event specified by the database handle from the database, preserving the change in the passed transaction.		 source code
 
remove_object(self, handle, transaction)
Remove the MediaObjectPerson specified by the database handle from the database, preserving the change in the passed transaction.		 source code
 
remove_place(self, handle, transaction)
Remove the Place specified by the database handle from the database, preserving the change in the passed transaction.		 source code
 
remove_family(self, handle, transaction)
Remove the Family specified by the database handle from the database, preserving the change in the passed transaction.		 source code
 
remove_repository(self, handle, transaction)
Remove the Repository specified by the database handle from the database, preserving the change in the passed transaction.		 source code
 
remove_note(self, handle, transaction)
Remove the Note specified by the database handle from the database, preserving the change in the passed transaction.		 source code
 
get_raw_person_data(self, handle) source code
 
get_raw_family_data(self, handle) source code
 
get_raw_object_data(self, handle) source code
 
get_raw_place_data(self, handle) source code
 
get_raw_event_data(self, handle) source code
 
get_raw_source_data(self, handle) source code
 
get_raw_repository_data(self, handle) source code
 
get_raw_note_data(self, handle) source code
 
has_person_handle(self, handle)
returns True if the handle exists in the current Person database.		 source code
 
has_event_handle(self, handle)
returns True if the handle exists in the current Event database.		 source code
 
has_source_handle(self, handle)
returns True if the handle exists in the current Source database.		 source code
 
has_place_handle(self, handle)
returns True if the handle exists in the current Place database.		 source code
 
has_family_handle(self, handle)
returns True if the handle exists in the current Family database.		 source code
 
has_object_handle(self, handle)
returns True if the handle exists in the current MediaObjectdatabase.		 source code
 
has_repository_handle(self, handle)
returns True if the handle exists in the current Repository database.		 source code
 
has_note_handle(self, handle)
returns True if the handle exists in the current Note database.		 source code
 
set_mediapath(self, path)
sets the default media path for database, path should be utf-8		 source code
 
get_mediapath(self)
returns the default media path of the database		 source code
 
set_column_order(self, col_list, name) source code
 
set_person_column_order(self, col_list)
Stores the Person display common information in the database's metadata.		 source code
 
set_family_list_column_order(self, col_list)
Stores the Person display common information in the database's metadata.		 source code
 
set_child_column_order(self, col_list)
Stores the Person display common information in the database's metadata.		 source code
 
set_place_column_order(self, col_list)
Stores the Place display common information in the database's metadata.		 source code
 
set_source_column_order(self, col_list)
Stores the Source display common information in the database's metadata.		 source code
 
set_media_column_order(self, col_list)
Stores the Media display common information in the database's metadata.		 source code
 
set_event_column_order(self, col_list)
Stores the Event display common information in the database's metadata.		 source code
 
set_repository_column_order(self, col_list)
Stores the Repository display common information in the database's metadata.		 source code
 
set_note_column_order(self, col_list)
Stores the Note display common information in the database's metadata.		 source code
 
get_person_column_order(self)
Return the Person display common information stored in the database's metadata.		 source code
 
get_family_list_column_order(self)
Return the Person display common information stored in the database's metadata.		 source code
 
get_child_column_order(self)
Return the Person display common information stored in the database's metadata.		 source code
 
get_place_column_order(self)
Return the Place display common information stored in the database's metadata.		 source code
 
get_source_column_order(self)
Return the Source display common information stored in the database's metadata.		 source code
 
get_media_column_order(self)
Return the MediaObject display common information stored in the database's metadata.		 source code
 
get_event_column_order(self)
Return the Event display common information stored in the database's metadata.		 source code
 
get_repository_column_order(self)
Return the Repository display common information stored in the database's metadata.		 source code
 
get_note_column_order(self)
Return the Note display common information stored in the database's metadata.		 source code
 
delete_primary_from_reference_map(self, handle, transaction)
Called each time an object is removed from the database.		 source code
 
update_reference_map(self, obj, transaction)
Called each time an object is writen to the database.		 source code
 
reindex_reference_map(self, callback)
Reindex all primary records in the database.		 source code
 
find_backlink_handles(self, handle, include_classes=None)
Find all objects that hold a reference to the object handle.		 source code
Method Details

load(self, name, callback, mode='w')

source code 

Opens the specified database. The method needs to be overridden in the derived class.

load_from(self, other_database, filename, callback)

source code 

Loads data from the other database into itself. The filename is the name of the file for the newly created database. The method needs to be overridden in the derived class.

close(self)

source code 

Closes the specified database. The method needs to be overridden in the derived class.

get_person_from_handle(self, handle)

source code 

Finds a Person in the database from the passed gramps' ID. If no such Person exists, None is returned.

get_source_from_handle(self, handle)

source code 

Finds a Source in the database from the passed gramps' ID. If no such Source exists, None is returned.

get_object_from_handle(self, handle)

source code 

Finds an Object in the database from the passed gramps' ID. If no such Object exists, None is returned.

get_place_from_handle(self, handle)

source code 

Finds a Place in the database from the passed gramps' ID. If no such Place exists, None is returned.

get_event_from_handle(self, handle)

source code 

Finds a Event in the database from the passed gramps' ID. If no such Event exists, None is returned.

get_family_from_handle(self, handle)

source code 

Finds a Family in the database from the passed gramps' ID. If no such Family exists, None is returned.

get_repository_from_handle(self, handle)

source code 

Finds a Repository in the database from the passed gramps' ID. If no such Repository exists, None is returned.

get_note_from_handle(self, handle)

source code 

Finds a Note in the database from the passed gramps' ID. If no such Note exists, None is returned.

find_person_from_handle(self, handle, transaction)

source code 

Finds a Person in the database from the passed GRAMPS ID. If no such Person exists, a new Person is added to the database.

find_source_from_handle(self, handle, transaction)

source code 

Finds a Source in the database from the passed handle. If no such Source exists, a new Source is added to the database.

find_event_from_handle(self, handle, transaction)

source code 

Finds a Event in the database from the passed handle. If no such Event exists, a new Event is added to the database.

find_object_from_handle(self, handle, transaction)

source code 

Finds an MediaObject in the database from the passed handle. If no such MediaObject exists, a new Object is added to the database.

find_place_from_handle(self, handle, transaction)

source code 

Finds a Place in the database from the passed handle. If no such Place exists, a new Place is added to the database.

find_family_from_handle(self, handle, transaction)

source code 

Finds a Family in the database from the passed handle. If no such Family exists, a new Family is added to the database.

find_repository_from_handle(self, handle, transaction)

source code 

Finds a Repository in the database from the passed handle. If no such Repository exists, a new Repository is added to the database.

find_note_from_handle(self, handle, transaction)

source code 

Finds a Note in the database from the passed handle. If no such Note exists, a new Note is added to the database.

check_person_from_handle(self, handle, transaction)

source code 

Checks whether a Person with the passed handle exists in the database. If no such Person exists, a new Person is added to the database.

check_source_from_handle(self, handle, transaction)

source code 

Checks whether a Source with the passed handle exists in the database. If no such Source exists, a new Source is added to the database.

check_event_from_handle(self, handle, transaction)

source code 

Checks whether an Event with the passed handle exists in the database. If no such Event exists, a new Event is added to the database.

check_object_from_handle(self, handle, transaction)

source code 

Checks whether a MediaObject with the passed handle exists in the database. If no such MediaObject exists, a new Object is added to the database.

check_place_from_handle(self, handle, transaction)

source code 

Checks whether a Place with the passed handle exists in the database. If no such Place exists, a new Place is added to the database.

check_family_from_handle(self, handle, transaction)

source code 

Checks whether a Family with the passed handle exists in the database. If no such Family exists, a new Family is added to the database.

check_repository_from_handle(self, handle, transaction)

source code 

Checks whether a Repository with the passed handle exists in the database. If no such Repository exists, a new Repository is added to the database.

check_note_from_handle(self, handle, transaction)

source code 

Checks whether a Note with the passed handle exists in the database. If no such Note exists, a new Note is added to the database.

get_person_from_gramps_id(self, val)

source code 

Finds a Person in the database from the passed GRAMPS ID. If no such Person exists, None is returned.

get_family_from_gramps_id(self, val)

source code 

Finds a Family in the database from the passed GRAMPS ID. If no such Family exists, None is returned.

get_event_from_gramps_id(self, val)

source code 

Finds an Event in the database from the passed GRAMPS ID. If no such Event exists, None is returned.

get_place_from_gramps_id(self, val)

source code 

Finds a Place in the database from the passed gramps' ID. If no such Place exists, None is returned.

get_source_from_gramps_id(self, val)

source code 

Finds a Source in the database from the passed gramps' ID. If no such Source exists, None is returned.

get_object_from_gramps_id(self, val)

source code 

Finds a MediaObject in the database from the passed gramps' ID. If no such MediaObject exists, None is returned.

get_repository_from_gramps_id(self, val)

source code 

Finds a Repository in the database from the passed gramps' ID. If no such Repository exists, None is returned.

get_note_from_gramps_id(self, val)

source code 

Finds a Note in the database from the passed gramps' ID. If no such Note exists, None is returned.

set_name_group_mapping(self, name, group)

source code 

Set the default grouping name for a surname. Needs to be overridden in the derived class.

get_person_handles(self, sort_handles=True)

source code 

Return a list of database handles, one handle for each Person in the database. If sort_handles is True, the list is sorted by surnames

get_place_handles(self, sort_handles=True)

source code 

Return a list of database handles, one handle for each Place in the database. If sort_handles is True, the list is sorted by Place title.

get_source_handles(self, sort_handles=True)

source code 

Return a list of database handles, one handle for each Source in the database. If sort_handles is True, the list is sorted by Source title.

get_media_object_handles(self, sort_handles=True)

source code 

Return a list of database handles, one handle for each MediaObject in the database. If sort_handles is True, the list is sorted by title.

set_person_id_prefix(self, val)

source code 

Set the naming template for GRAMPS Person ID values. The string is expected to be in the form of a simple text string, or in a format that contains a C/Python style format string using %d, such as I%d or I%04d.

set_source_id_prefix(self, val)

source code 

Set the naming template for GRAMPS Source ID values. The string is expected to be in the form of a simple text string, or in a format that contains a C/Python style format string using %d, such as S%d or S%04d.

set_object_id_prefix(self, val)

source code 

Set the naming template for GRAMPS MediaObject ID values. The string is expected to be in the form of a simple text string, or in a format that contains a C/Python style format string using %d, such as O%d or O%04d.

set_place_id_prefix(self, val)

source code 

Set the naming template for GRAMPS Place ID values. The string is expected to be in the form of a simple text string, or in a format that contains a C/Python style format string using %d, such as P%d or P%04d.

set_family_id_prefix(self, val)

source code 

Set the naming template for GRAMPS Family ID values. The string is expected to be in the form of a simple text string, or in a format that contains a C/Python style format string using %d, such as F%d or F%04d.

set_event_id_prefix(self, val)

source code 

Set the naming template for GRAMPS Event ID values. The string is expected to be in the form of a simple text string, or in a format that contains a C/Python style format string using %d, such as E%d or E%04d.

set_repository_id_prefix(self, val)

source code 

Set the naming template for GRAMPS Repository ID values. The string is expected to be in the form of a simple text string, or in a format that contains a C/Python style format string using %d, such as R%d or R%04d.

set_note_id_prefix(self, val)

source code 

Set the naming template for GRAMPS Note ID values. The string is expected to be in the form of a simple text string, or in a format that contains a C/Python style format string using %d, such as N%d or N%04d.

transaction_begin(self, msg='', batch=False, no_magic=False)

source code 

Create a new Transaction tied to the current UNDO database. The transaction has no effect until it is committed using the transaction_commit function of the this database object.

set_undo_callback(self, callback)

source code 

Defines the callback function that is called whenever an undo operation is executed. The callback function recieves a single argument that is a text string that defines the operation.

set_redo_callback(self, callback)

source code 

Defines the callback function that is called whenever an redo operation is executed. The callback function recieves a single argument that is a text string that defines the operation.

build_surname_list(self)

source code 

Builds the list of locale-sorted surnames contained in the database. The function must be overridden in the derived class.

remove_from_surname_list(self, person)

source code 

Check whether there are persons with the same surname left in the database. If not then we need to remove the name from the list. The function must be overridden in the derived class.

remove_person(self, handle, transaction)

source code 

Remove the Person specified by the database handle from the database, preserving the change in the passed transaction. This method must be overridden in the derived class.

remove_source(self, handle, transaction)

source code 

Remove the Source specified by the database handle from the database, preserving the change in the passed transaction. This method must be overridden in the derived class.

remove_event(self, handle, transaction)

source code 

Remove the Event specified by the database handle from the database, preserving the change in the passed transaction. This method must be overridden in the derived class.

remove_object(self, handle, transaction)

source code 

Remove the MediaObjectPerson specified by the database handle from the database, preserving the change in the passed transaction. This method must be overridden in the derived class.

remove_place(self, handle, transaction)

source code 

Remove the Place specified by the database handle from the database, preserving the change in the passed transaction. This method must be overridden in the derived class.

remove_family(self, handle, transaction)

source code 

Remove the Family specified by the database handle from the database, preserving the change in the passed transaction. This method must be overridden in the derived class.

remove_repository(self, handle, transaction)

source code 

Remove the Repository specified by the database handle from the database, preserving the change in the passed transaction. This method must be overridden in the derived class.

remove_note(self, handle, transaction)

source code 

Remove the Note specified by the database handle from the database, preserving the change in the passed transaction. This method must be overridden in the derived class.

delete_primary_from_reference_map(self, handle, transaction)

source code 

Called each time an object is removed from the database. This can be used by subclasses to update any additional index tables that might need to be changed.

update_reference_map(self, obj, transaction)

source code 

Called each time an object is writen to the database. This can be used by subclasses to update any additional index tables that might need to be changed.

find_backlink_handles(self, handle, include_classes=None)

source code 

Find all objects that hold a reference to the object handle. Returns an interator over alist of (class_name, handle) tuples.

Parameters:
  • handle (database handle) - handle of the object to search for.
  • include_classes (list of class names

    This default implementation does a sequencial scan through all the primary object databases and is very slow. Backends can override this method to provide much faster implementations that make use of additional capabilities of the backend.

    Note that this is a generator function, it returns a iterator for use in loops. If you want a list of the results use:

    > result_list = [i for i in find_backlink_handles(handle)]

    ) - list of class names to include in the results. Default: None means include all classes.

   Trees       Indices       Help   
Project Homepage
Generated by Epydoc 3.0.1 on Sun Mar 9 21:52:52 2008 http://epydoc.sourceforge.net