6da4a00375
Back-port my work on this bug from gramps40. Unfortunately, the tests on gramps34 still fail (they pass on gramps40/trunk), but the repro steps marked by Nick in the bug succeed, so I shall stop here :) svn: r22965
286 lines
10 KiB
Python
286 lines
10 KiB
Python
#
|
|
# 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$
|
|
|
|
"""
|
|
Citation object for GRAMPS.
|
|
"""
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# standard python modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
import logging
|
|
LOG = logging.getLogger(".citation")
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GRAMPS modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
from gen.lib.primaryobj import PrimaryObject
|
|
from gen.lib.mediabase import MediaBase
|
|
from gen.lib.notebase import NoteBase
|
|
from gen.lib.datebase import DateBase
|
|
from gen.lib.citationbase import IndirectCitationBase
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Citation class
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class Citation(MediaBase, NoteBase, IndirectCitationBase,
|
|
PrimaryObject, DateBase):
|
|
"""
|
|
A record of a citation of a source of information.
|
|
|
|
In GEDCOM this is called a SOURCE_CITATION.
|
|
The data provided in the <<SOURCE_CITATION>> structure is source-related
|
|
information specific to the data being cited.
|
|
"""
|
|
|
|
CONF_VERY_HIGH = 4
|
|
CONF_HIGH = 3
|
|
CONF_NORMAL = 2
|
|
CONF_LOW = 1
|
|
CONF_VERY_LOW = 0
|
|
|
|
def __init__(self):
|
|
"""Create a new Citation instance."""
|
|
PrimaryObject.__init__(self)
|
|
MediaBase.__init__(self) # 7
|
|
NoteBase.__init__(self) # 6
|
|
DateBase.__init__(self) # 2
|
|
self.source_handle = None # 5
|
|
self.page = "" # 3
|
|
self.confidence = Citation.CONF_NORMAL # 4
|
|
self.datamap = {} # 8
|
|
|
|
def serialize(self, no_text_date = False):
|
|
"""
|
|
Convert the object to a serialized tuple of data.
|
|
"""
|
|
return (self.handle, # 0
|
|
self.gramps_id, # 1
|
|
DateBase.serialize(self, no_text_date),# 2
|
|
unicode(self.page), # 3
|
|
self.confidence, # 4
|
|
self.source_handle, # 5
|
|
NoteBase.serialize(self), # 6
|
|
MediaBase.serialize(self), # 7
|
|
self.datamap, # 8
|
|
self.change, # 9
|
|
self.private) # 10
|
|
|
|
def unserialize(self, data):
|
|
"""
|
|
Convert the data held in a tuple created by the serialize method
|
|
back into the data in a Citation structure.
|
|
"""
|
|
(self.handle, # 0
|
|
self.gramps_id, # 1
|
|
date, # 2
|
|
self.page, # 3
|
|
self.confidence, # 4
|
|
self.source_handle, # 5
|
|
note_list, # 6
|
|
media_list, # 7
|
|
self.datamap, # 8
|
|
self.change, # 9
|
|
self.private # 10
|
|
) = data
|
|
|
|
DateBase.unserialize(self, date)
|
|
NoteBase.unserialize(self, note_list)
|
|
MediaBase.unserialize(self, media_list)
|
|
return self
|
|
|
|
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 == 'Note':
|
|
return handle in [ref.ref for ref in self.note_list]
|
|
elif classname == 'Media':
|
|
return handle in [ref.ref for ref in self.media_list]
|
|
elif classname == 'Source':
|
|
return handle == self.get_reference_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 == 'Source' and \
|
|
self.get_reference_handle() in handle_list:
|
|
self.set_reference_handle(None)
|
|
|
|
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 == 'Source' and \
|
|
self.get_reference_handle() == old_handle:
|
|
self.set_reference_handle(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.page,
|
|
self.gramps_id] + self.datamap.keys() + self.datamap.values()
|
|
|
|
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
|
|
|
|
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
|
|
|
|
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.media_list
|
|
|
|
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.media_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.get_reference_handle():
|
|
ret += [('Source', self.get_reference_handle())]
|
|
return ret
|
|
|
|
def merge(self, acquisition):
|
|
"""
|
|
Merge the content of acquisition into this source.
|
|
|
|
:param acquisition: The source to merge with the present source.
|
|
:rtype acquisition: Source
|
|
"""
|
|
self._merge_privacy(acquisition)
|
|
self._merge_note_list(acquisition)
|
|
self._merge_media_list(acquisition)
|
|
# merge confidence
|
|
level_priority = [0, 4, 1, 3, 2]
|
|
idx = min(level_priority.index(self.confidence),
|
|
level_priority.index(acquisition.confidence))
|
|
self.confidence = level_priority[idx]
|
|
my_datamap = self.get_data_map()
|
|
acquisition_map = acquisition.get_data_map()
|
|
for key in acquisition.get_data_map():
|
|
if key not in my_datamap:
|
|
self.datamap[key] = acquisition_map[key]
|
|
# N.B. a Citation can refer to only one 'Source', so the
|
|
# 'Source' from acquisition cannot be merged in
|
|
|
|
def get_data_map(self):
|
|
"""Return the data map of attributes for the source."""
|
|
return self.datamap
|
|
|
|
def set_data_map(self, datamap):
|
|
"""Set the data map of attributes for the source."""
|
|
self.datamap = datamap
|
|
|
|
def set_data_item(self, key, value):
|
|
"""Set the particular data item in the attribute data map."""
|
|
self.datamap[key] = value
|
|
|
|
def set_confidence_level(self, val):
|
|
"""Set the confidence level."""
|
|
self.confidence = val
|
|
|
|
def get_confidence_level(self):
|
|
"""Return the confidence level."""
|
|
return self.confidence
|
|
|
|
def set_page(self, page):
|
|
"""Set the page indicator of the Citation."""
|
|
self.page = page
|
|
|
|
def get_page(self):
|
|
"""Get the page indicator of the Citation."""
|
|
return self.page
|
|
|
|
def set_reference_handle(self, val):
|
|
self.source_handle = val
|
|
|
|
def get_reference_handle(self):
|
|
return self.source_handle
|