gramps/src/gen/lib/refbase.py
Raphael Ackermann c962d5e6e1 2008-02-22 Raphael Ackermann <raphael.ackermann@gmail.com>
* various (294 files)
	pep8 doc fixes & pylint fixes

svn: r10103
2008-02-24 13:55:55 +00:00

74 lines
2.0 KiB
Python

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2006 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$
"""
Base Reference class for GRAMPS.
"""
#-------------------------------------------------------------------------
#
# RefBase class
#
#-------------------------------------------------------------------------
class RefBase:
"""
Base reference class to manage references to other objects.
Any *Ref class should derive from this class.
"""
def __init__(self, source=None):
if source:
self.ref = source.ref
else:
self.ref = None
def serialize(self):
"""
Convert the object to a serialized tuple of data.
"""
return self.ref
def unserialize(self, data):
"""
Convert a serialized tuple of data to an object.
"""
self.ref = str(data)
return self
def get_referenced_handles(self):
"""
Returns the list of (classname, handle) tuples for all directly
referenced primary objects.
@return: Returns the list of (classname, handle) tuples for referenced
objects.
@rtype: list
"""
assert False, "Must be overridden in the derived class"
def set_reference_handle(self, val):
self.ref = val
def get_reference_handle(self):
return self.ref