Source code for gramps.gen.db.base

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2007  Donald N. Allingham
# Copyright (C) 2010       Nick Hall
# Copyright (C) 2011       Tim G L Lyons
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

"""
Base class for the Gramps databases. All database interfaces should inherit
from this class.
"""

#-------------------------------------------------------------------------
#
# Python libraries
#
#-------------------------------------------------------------------------
from ..const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext

#-------------------------------------------------------------------------
#
# Gramps libraries
#
#-------------------------------------------------------------------------
from ..lib.childreftype import ChildRefType
from ..lib.childref import ChildRef
from .txn import DbTxn
from .exceptions import DbTransactionCancel

[docs]class DbReadBase(object): """ Gramps database object. This object is a base class for all database interfaces. All methods raise NotImplementedError and must be implemented in the derived class as required. """ def __init__(self): """ Create a new DbReadBase instance. A new DbReadBase class should never be directly created. Only classes derived from this class should be created. """ self.basedb = self self.__feature = {} # {"feature": VALUE, ...} self._tables = { "Citation": {}, "Event": {}, "Family": {}, "Media": {}, "Note": {}, "Person": {}, "Place": {}, "Repository": {}, "Source": {}, "Tag": {}, }
[docs] def get_feature(self, feature): """ Databases can implement certain features or not. The default is None, unless otherwise explicitly stated. """ return self.__feature.get(feature, None) # can also be explitily None
[docs] def set_feature(self, feature, value): """ Databases can implement certain features. """ self.__feature[feature] = value
[docs] def all_handles(self, table): """ Return all handles from the specified table as a list """ raise NotImplementedError
[docs] def close(self): """ Close the specified database. """ raise NotImplementedError
[docs] def db_has_bm_changes(self): """ Return whethere there were bookmark changes during the session. """ raise NotImplementedError
[docs] def find_initial_person(self): """ Returns first person in the database """ raise NotImplementedError
[docs] def find_next_event_gramps_id(self): """ Return the next available Gramps ID for a Event object based off the event ID prefix. """ raise NotImplementedError
[docs] def find_next_family_gramps_id(self): """ Return the next available Gramps ID for a Family object based off the family ID prefix. """ raise NotImplementedError
[docs] def find_next_note_gramps_id(self): """ Return the next available Gramps ID for a Note object based off the note ID prefix. """ raise NotImplementedError
[docs] def find_next_object_gramps_id(self): """ Return the next available Gramps ID for a MediaObject object based off the media object ID prefix. """ raise NotImplementedError
[docs] def find_next_person_gramps_id(self): """ Return the next available Gramps ID for a Person object based off the person ID prefix. """ raise NotImplementedError
[docs] def find_next_place_gramps_id(self): """ Return the next available Gramps ID for a Place object based off the place ID prefix. """ raise NotImplementedError
[docs] def find_next_repository_gramps_id(self): """ Return the next available Gramps ID for a Repository object based off the repository ID prefix. """ raise NotImplementedError
[docs] def find_next_source_gramps_id(self): """ Return the next available Gramps ID for a Source object based off the source ID prefix. """ raise NotImplementedError
[docs] def get_bookmarks(self): """ Return the list of Person handles in the bookmarks. """ raise NotImplementedError
[docs] def get_child_reference_types(self): """ Return a list of all child reference types associated with Family instances in the database. """ raise NotImplementedError
[docs] def get_default_handle(self): """ Return the default Person of the database. """ raise NotImplementedError
[docs] def get_default_person(self): """ Return the default Person of the database. """ raise NotImplementedError
[docs] def get_event_bookmarks(self): """ Return the list of Event handles in the bookmarks. """ raise NotImplementedError
[docs] def get_event_cursor(self): """ Return a reference to a cursor over Family objects """ raise NotImplementedError
[docs] def get_event_from_gramps_id(self, val): """ Find an Event in the database from the passed Gramps ID. If no such Event exists, None is returned. Needs to be overridden by the derived class. """ raise NotImplementedError
[docs] def get_event_from_handle(self, handle): """ Find a Event in the database from the passed Gramps ID. If no such Event exists, None is returned. """ raise NotImplementedError
[docs] def get_event_handles(self): """ Return a list of database handles, one handle for each Event in the database. """ raise NotImplementedError
[docs] def get_event_roles(self): """ Return a list of all custom event role names associated with Event instances in the database. """ raise NotImplementedError
[docs] def get_event_attribute_types(self): """ Return a list of all Attribute types assocated with Event instances in the database. """ raise NotImplementedError
[docs] def get_event_types(self): """ Return a list of all event types in the database. """ raise NotImplementedError
[docs] def get_family_attribute_types(self): """ Return a list of all Attribute types associated with Family instances in the database. """ raise NotImplementedError
[docs] def get_family_bookmarks(self): """ Return the list of Family handles in the bookmarks. """ raise NotImplementedError
[docs] def get_family_cursor(self): """ Return a reference to a cursor over Family objects """ raise NotImplementedError
[docs] def get_family_event_types(self): """ Deprecated: Use get_event_types """ raise NotImplementedError
[docs] def get_family_from_gramps_id(self, val): """ Find a Family in the database from the passed Gramps ID. If no such Family exists, None is returned. Need to be overridden by the derived class. """ raise NotImplementedError
[docs] def get_family_from_handle(self, handle): """ Find a Family in the database from the passed Gramps ID. If no such Family exists, None is returned. """ raise NotImplementedError
[docs] def get_family_handles(self): """ Return a list of database handles, one handle for each Family in the database. """ raise NotImplementedError
[docs] def get_family_relation_types(self): """ Return a list of all relationship types associated with Family instances in the database. """ raise NotImplementedError
[docs] def get_from_handle(self, handle, class_type, data_map): """ Return unserialized data from database given handle and object class """ raise NotImplementedError
[docs] def get_gramps_ids(self, obj_key): """ Returns all the keys from a table given a table name """ raise NotImplementedError
[docs] def get_media_attribute_types(self): """ Return a list of all Attribute types associated with Media and MediaRef instances in the database. """ raise NotImplementedError
[docs] def get_media_bookmarks(self): """ Return the list of Media handles in the bookmarks. """ raise NotImplementedError
[docs] def get_media_cursor(self): """ Return a reference to a cursor over Media objects """ raise NotImplementedError
[docs] def get_media_object_handles(self, sort_handles=False): """ 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. """ raise NotImplementedError
[docs] def get_mediapath(self): """ Return the default media path of the database. """ raise NotImplementedError
[docs] def get_name_group_keys(self): """ Return the defined names that have been assigned to a default grouping. """ raise NotImplementedError
[docs] def get_name_group_mapping(self, surname): """ Return the default grouping name for a surname. """ raise NotImplementedError
[docs] def get_name_types(self): """ Return a list of all custom names types associated with Person instances in the database. """ raise NotImplementedError
[docs] def get_origin_types(self): """ Return a list of all custom origin types associated with Person/Surname instances in the database. """ raise NotImplementedError
[docs] def get_note_bookmarks(self): """ Return the list of Note handles in the bookmarks. """ raise NotImplementedError
[docs] def get_note_cursor(self): """ Return a reference to a cursor over Note objects """ raise NotImplementedError
[docs] def get_note_from_gramps_id(self, val): """ Find a Note in the database from the passed Gramps ID. If no such Note exists, None is returned. Needs to be overridden by the derived classderri. """ raise NotImplementedError
[docs] def get_note_from_handle(self, handle): """ Find a Note in the database from the passed Gramps ID. If no such Note exists, None is returned. """ raise NotImplementedError
[docs] def get_note_handles(self): """ Return a list of database handles, one handle for each Note in the database. """ raise NotImplementedError
[docs] def get_note_types(self): """ Return a list of all custom note types associated with Note instances in the database. """ raise NotImplementedError
[docs] def get_number_of_events(self): """ Return the number of events currently in the database. """ raise NotImplementedError
[docs] def get_number_of_families(self): """ Return the number of families currently in the database. """ raise NotImplementedError
[docs] def get_number_of_media_objects(self): """ Return the number of media objects currently in the database. """ raise NotImplementedError
[docs] def get_number_of_notes(self): """ Return the number of notes currently in the database. """ raise NotImplementedError
[docs] def get_number_of_people(self): """ Return the number of people currently in the database. """ raise NotImplementedError
[docs] def get_number_of_places(self): """ Return the number of places currently in the database. """ raise NotImplementedError
[docs] def get_number_of_repositories(self): """ Return the number of source repositories currently in the database. """ raise NotImplementedError
[docs] def get_number_of_sources(self): """ Return the number of sources currently in the database. """ raise NotImplementedError
[docs] def get_number_of_tags(self): """ Return the number of tags currently in the database. """ raise NotImplementedError
[docs] def get_object_from_gramps_id(self, val): """ Find a MediaObject in the database from the passed Gramps ID. If no such MediaObject exists, None is returned. Needs to be overridden by the derived class. """ raise NotImplementedError
[docs] def get_object_from_handle(self, handle): """ Find an Object in the database from the passed Gramps ID. If no such Object exists, None is returned. """ raise NotImplementedError
[docs] def get_person_attribute_types(self): """ Return a list of all Attribute types associated with Person instances in the database. """ raise NotImplementedError
[docs] def get_person_cursor(self): """ Return a reference to a cursor over Person objects """ raise NotImplementedError
[docs] def get_person_event_types(self): """ Deprecated: Use get_event_types """ raise NotImplementedError
[docs] def get_person_from_gramps_id(self, val): """ Find a Person in the database from the passed Gramps ID. If no such Person exists, None is returned. Needs to be overridden by the derived class. """ raise NotImplementedError
[docs] def get_person_from_handle(self, handle): """ Find a Person in the database from the passed Gramps ID. If no such Person exists, None is returned. """ raise NotImplementedError
[docs] def get_person_handles(self, sort_handles=False): """ 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. """ raise NotImplementedError
[docs] def get_source_attribute_types(self): """ Return a list of all Attribute types associated with Source/Citation instances in the database. """ raise NotImplementedError
[docs] def get_place_bookmarks(self): """ Return the list of Place handles in the bookmarks. """ raise NotImplementedError
[docs] def get_place_cursor(self): """ Return a reference to a cursor over Place objects """ raise NotImplementedError
[docs] def get_place_from_gramps_id(self, val): """ Find a Place in the database from the passed Gramps ID. If no such Place exists, None is returned. Needs to be overridden by the derived class. """ raise NotImplementedError
[docs] def get_place_from_handle(self, handle): """ Find a Place in the database from the passed Gramps ID. If no such Place exists, None is returned. """ raise NotImplementedError
[docs] def get_place_handles(self, sort_handles=False): """ 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. """ raise NotImplementedError
[docs] def get_raw_event_data(self, handle): """ Return raw (serialized and pickled) Event object from handle """ raise NotImplementedError
[docs] def get_raw_family_data(self, handle): """ Return raw (serialized and pickled) Family object from handle """ raise NotImplementedError
[docs] def get_raw_note_data(self, handle): """ Return raw (serialized and pickled) Note object from handle """ raise NotImplementedError
[docs] def get_raw_object_data(self, handle): """ Return raw (serialized and pickled) Family object from handle """ raise NotImplementedError
[docs] def get_raw_person_data(self, handle): """ Return raw (serialized and pickled) Person object from handle """ raise NotImplementedError
[docs] def get_raw_place_data(self, handle): """ Return raw (serialized and pickled) Place object from handle """ raise NotImplementedError
[docs] def get_raw_repository_data(self, handle): """ Return raw (serialized and pickled) Repository object from handle """ raise NotImplementedError
[docs] def get_raw_source_data(self, handle): """ Return raw (serialized and pickled) Source object from handle """ raise NotImplementedError
[docs] def get_raw_citation_data(self, handle): """ Return raw (serialized and pickled) Citation object from handle """ raise NotImplementedError
[docs] def get_raw_tag_data(self, handle): """ Return raw (serialized and pickled) Tag object from handle """ raise NotImplementedError
[docs] def get_reference_map_cursor(self): """ Returns a reference to a cursor over the reference map """ raise NotImplementedError
[docs] def get_reference_map_primary_cursor(self): """ Returns a reference to a cursor over the reference map primary map """ raise NotImplementedError
[docs] def get_reference_map_referenced_cursor(self): """ Returns a reference to a cursor over the reference map referenced map """ raise NotImplementedError
[docs] def get_repo_bookmarks(self): """ Return the list of Repository handles in the bookmarks. """ raise NotImplementedError
[docs] def get_repository_cursor(self): """ Return a reference to a cursor over Repository objects """ raise NotImplementedError
[docs] def get_repository_from_gramps_id(self, val): """ Find a Repository in the database from the passed Gramps ID. If no such Repository exists, None is returned. Needs to be overridden by the derived class. """ raise NotImplementedError
[docs] def get_repository_from_handle(self, handle): """ Find a Repository in the database from the passed Gramps ID. If no such Repository exists, None is returned. """ raise NotImplementedError
[docs] def get_repository_handles(self): """ Return a list of database handles, one handle for each Repository in the database. """ raise NotImplementedError
[docs] def get_repository_types(self): """ Return a list of all custom repository types associated with Repository instances in the database. """ raise NotImplementedError
[docs] def get_researcher(self): """ Return the Researcher instance, providing information about the owner of the database. """ raise NotImplementedError
[docs] def get_save_path(self): """ Return the save path of the file, or "" if one does not exist. """ raise NotImplementedError
[docs] def get_source_bookmarks(self): """ Return the list of Source handles in the bookmarks. """ raise NotImplementedError
[docs] def get_source_cursor(self): """ Return a reference to a cursor over Source objects """ raise NotImplementedError
[docs] def get_source_from_gramps_id(self, val): """ Find a Source in the database from the passed Gramps ID. If no such Source exists, None is returned. Needs to be overridden by the derived class. """ raise NotImplementedError
[docs] def get_source_from_handle(self, handle): """ Find a Source in the database from the passed Gramps ID. If no such Source exists, None is returned. """ raise NotImplementedError
[docs] def get_source_handles(self, sort_handles=False): """ 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. """ raise NotImplementedError
[docs] def get_source_media_types(self): """ Return a list of all custom source media types associated with Source instances in the database. """ raise NotImplementedError
[docs] def get_citation_bookmarks(self): """ Return the list of Citation handles in the bookmarks. """ raise NotImplementedError
[docs] def get_citation_cursor(self): """ Return a reference to a cursor over Citation objects """ raise NotImplementedError
[docs] def get_citation_from_gramps_id(self, val): """ Find a Citation in the database from the passed Gramps ID. If no such Citation exists, None is returned. Needs to be overridden by the derived class. """ raise NotImplementedError
[docs] def get_citation_from_handle(self, handle): """ Find a Citation in the database from the passed Gramps ID. If no such Citation exists, None is returned. """ raise NotImplementedError
[docs] def get_citation_handles(self, sort_handles=False): """ Return a list of database handles, one handle for each Citation in the database. If sort_handles is True, the list is sorted by Citation title. """ raise NotImplementedError
[docs] def get_surname_list(self): """ Return the list of locale-sorted surnames contained in the database. """ raise NotImplementedError
[docs] def get_tag_cursor(self): """ Return a reference to a cursor over Tag objects """ raise NotImplementedError
[docs] def get_tag_from_handle(self, handle): """ Find a Tag in the database from the passed handle. If no such Tag exists, None is returned. """ raise NotImplementedError
[docs] def get_tag_from_name(self, val): """ Find a Tag in the database from the passed Tag name. If no such Tag exists, None is returned. Needs to be overridden by the derived class. """ raise NotImplementedError
[docs] def get_tag_handles(self, sort_handles=False): """ Return a list of database handles, one handle for each Tag in the database. If sort_handles is True, the list is sorted by Tag name. """ raise NotImplementedError
[docs] def get_url_types(self): """ Return a list of all custom names types associated with Url instances in the database. """ raise NotImplementedError
[docs] def get_place_types(self): """ Return a list of all custom place types assocated with Place instances in the database. """ raise NotImplementedError
[docs] def gramps_upgrade(self): """ Return True if database is upgraded """ raise NotImplementedError
[docs] def has_event_handle(self, handle): """ Return True if the handle exists in the current Event database. """ raise NotImplementedError
[docs] def has_family_handle(self, handle): """ Return True if the handle exists in the current Family database. """ raise NotImplementedError
[docs] def has_gramps_id(self, obj_key, gramps_id): """ Returns True if the key exists in table given a table name Not used in current codebase """ raise NotImplementedError
[docs] def has_name_group_key(self, name): """ Return if a key exists in the name_group table. """ raise NotImplementedError
[docs] def has_note_handle(self, handle): """ Return True if the handle exists in the current Note database. """ raise NotImplementedError
[docs] def has_object_handle(self, handle): """ Return True if the handle exists in the current MediaObjectdatabase. """ raise NotImplementedError
[docs] def has_person_handle(self, handle): """ Return True if the handle exists in the current Person database. """ raise NotImplementedError
[docs] def has_place_handle(self, handle): """ Return True if the handle exists in the current Place database. """ raise NotImplementedError
[docs] def has_repository_handle(self, handle): """ Return True if the handle exists in the current Repository database. """ raise NotImplementedError
[docs] def has_source_handle(self, handle): """ Return True if the handle exists in the current Source database. """ raise NotImplementedError
[docs] def has_tag_handle(self, handle): """ Return True if the handle exists in the current Tag database. """ raise NotImplementedError
[docs] def is_open(self): """ Return True if the database has been opened. """ raise NotImplementedError
[docs] def iter_event_handles(self): """ Return an iterator over handles for Events in the database """ raise NotImplementedError
[docs] def iter_events(self): """ Return an iterator over objects for Events in the database """ raise NotImplementedError
[docs] def iter_families(self): """ Return an iterator over objects for Families in the database """ raise NotImplementedError
[docs] def iter_family_handles(self): """ Return an iterator over handles for Families in the database """ raise NotImplementedError
[docs] def iter_media_object_handles(self): """ Return an iterator over handles for Media in the database """ raise NotImplementedError
[docs] def iter_media_objects(self): """ Return an iterator over objects for MediaObjects in the database """ raise NotImplementedError
[docs] def iter_note_handles(self): """ Return an iterator over handles for Notes in the database """ raise NotImplementedError
[docs] def iter_notes(self): """ Return an iterator over objects for Notes in the database """ raise NotImplementedError
[docs] def iter_people(self): """ Return an iterator over objects for Persons in the database """ raise NotImplementedError
[docs] def iter_person_handles(self): """ Return an iterator over handles for Persons in the database """ raise NotImplementedError
[docs] def iter_place_handles(self): """ Return an iterator over handles for Places in the database """ raise NotImplementedError
[docs] def iter_places(self): """ Return an iterator over objects for Places in the database """ raise NotImplementedError
[docs] def iter_repositories(self): """ Return an iterator over objects for Repositories in the database """ raise NotImplementedError
[docs] def iter_repository_handles(self): """ Return an iterator over handles for Repositories in the database """ raise NotImplementedError
[docs] def iter_source_handles(self): """ Return an iterator over handles for Sources in the database """ raise NotImplementedError
[docs] def iter_sources(self): """ Return an iterator over objects for Sources in the database """ raise NotImplementedError
[docs] def iter_tag_handles(self): """ Return an iterator over handles for Tags in the database """ raise NotImplementedError
[docs] def iter_tags(self): """ Return an iterator over objects for Tags in the database """ raise NotImplementedError
[docs] def load(self, name, callback, mode=None, force_schema_upgrade=False, force_bsddb_upgrade=False): """ Open the specified database. """ raise NotImplementedError
[docs] def report_bm_change(self): """ Add 1 to the number of bookmark changes during this session. """ raise NotImplementedError
[docs] def request_rebuild(self): """ Notify clients that the data has changed significantly, and that all internal data dependent on the database should be rebuilt. Note that all rebuild signals on all objects are emitted at the same time. It is correct to assume that this is always the case. .. todo:: it might be better to replace these rebuild signals by one single database-rebuild signal. """ raise NotImplementedError
[docs] def version_supported(self): """ Return True when the file has a supported version. """ raise NotImplementedError
[docs] def set_event_id_prefix(self, val): """ 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. """ raise NotImplementedError
[docs] def set_family_id_prefix(self, val): """ 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. """ raise NotImplementedError
[docs] def set_note_id_prefix(self, val): """ 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. """ raise NotImplementedError
[docs] def set_object_id_prefix(self, val): """ 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. """ raise NotImplementedError
[docs] def set_person_id_prefix(self, val): """ 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. """ raise NotImplementedError
[docs] def set_place_id_prefix(self, val): """ 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. """ raise NotImplementedError
[docs] def set_prefixes(self, person, media, family, source, place, event, repository, note): """ Set the prefixes for the gramps ids for all gramps objects """ raise NotImplementedError
[docs] def set_repository_id_prefix(self, val): """ 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. """ raise NotImplementedError
[docs] def set_source_id_prefix(self, val): """ 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. """ raise NotImplementedError
[docs] def set_mediapath(self, path): """ Set the default media path for database, path should be utf-8. """ raise NotImplementedError
[docs] def set_redo_callback(self, callback): """ Define the callback function that is called whenever an redo operation is executed. The callback function receives a single argument that is a text string that defines the operation. """ raise NotImplementedError
[docs] def set_researcher(self, owner): """ Set the information about the owner of the database. """ raise NotImplementedError
[docs] def set_save_path(self, path): """ Set the save path for the database. """ raise NotImplementedError
[docs] def set_undo_callback(self, callback): """ Define the callback function that is called whenever an undo operation is executed. The callback function receives a single argument that is a text string that defines the operation. """ raise NotImplementedError
[docs] def get_dbid(self): """ A unique ID for this database on this computer. """ raise NotImplementedError
[docs] def get_dbname(self): """ A name for this database on this computer. """ raise NotImplementedError
[docs]class DbWriteBase(DbReadBase): """ Gramps database object. This object is a base class for all database interfaces. All methods raise NotImplementedError and must be implemented in the derived class as required. """ def __init__(self): """ Create a new DbWriteBase instance. A new DbWriteBase class should never be directly created. Only classes derived from this class should be created. """ DbReadBase.__init__(self)
[docs] def add_event(self, event, transaction, set_gid=True): """ Add an Event to the database, assigning internal IDs if they have not already been defined. If not set_gid, then gramps_id is not set. """ raise NotImplementedError
[docs] def add_family(self, family, transaction, set_gid=True): """ Add a Family to the database, assigning internal IDs if they have not already been defined. If not set_gid, then gramps_id is not set. """ raise NotImplementedError
[docs] def add_family_event(self, event, transaction): """ Deprecated: Use add_event """ raise NotImplementedError
[docs] def add_note(self, obj, transaction, set_gid=True): """ Add a Note to the database, assigning internal IDs if they have not already been defined. If not set_gid, then gramps_id is not set. """ raise NotImplementedError
[docs] def add_object(self, obj, transaction, set_gid=True): """ Add a MediaObject to the database, assigning internal IDs if they have not already been defined. If not set_gid, then gramps_id is not set. """ raise NotImplementedError
[docs] def add_person(self, person, transaction, set_gid=True): """ Add a Person to the database, assigning internal IDs if they have not already been defined. If not set_gid, then gramps_id is not set. """ raise NotImplementedError
[docs] def add_person_event(self, event, transaction): """ Deprecated: Use add_event """ raise NotImplementedError
[docs] def add_place(self, place, transaction, set_gid=True): """ Add a Place to the database, assigning internal IDs if they have not already been defined. If not set_gid, then gramps_id is not set. """ raise NotImplementedError
[docs] def add_repository(self, obj, transaction, set_gid=True): """ Add a Repository to the database, assigning internal IDs if they have not already been defined. If not set_gid, then gramps_id is not set. """ raise NotImplementedError
[docs] def add_source(self, source, transaction, set_gid=True): """ Add a Source to the database, assigning internal IDs if they have not already been defined. If not set_gid, then gramps_id is not set. """ raise NotImplementedError
[docs] def add_tag(self, tag, transaction): """ Add a Tag to the database, assigning a handle if it has not already been defined. """ raise NotImplementedError
[docs] def add_to_surname_list(self, person, batch_transaction, name): """ Add surname from given person to list of surnames """ raise NotImplementedError
[docs] def build_surname_list(self): """ Build the list of locale-sorted surnames contained in the database. """ raise NotImplementedError
[docs] def commit_base(self, obj, data_map, key, transaction, change_time): """ Commit the specified object to the database, storing the changes as part of the transaction. """ raise NotImplementedError
[docs] def commit_event(self, event, transaction, change_time=None): """ Commit the specified Event to the database, storing the changes as part of the transaction. """ raise NotImplementedError
[docs] def commit_family(self, family, transaction, change_time=None): """ Commit the specified Family to the database, storing the changes as part of the transaction. """ raise NotImplementedError
[docs] def commit_family_event(self, event, transaction, change_time=None): """ Deprecated: Use commit_event """ raise NotImplementedError
[docs] def commit_media_object(self, obj, transaction, change_time=None): """ Commit the specified MediaObject to the database, storing the changes as part of the transaction. """ raise NotImplementedError
[docs] def commit_note(self, note, transaction, change_time=None): """ Commit the specified Note to the database, storing the changes as part of the transaction. """ raise NotImplementedError
[docs] def commit_person(self, person, transaction, change_time=None): """ Commit the specified Person to the database, storing the changes as part of the transaction. """ raise NotImplementedError
[docs] def commit_personal_event(self, event, transaction, change_time=None): """ Deprecated: Use commit_event """ raise NotImplementedError
[docs] def commit_place(self, place, transaction, change_time=None): """ Commit the specified Place to the database, storing the changes as part of the transaction. """ raise NotImplementedError
[docs] def commit_repository(self, repository, transaction, change_time=None): """ Commit the specified Repository to the database, storing the changes as part of the transaction. """ raise NotImplementedError
[docs] def commit_source(self, source, transaction, change_time=None): """ Commit the specified Source to the database, storing the changes as part of the transaction. """ raise NotImplementedError
[docs] def commit_tag(self, tag, transaction, change_time=None): """ Commit the specified Tag to the database, storing the changes as part of the transaction. """ raise NotImplementedError
[docs] def delete_primary_from_reference_map(self, handle, transaction): """ 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. """ raise NotImplementedError
[docs] def get_undodb(self): """ Return the database that keeps track of Undo/Redo operations. """ raise NotImplementedError
[docs] def need_schema_upgrade(self): """ Return True if database needs to be upgraded """ raise NotImplementedError
[docs] def rebuild_secondary(self, callback): """ Rebuild secondary indices """ raise NotImplementedError
[docs] def reindex_reference_map(self, callback): """ Reindex all primary records in the database. """ raise NotImplementedError
[docs] def remove_event(self, handle, transaction): """ 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. """ raise NotImplementedError
[docs] def remove_family(self, handle, transaction): """ 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. """ raise NotImplementedError
[docs] def remove_from_surname_list(self, person): """ 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. """ raise NotImplementedError
[docs] def remove_note(self, handle, transaction): """ 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. """ raise NotImplementedError
[docs] def remove_object(self, handle, transaction): """ 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. """ raise NotImplementedError
[docs] def remove_person(self, handle, transaction): """ 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. """ raise NotImplementedError
[docs] def remove_place(self, handle, transaction): """ 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. """ raise NotImplementedError
[docs] def remove_repository(self, handle, transaction): """ 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. """ raise NotImplementedError
[docs] def remove_source(self, handle, transaction): """ 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. """ raise NotImplementedError
[docs] def remove_tag(self, handle, transaction): """ Remove the Tag specified by the database handle from the database, preserving the change in the passed transaction. This method must be overridden in the derived class. """ raise NotImplementedError
[docs] def set_auto_remove(self): """ BSDDB change log settings using new method with renamed attributes """ raise NotImplementedError
[docs] def set_default_person_handle(self, handle): """ Set the default Person to the passed instance. """ raise NotImplementedError
[docs] def set_name_group_mapping(self, name, group): """ Set the default grouping name for a surname. Needs to be overridden in the derived class. """ raise NotImplementedError
[docs] def sort_surname_list(self): """ Sort the list of surnames contained in the database by locale ordering. """ raise NotImplementedError
[docs] def transaction_begin(self, transaction): """ Prepare the database for the start of a new transaction. Two modes should be provided: transaction.batch=False for ordinary database operations that will be encapsulated in database transactions to make them ACID and that are added to Gramps transactions so that they can be undone. And transaction.batch=True for lengthy database operations, that benefit from a speedup by making them none ACID, and that can't be undone. The user is warned and is asked for permission before the start of such database operations. :param transaction: Gramps transaction ... :type transaction: :py:class:`.DbTxn` :returns: Returns the Gramps transaction. :rtype: :py:class:`.DbTxn` """ raise NotImplementedError
[docs] def transaction_commit(self, transaction): """ Make the changes to the database final and add the content of the transaction to the undo database. """ raise NotImplementedError
[docs] def transaction_abort(self, transaction): """ Revert the changes made to the database so far during the transaction. """ raise NotImplementedError
[docs] def update_reference_map(self, obj, transaction): """ 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. """ raise NotImplementedError
[docs] def write_version(self, name): """ Write version number for a newly created DB. """ raise NotImplementedError
[docs] def add_child_to_family(self, family, child, mrel=ChildRefType(), frel=ChildRefType(), trans=None): """ Adds a child to a family. """ cref = ChildRef() cref.ref = child.handle cref.set_father_relation(frel) cref.set_mother_relation(mrel) family.add_child_ref(cref) child.add_parent_family_handle(family.handle) if trans is None: with DbTxn(_('Add child to family'), self) as trans: self.commit_family(family, trans) self.commit_person(child, trans) else: self.commit_family(family, trans) self.commit_person(child, trans)
[docs] def remove_child_from_family(self, person_handle, family_handle, trans=None): """ Remove a person as a child of the family, deleting the family if it becomes empty. """ if trans is None: with DbTxn(_("Remove child from family"), self) as trans: self.__remove_child_from_family(person_handle, family_handle, trans) else: self.__remove_child_from_family(person_handle, family_handle, trans) trans.set_description(_("Remove child from family"))
def __remove_child_from_family(self, person_handle, family_handle, trans): """ Remove a person as a child of the family, deleting the family if it becomes empty; trans is compulsory. """ person = self.get_person_from_handle(person_handle) family = self.get_family_from_handle(family_handle) person.remove_parent_family_handle(family_handle) family.remove_child_handle(person_handle) if (not family.get_father_handle() and not family.get_mother_handle() and not family.get_child_ref_list()): self.remove_family_relationships(family_handle, trans) else: self.commit_family(family, trans) self.commit_person(person, trans)
[docs] def delete_person_from_database(self, person, trans): """ Deletes a person from the database, cleaning up all associated references. """ # clear out the default person if the person is the default person if self.get_default_person() == person: self.set_default_person_handle(None) # loop through the family list for family_handle in person.get_family_handle_list(): if not family_handle: continue family = self.get_family_from_handle(family_handle) if person.get_handle() == family.get_father_handle(): family.set_father_handle(None) else: family.set_mother_handle(None) if not family.get_father_handle() and \ not family.get_mother_handle() and \ not family.get_child_ref_list(): self.remove_family_relationships(family_handle, trans) else: self.commit_family(family, trans) for family_handle in person.get_parent_family_handle_list(): if family_handle: family = self.get_family_from_handle(family_handle) family.remove_child_handle(person.get_handle()) if not family.get_father_handle() and \ not family.get_mother_handle() and \ not family.get_child_ref_list(): self.remove_family_relationships(family_handle, trans) else: self.commit_family(family, trans) handle = person.get_handle() person_list = [ item[1] for item in self.find_backlink_handles(handle,['Person'])] for phandle in person_list: prsn = self.get_person_from_handle(phandle) prsn.remove_handle_references('Person', [handle]) self.commit_person(prsn, trans) self.remove_person(handle, trans)
[docs] def remove_family_relationships(self, family_handle, trans=None): """ Remove a family and its relationships. """ if trans is None: with DbTxn(_("Remove Family"), self) as trans: self.__remove_family_relationships(family_handle, trans) else: self.__remove_family_relationships(family_handle, trans) trans.set_description(_("Remove Family"))
def __remove_family_relationships(self, family_handle, trans): """ Remove a family and all that references it; trans is compulsory. """ person_list = [item[1] for item in self.find_backlink_handles(family_handle, ['Person'])] for phandle in person_list: person = self.get_person_from_handle(phandle) person.remove_handle_references('Family', [family_handle]) self.commit_person(person, trans) self.remove_family(family_handle, trans)
[docs] def remove_parent_from_family(self, person_handle, family_handle, trans=None): """ Remove a person as either the father or mother of a family, deleting the family if it becomes empty. """ if trans is None: with DbTxn('', self) as trans: msg = self.__remove_parent_from_family(person_handle, family_handle, trans) trans.set_description(msg) else: msg = self.__remove_parent_from_family(person_handle, family_handle, trans) trans.set_description(msg)
def __remove_parent_from_family(self, person_handle, family_handle, trans): """ Remove a person as either the father or mother of a family, deleting the family if it becomes empty; trans is compulsory. """ person = self.get_person_from_handle(person_handle) family = self.get_family_from_handle(family_handle) person.remove_family_handle(family_handle) if family.get_father_handle() == person_handle: family.set_father_handle(None) msg = _("Remove father from family") elif family.get_mother_handle() == person_handle: msg = _("Remove mother from family") family.set_mother_handle(None) else: raise DbTransactionCancel("The relation between the person and " "the family you try to remove is not consistent, please fix " "that first, for example from the family editor or by running " "the database repair tool, before removing the family.") if (not family.get_father_handle() and not family.get_mother_handle() and not family.get_child_ref_list()): self.remove_family_relationships(family_handle, trans) else: self.commit_family(family, trans) self.commit_person(person, trans) return msg
[docs] def marriage_from_eventref_list(self, eventref_list): """ Get the marriage event from an eventref list. """ for eventref in eventref_list: event = self.get_event_from_handle(eventref.ref) if event and event.type.is_marriage(): return event return None
[docs] def get_total(self): """ Get the total of primary objects. """ person_len = self.get_number_of_people() family_len = self.get_number_of_families() event_len = self.get_number_of_events() source_len = self.get_number_of_sources() place_len = self.get_number_of_places() repo_len = self.get_number_of_repositories() obj_len = self.get_number_of_media_objects() return person_len + family_len + event_len + \ place_len + source_len + obj_len + repo_len
[docs] def set_birth_death_index(self, person): """ Set the birth and death indices for a person. """ birth_ref_index = -1 death_ref_index = -1 event_ref_list = person.get_event_ref_list() for index in range(len(event_ref_list)): ref = event_ref_list[index] event = self.get_event_from_handle(ref.ref) if (event.type.is_birth() and ref.role.is_primary() and (birth_ref_index == -1)): birth_ref_index = index elif (event.type.is_death() and ref.role.is_primary() and (death_ref_index == -1)): death_ref_index = index person.birth_ref_index = birth_ref_index person.death_ref_index = death_ref_index