* src/RelLib/__init__.py: More breaking up in RelLib;

* src/RelLib/Makefile.am: Ship new files;
* src/RelLib/ various files: add more files.


svn: r5593

gramps2/src/RelLib/_Repository.py

@@ -0,0 +1,175 @@
+#
+# Gramps - a GTK+/GNOME based genealogy program
+#
+# Copyright (C) 2000-2005  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$
+
+"""
+Repository object for GRAMPS
+"""
+
+#-------------------------------------------------------------------------
+#
+# standard python modules
+#
+#-------------------------------------------------------------------------
+from warnings import warn
+
+#-------------------------------------------------------------------------
+#
+# GRAMPS modules
+#
+#-------------------------------------------------------------------------
+from _PrimaryObject import PrimaryObject
+from _NoteBase import NoteBase
+from _AddressBase import AddressBase
+from _UrlBase import UrlBase
+
+#-------------------------------------------------------------------------
+#
+# Repository class
+#
+#-------------------------------------------------------------------------
+class Repository(PrimaryObject,NoteBase,AddressBase,UrlBase):
+    """A location where collections of Sources are found"""
+    
+    UNKNOWN    = -1
+    CUSTOM     = 0
+    LIBRARY    = 1
+    CEMETERY   = 2
+    CHURCH     = 3
+    ARCHIVE    = 4
+    ALBUM      = 5
+    WEBSITE    = 6
+    BOOKSTORE  = 7
+    COLLECTION = 8
+    SAFE       = 9
+    
+    def __init__(self):
+        """creates a new Repository instance"""
+        PrimaryObject.__init__(self)
+        NoteBase.__init__(self)
+        AddressBase.__init__(self)
+        UrlBase.__init__(self)
+        self.type = (Repository.LIBRARY,"")
+        self.name = ""
+
+    def serialize(self):
+        return (self.handle, self.gramps_id, self.type, unicode(self.name),
+                self.note, self.address_list, self.urls,self.marker,
+                self.private)
+
+    def unserialize(self,data):
+        """
+        Converts the data held in a tuple created by the serialize method
+        back into the data in an Repository structure.
+        """
+        (self.handle, self.gramps_id, self.type, self.name, self.note,
+         self.address_list, self.urls ,self.marker, self.private) = data
+        
+    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 [self.name,self.type[1]]
+
+    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
+        """
+        check_list = self.address_list + self.urls
+        if self.note:
+            check_list.append(self.note)
+        return check_list
+
+    def has_source_reference(self,src_handle) :
+        """
+        Returns True if any of the child objects has reference
+        to this source handle.
+
+        @param src_handle: The source handle to be checked.
+        @type src_handle: str
+        @return: Returns whether any of it's child objects has reference to this source handle.
+        @rtype: bool
+        """
+        return False
+
+    def remove_source_references(self,src_handle_list):
+        """
+        Removes references to all source handles in the list
+        in all child objects.
+
+        @param src_handle_list: The list of source handles to be removed.
+        @type src_handle_list: list
+        """
+        pass
+
+    def replace_source_references(self,old_handle,new_handle):
+        """
+        Replaces references to source handles in the list
+        in this object and all child objects.
+
+        @param old_handle: The source handle to be replaced.
+        @type old_handle: str
+        @param new_handle: The source handle to replace the old one with.
+        @type new_handle: str
+        """
+        pass
+
+    def set_type(self,the_type):
+        """
+        @param type: descriptive type of the Repository
+        @type type: str
+        """
+        if not type(the_type) == tuple:
+            warn( "set_type now takes a tuple", DeprecationWarning, 2)
+            # Wrapper for old API
+            # remove when transitition done.
+            if the_type in range(-1,10):
+                the_type = (the_type,'')
+            else:
+                the_type = (Repository.CUSTOM,the_type)
+        self.type = the_type
+
+    def get_type(self):
+        """
+        @returns: the descriptive type of the Repository
+        @rtype: str
+        """
+        return self.type
+
+    def set_name(self,name):
+        """
+        @param name: descriptive name of the Repository
+        @type name: str
+        """
+        self.name = name
+
+    def get_name(self):
+        """
+        @returns: the descriptive name of the Repository
+        @rtype: str
+        """
+        return self.name