194 lines
6.3 KiB
Python
194 lines
6.3 KiB
Python
#
|
|
# Gramps - a GTK+/GNOME based genealogy program
|
|
#
|
|
# Copyright (C) 2006-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$
|
|
|
|
"""
|
|
Child Reference class for GRAMPS.
|
|
"""
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GRAMPS modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
from gen.lib.secondaryobj import SecondaryObject
|
|
from gen.lib.privacybase import PrivacyBase
|
|
from gen.lib.srcbase import SourceBase
|
|
from gen.lib.notebase import NoteBase
|
|
from gen.lib.refbase import RefBase
|
|
from gen.lib.childreftype import ChildRefType
|
|
from gen.lib.const import IDENTICAL, EQUAL, DIFFERENT
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Person References for Person/Family
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class ChildRef(SecondaryObject, PrivacyBase, SourceBase, NoteBase, RefBase):
|
|
"""
|
|
Person reference class.
|
|
|
|
This class is for keeping information about how the person relates
|
|
to another person from the database, if not through family.
|
|
Examples would be: godparent, friend, etc.
|
|
"""
|
|
|
|
def __init__(self, source=None):
|
|
PrivacyBase.__init__(self, source)
|
|
SourceBase.__init__(self, source)
|
|
NoteBase.__init__(self, source)
|
|
RefBase.__init__(self, source)
|
|
if source:
|
|
self.frel = source.frel
|
|
self.mrel = source.mrel
|
|
else:
|
|
self.frel = ChildRefType()
|
|
self.mrel = ChildRefType()
|
|
|
|
def serialize(self):
|
|
"""
|
|
Convert the object to a serialized tuple of data.
|
|
"""
|
|
return (PrivacyBase.serialize(self),
|
|
SourceBase.serialize(self),
|
|
NoteBase.serialize(self),
|
|
RefBase.serialize(self),
|
|
self.frel.serialize(),
|
|
self.mrel.serialize())
|
|
|
|
def unserialize(self, data):
|
|
"""
|
|
Convert a serialized tuple of data to an object.
|
|
"""
|
|
(privacy, source_list, note_list, ref, frel, mrel) = data
|
|
PrivacyBase.unserialize(self, privacy)
|
|
SourceBase.unserialize(self, source_list)
|
|
NoteBase.unserialize(self, note_list)
|
|
RefBase.unserialize(self, ref)
|
|
self.frel = ChildRefType()
|
|
self.frel.unserialize(frel)
|
|
self.mrel = ChildRefType()
|
|
self.mrel.unserialize(mrel)
|
|
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 [str(self.frel), str(self.mrel)]
|
|
|
|
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.source_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.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.ref:
|
|
ret += [('Person', 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.source_list
|
|
|
|
def is_equivalent(self, other):
|
|
"""
|
|
Return if this child reference is equivalent, that is agrees in hlink,
|
|
to other.
|
|
|
|
:param other: The childref to compare this one to.
|
|
:rtype other: ChildRef
|
|
:returns: Constant indicating degree of equivalence.
|
|
:rtype: int
|
|
"""
|
|
if self.ref != other.ref:
|
|
return DIFFERENT
|
|
else:
|
|
if self.is_equal(other):
|
|
return IDENTICAL
|
|
else:
|
|
return EQUAL
|
|
|
|
def merge(self, acquisition):
|
|
"""
|
|
Merge the content of acquisition into this child reference.
|
|
|
|
Lost: hlink, mrel and frel of acquisition.
|
|
|
|
:param acquisition: The childref to merge with the present childref.
|
|
:rtype acquisition: ChildRef
|
|
"""
|
|
self._merge_privacy(acquisition)
|
|
self._merge_note_list(acquisition)
|
|
self._merge_source_reference_list(acquisition)
|
|
if (self.mrel != acquisition.mrel) or (self.frel != acquisition.frel):
|
|
if self.mrel == ChildRefType.UNKNOWN:
|
|
self.set_mother_relation(acquisition.mrel)
|
|
if self.frel == ChildRefType.UNKNOWN:
|
|
self.set_father_relation(acquisition.frel)
|
|
|
|
def set_mother_relation(self, rel):
|
|
"""Set relation between the person and mother."""
|
|
self.mrel.set(rel)
|
|
|
|
def get_mother_relation(self):
|
|
"""Return the relation between the person and mother."""
|
|
return self.mrel
|
|
|
|
def set_father_relation(self, frel):
|
|
"""Set relation between the person and father."""
|
|
self.frel.set(frel)
|
|
|
|
def get_father_relation(self):
|
|
"""Return the relation between the person and father."""
|
|
return self.frel
|