# # Gramps - a GTK+/GNOME based genealogy program # # Copyright (C) 2000-2007 Donald N. Allingham # Copyright (C) 2010 Michiel D. Nauta # 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # # $Id$ """ Event Reference class for GRAMPS """ #------------------------------------------------------------------------- # # GRAMPS modules # #------------------------------------------------------------------------- from gen.lib.secondaryobj import SecondaryObject from gen.lib.privacybase import PrivacyBase from gen.lib.notebase import NoteBase from gen.lib.attrbase import AttributeBase from gen.lib.refbase import RefBase from gen.lib.eventroletype import EventRoleType from gen.lib.const import IDENTICAL, EQUAL, DIFFERENT #------------------------------------------------------------------------- # # Event References for Person/Family # #------------------------------------------------------------------------- class EventRef(SecondaryObject, PrivacyBase, NoteBase, AttributeBase, RefBase): """ Event reference class. This class is for keeping information about how the person relates to the referenced event. """ def __init__(self, source=None): """ Create a new EventRef instance, copying from the source if present. """ PrivacyBase.__init__(self, source) NoteBase.__init__(self, source) AttributeBase.__init__(self, source) RefBase.__init__(self, source) if source: self.__role = EventRoleType(source.__role) else: self.__role = EventRoleType() def serialize(self): """ Convert the object to a serialized tuple of data. """ return ( PrivacyBase.serialize(self), NoteBase.serialize(self), AttributeBase.serialize(self), RefBase.serialize(self), self.__role.serialize() ) def unserialize(self, data): """ Convert a serialized tuple of data to an object. """ (privacy, note_list, attribute_list, ref, role) = data PrivacyBase.unserialize(self, privacy) NoteBase.unserialize(self, note_list) AttributeBase.unserialize(self, attribute_list) RefBase.unserialize(self, ref) self.__role = EventRoleType() self.__role.unserialize(role) return self def get_text_data_list(self): """ Return the list of all textual attributes of the object. :returns: Returns the list of all textual attributes of the object. :rtype: list """ return [self.__role.string] def get_text_data_child_list(self): """ Return the list of child objects that may carry textual data. :returns: Returns the list of child objects that may carry textual data. :rtype: list """ return self.attribute_list def get_citation_child_list(self): """ Return the list of child secondary objects that may refer citations. :returns: Returns the list of child secondary child objects that may refer citations. :rtype: list """ return self.attribute_list def get_note_child_list(self): """ Return the list of child secondary objects that may refer notes. :returns: Returns the list of child secondary child objects that may refer notes. :rtype: list """ return self.attribute_list def get_referenced_handles(self): """ Return the list of (classname, handle) tuples for all directly referenced primary objects. :returns: Returns the list of (classname, handle) tuples for referenced objects. :rtype: list """ ret = self.get_referenced_note_handles() if self.ref: ret += [('Event', self.ref)] return ret def get_handle_referents(self): """ Return the list of child objects which may, directly or through their children, reference primary objects.. :returns: Returns the list of objects referencing primary objects. :rtype: list """ return self.get_citation_child_list() def has_citation_reference(self, citation_handle) : """ Return True if any of the child objects has reference to this citation handle. :param citation_handle: The citation handle to be checked. :type citation_handle: str :returns: Returns whether any of it's child objects has reference to this citation handle. :rtype: bool """ for item in self.get_citation_child_list(): if item.has_citation_reference(citation_handle): return True return False def remove_citation_references(self, citation_handle_list): """ Remove references to all citation handles in the list in all child objects. :param citation_handle_list: The list of citation handles to be removed. :type citation_handle_list: list """ for item in self.get_citation_child_list(): item.remove_citation_references(citation_handle_list) def replace_citation_references(self, old_handle, new_handle): """ Replace references to citation handles in the list in this object and all child objects and merge equivalent entries. :param old_handle: The citation handle to be replaced. :type old_handle: str :param new_handle: The citation handle to replace the old one with. :type new_handle: str """ for item in self.get_citation_child_list(): item.replace_citation_references(old_handle, new_handle) def is_equivalent(self, other): """ Return if this eventref is equivalent, that is agrees in handle and role, to other. :param other: The eventref to compare this one to. :rtype other: EventRef :returns: Constant indicating degree of equivalence. :rtype: int """ if self.ref != other.ref or self.role != other.role: return DIFFERENT else: if self.is_equal(other): return IDENTICAL else: return EQUAL def merge(self, acquisition): """ Merge the content of acquisition into this eventref. Lost: hlink and role of acquisition. :param acquisition: The eventref to merge with the present eventref. :param acquisition: EventRef """ self._merge_privacy(acquisition) self._merge_attribute_list(acquisition) self._merge_note_list(acquisition) def get_role(self): """ Return the tuple corresponding to the preset role. """ return self.__role def set_role(self, role): """ Set the role according to the given argument. """ self.__role.set(role) role = property(get_role, set_role, None, 'Returns or sets role property')