335 lines
11 KiB
Python
335 lines
11 KiB
Python
#
|
|
# Gramps - a GTK+/GNOME based genealogy program
|
|
#
|
|
# Copyright (C) 2000-2007 Donald N. Allingham
|
|
# Copyright (C) 2010 Michiel D. Nauta
|
|
#
|
|
# 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 object for GRAMPS.
|
|
"""
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GRAMPS modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
from gen.lib.primaryobj import PrimaryObject
|
|
from gen.lib.srcbase import SourceBase
|
|
from gen.lib.notebase import NoteBase
|
|
from gen.lib.mediabase import MediaBase
|
|
from gen.lib.attrbase import AttributeBase
|
|
from gen.lib.datebase import DateBase
|
|
from gen.lib.placebase import PlaceBase
|
|
from gen.lib.eventtype import EventType
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Event class
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class Event(SourceBase, NoteBase, MediaBase, AttributeBase,
|
|
DateBase, PlaceBase, PrimaryObject):
|
|
"""
|
|
The Event record is used to store information about some type of
|
|
action that occurred at a particular place at a particular time,
|
|
such as a birth, death, or marriage.
|
|
|
|
A possible definition: Events are things that happen at some point in time
|
|
(that we may not know precisely, though), at some place, may involve
|
|
several people (witnesses, officers, notaries, priests, etc.) and may
|
|
of course have sources, notes, media, etc.
|
|
Compare this with attribute: :class:`~gen.lib.attribute.Attribute`
|
|
"""
|
|
|
|
def __init__(self, source=None):
|
|
"""
|
|
Create a new Event instance, copying from the source if present.
|
|
|
|
:param source: An event used to initialize the new event
|
|
:type source: Event
|
|
"""
|
|
|
|
PrimaryObject.__init__(self, source)
|
|
SourceBase.__init__(self, source)
|
|
NoteBase.__init__(self, source)
|
|
MediaBase.__init__(self, source)
|
|
AttributeBase.__init__(self)
|
|
DateBase.__init__(self, source)
|
|
PlaceBase.__init__(self, source)
|
|
|
|
if source:
|
|
self.__description = source.__description
|
|
self.__type = source.__type
|
|
else:
|
|
self.__description = ""
|
|
self.__type = EventType()
|
|
|
|
def serialize(self, no_text_date = False):
|
|
"""
|
|
Convert the data held in the event to a Python tuple that
|
|
represents all the data elements.
|
|
|
|
This method is used to convert the object into a form that can easily
|
|
be saved to a database.
|
|
|
|
These elements may be primitive Python types (string, integers),
|
|
complex Python types (lists or tuples, or Python objects. If the
|
|
target database cannot handle complex types (such as objects or
|
|
lists), the database is responsible for converting the data into
|
|
a form that it can use.
|
|
|
|
:returns: Returns a python tuple containing the data that should
|
|
be considered persistent.
|
|
:rtype: tuple
|
|
"""
|
|
return (self.handle, self.gramps_id, self.__type.serialize(),
|
|
DateBase.serialize(self, no_text_date),
|
|
self.__description, self.place,
|
|
SourceBase.serialize(self),
|
|
NoteBase.serialize(self),
|
|
MediaBase.serialize(self),
|
|
AttributeBase.serialize(self),
|
|
self.change, self.private)
|
|
|
|
def unserialize(self, data):
|
|
"""
|
|
Convert the data held in a tuple created by the serialize method
|
|
back into the data in an Event structure.
|
|
|
|
:param data: tuple containing the persistent data associated the
|
|
Person object
|
|
:type data: tuple
|
|
"""
|
|
(self.handle, self.gramps_id, the_type, date,
|
|
self.__description, self.place,
|
|
source_list, note_list, media_list, attribute_list,
|
|
self.change, self.private) = data
|
|
|
|
self.__type = EventType()
|
|
self.__type.unserialize(the_type)
|
|
DateBase.unserialize(self, date)
|
|
MediaBase.unserialize(self, media_list)
|
|
AttributeBase.unserialize(self, attribute_list)
|
|
SourceBase.unserialize(self, source_list)
|
|
NoteBase.unserialize(self, note_list)
|
|
|
|
def _has_handle_reference(self, classname, handle):
|
|
"""
|
|
Return True if the object has reference to a given handle of given
|
|
primary object type.
|
|
|
|
:param classname: The name of the primary object class.
|
|
:type classname: str
|
|
:param handle: The handle to be checked.
|
|
:type handle: str
|
|
:returns: Returns whether the object has reference to this handle of
|
|
this object type.
|
|
:rtype: bool
|
|
"""
|
|
if classname == 'Place':
|
|
return self.place == handle
|
|
return False
|
|
|
|
def _remove_handle_references(self, classname, handle_list):
|
|
"""
|
|
Remove all references in this object to object handles in the list.
|
|
|
|
:param classname: The name of the primary object class.
|
|
:type classname: str
|
|
:param handle_list: The list of handles to be removed.
|
|
:type handle_list: str
|
|
"""
|
|
if classname == 'Place' and self.place in handle_list:
|
|
self.place = ""
|
|
|
|
def _replace_handle_reference(self, classname, old_handle, new_handle):
|
|
"""
|
|
Replace all references to old handle with those to the new handle.
|
|
|
|
:param classname: The name of the primary object class.
|
|
:type classname: str
|
|
:param old_handle: The handle to be replaced.
|
|
:type old_handle: str
|
|
:param new_handle: The handle to replace the old one with.
|
|
:type new_handle: str
|
|
"""
|
|
if classname == 'Place' and self.place == old_handle:
|
|
self.place = new_handle
|
|
|
|
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.__description, str(self.__type), self.gramps_id]
|
|
|
|
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.media_list + self.source_list + self.attribute_list
|
|
|
|
def get_sourcref_child_list(self):
|
|
"""
|
|
Return the list of child secondary objects that may refer sources.
|
|
|
|
:returns: Returns the list of child secondary child objects that may
|
|
refer sources.
|
|
:rtype: list
|
|
"""
|
|
return self.media_list + 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.media_list + self.attribute_list + self.source_list
|
|
|
|
def get_referenced_handles(self):
|
|
"""
|
|
Return the list of (classname, handle) tuples for all directly
|
|
referenced primary objects.
|
|
|
|
:returns: List of (classname, handle) tuples for referenced objects.
|
|
:rtype: list
|
|
"""
|
|
ret = self.get_referenced_note_handles()
|
|
if self.place:
|
|
ret.append(('Place', self.place))
|
|
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_sourcref_child_list() + self.source_list
|
|
|
|
def is_empty(self):
|
|
"""
|
|
Return True if the Event is an empty object (no values set).
|
|
|
|
:returns: True if the Event is empty
|
|
:rtype: bool
|
|
"""
|
|
date = self.get_date_object()
|
|
place = self.get_place_handle()
|
|
description = self.__description
|
|
the_type = self.__type
|
|
return (the_type == EventType.CUSTOM and date.is_empty()
|
|
and not place and not description)
|
|
|
|
def are_equal(self, other):
|
|
"""
|
|
Return True if the passed Event is equivalent to the current Event.
|
|
|
|
:param other: Event to compare against
|
|
:type other: Event
|
|
:returns: True if the Events are equal
|
|
:rtype: bool
|
|
"""
|
|
if other is None:
|
|
other = Event (None)
|
|
|
|
if self.__type != other.__type or \
|
|
((self.place or other.place) and (self.place != other.place)) or \
|
|
self.__description != other.__description \
|
|
or self.private != other.private or \
|
|
(not self.get_date_object().is_equal(other.get_date_object())) or \
|
|
len(self.get_source_references()) != len(other.get_source_references()):
|
|
return False
|
|
|
|
index = 0
|
|
olist = other.get_source_references()
|
|
for a in self.get_source_references():
|
|
if not a.is_equal(olist[index]):
|
|
return False
|
|
index += 1
|
|
|
|
return True
|
|
|
|
def merge(self, acquisition):
|
|
"""
|
|
Merge the content of acquisition into this event.
|
|
|
|
Lost: handle, id, marker, type, date, place, description of acquisition.
|
|
|
|
:param acquisition: The event to merge with the present event.
|
|
:rtype acquisition: Event
|
|
"""
|
|
self._merge_privacy(acquisition)
|
|
self._merge_attribute_list(acquisition)
|
|
self._merge_note_list(acquisition)
|
|
self._merge_source_reference_list(acquisition)
|
|
self._merge_media_list(acquisition)
|
|
|
|
def set_type(self, the_type):
|
|
"""
|
|
Set the type of the Event to the passed (int,str) tuple.
|
|
|
|
:param the_type: Type to assign to the Event
|
|
:type the_type: tuple
|
|
"""
|
|
self.__type.set(the_type)
|
|
|
|
def get_type(self):
|
|
"""
|
|
Return the type of the Event.
|
|
|
|
:returns: Type of the Event
|
|
:rtype: tuple
|
|
"""
|
|
return self.__type
|
|
type = property(get_type, set_type, None, 'Returns or sets type of the event')
|
|
|
|
def set_description(self, description):
|
|
"""
|
|
Set the description of the Event to the passed string.
|
|
|
|
The string may contain any information.
|
|
|
|
:param description: Description to assign to the Event
|
|
:type description: str
|
|
"""
|
|
self.__description = description
|
|
|
|
def get_description(self) :
|
|
"""
|
|
Return the description of the Event.
|
|
|
|
:returns: Returns the description of the Event
|
|
:rtype: str
|
|
"""
|
|
return self.__description
|
|
description = property(get_description, set_description, None, 'Returns or sets description of the event')
|
|
|