2007-10-08 Don Allingham <don@gramps-project.org>

* various: gen.lib integration. probably touches almost every file

	* various: gen.utils integration


svn: r9101

src/gen/lib/childref.py

@@ -0,0 +1,150 @@
+#
+# Gramps - a GTK+/GNOME based genealogy program
+#
+# Copyright (C) 2006-2007  Donald N. Allingham
+#
+# 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.
+"""
+
+__revision__ = "$Revision$"
+
+from types import InstanceType
+
+#-------------------------------------------------------------------------
+#
+# GRAMPS modules
+#
+#-------------------------------------------------------------------------
+from secondaryobj import SecondaryObject
+from privacybase import PrivacyBase
+from srcbase import SourceBase
+from notebase import NoteBase
+from refbase import RefBase
+from childreftype import ChildRefType
+
+#-------------------------------------------------------------------------
+#
+# 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):
+        """
+        Converts 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):
+        """
+        Converts 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 = InstanceType(ChildRefType)
+        self.frel.unserialize(frel)
+        self.mrel = InstanceType(ChildRefType)
+        self.mrel.unserialize(mrel)
+        return self
+
+    def get_text_data_list(self):
+        """
+        Returns the list of all textual attributes of the object.
+
+        @return: 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):
+        """
+        Returns the list of child objects that may carry textual data.
+
+        @return: Returns the list of child objects that may carry textual data.
+        @rtype: list
+        """
+        return self.source_list
+
+    def get_referenced_handles(self):
+        """
+        Returns the list of (classname,handle) tuples for all directly
+        referenced primary objects.
+        
+        @return: 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):
+        """
+        Returns the list of child objects which may, directly or through
+        their children, reference primary objects..
+        
+        @return: Returns the list of objects refereincing primary objects.
+        @rtype: list
+        """
+        return self.source_list
+
+    def set_mother_relation(self, rel):
+        """Sets relation between the person and mother"""
+        self.mrel.set(rel)
+
+    def get_mother_relation(self):
+        """Returns the relation between the person and mother"""
+        return self.mrel
+
+    def set_father_relation(self, frel):
+        """Sets relation between the person and father"""
+        self.frel.set(frel)
+
+    def get_father_relation(self):
+        """Returns the relation between the person and father"""
+        return self.frel