491 lines
18 KiB
Python
491 lines
18 KiB
Python
#
|
|
# Gramps - a GTK+/GNOME based genealogy program
|
|
#
|
|
# Copyright (C) 2000-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$
|
|
|
|
"""
|
|
Family object for GRAMPS.
|
|
"""
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# standard python modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
from warnings import warn
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GRAMPS modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
from gen.lib.primaryobj import PrimaryObject
|
|
from gen.lib.srcbase import SourceBase
|
|
from gen.lib.notebase import NoteBase
|
|
from gen.lib.mediabase import MediaBase
|
|
from gen.lib.attrbase import AttributeBase
|
|
from gen.lib.eventref import EventRef
|
|
from gen.lib.ldsordbase import LdsOrdBase
|
|
from gen.lib.childref import ChildRef
|
|
from gen.lib.familyreltype import FamilyRelType
|
|
from gen.lib.markertype import MarkerType
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Family class
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class Family(SourceBase, NoteBase, MediaBase, AttributeBase, LdsOrdBase,
|
|
PrimaryObject):
|
|
"""
|
|
Introduction
|
|
============
|
|
The Family record is the GRAMPS in-memory representation of the
|
|
relationships between people. It contains all the information
|
|
related to the relationship.
|
|
|
|
Usage
|
|
=====
|
|
Family objects are usually created in one of two ways.
|
|
|
|
1. Creating a new Family object, which is then initialized and
|
|
added to the database.
|
|
2. Retrieving an object from the database using the records
|
|
handle.
|
|
|
|
Once a Family object has been modified, it must be committed
|
|
to the database using the database object's commit_family function,
|
|
or the changes will be lost.
|
|
"""
|
|
|
|
def __init__(self):
|
|
"""
|
|
Create a new Family instance.
|
|
|
|
After initialization, most data items have empty or null values,
|
|
including the database handle.
|
|
"""
|
|
PrimaryObject.__init__(self)
|
|
SourceBase.__init__(self)
|
|
NoteBase.__init__(self)
|
|
MediaBase.__init__(self)
|
|
AttributeBase.__init__(self)
|
|
LdsOrdBase.__init__(self)
|
|
self.father_handle = None
|
|
self.mother_handle = None
|
|
self.child_ref_list = []
|
|
self.type = FamilyRelType()
|
|
self.event_ref_list = []
|
|
self.complete = 0
|
|
|
|
def serialize(self):
|
|
"""
|
|
Convert the data held in the event to a Python tuple that
|
|
represents all the data elements.
|
|
|
|
This method is used to convert the object into a form that can easily
|
|
be saved to a database.
|
|
|
|
These elements may be primative Python types (string, integers),
|
|
complex Python types (lists or tuples, or Python objects. If the
|
|
target database cannot handle complex types (such as objectes or
|
|
lists), the database is responsible for converting the data into
|
|
a form that it can use.
|
|
|
|
@returns: Returns a python tuple containing the data that should
|
|
be considered persistent.
|
|
@rtype: tuple
|
|
"""
|
|
return (self.handle, self.gramps_id, self.father_handle,
|
|
self.mother_handle,
|
|
[cr.serialize() for cr in self.child_ref_list],
|
|
self.type.serialize(),
|
|
[er.serialize() for er in self.event_ref_list],
|
|
MediaBase.serialize(self),
|
|
AttributeBase.serialize(self),
|
|
LdsOrdBase.serialize(self),
|
|
SourceBase.serialize(self),
|
|
NoteBase.serialize(self),
|
|
self.change, self.marker.serialize(), self.private)
|
|
|
|
def unserialize(self, data):
|
|
"""
|
|
Convert the data held in a tuple created by the serialize method
|
|
back into the data in a Family structure.
|
|
"""
|
|
(self.handle, self.gramps_id, self.father_handle, self.mother_handle,
|
|
child_ref_list, the_type, event_ref_list, media_list,
|
|
attribute_list, lds_seal_list, source_list, note_list,
|
|
self.change, marker, self.private) = data
|
|
|
|
self.marker = MarkerType()
|
|
self.marker.unserialize(marker)
|
|
self.type = FamilyRelType()
|
|
self.type.unserialize(the_type)
|
|
self.event_ref_list = [EventRef().unserialize(er)
|
|
for er in event_ref_list]
|
|
self.child_ref_list = [ChildRef().unserialize(cr)
|
|
for cr in child_ref_list]
|
|
MediaBase.unserialize(self, media_list)
|
|
AttributeBase.unserialize(self, attribute_list)
|
|
SourceBase.unserialize(self, source_list)
|
|
NoteBase.unserialize(self, note_list)
|
|
LdsOrdBase.unserialize(self, lds_seal_list)
|
|
|
|
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
|
|
@return: Returns whether the object has reference to this handle of
|
|
this object type.
|
|
@rtype: bool
|
|
"""
|
|
if classname == 'Event':
|
|
return handle in [ref.ref for ref in self.event_ref_list]
|
|
elif classname == 'Person':
|
|
return handle in ([ref.ref for ref in self.child_ref_list]
|
|
+ [self.father_handle, self.mother_handle])
|
|
elif classname == 'Place':
|
|
return handle in [ x.place for x in self.lds_ord_list ]
|
|
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 == 'Event':
|
|
new_list = [ ref for ref in self.event_ref_list \
|
|
if ref.ref not in handle_list ]
|
|
self.event_ref_list = new_list
|
|
elif classname == 'Person':
|
|
new_list = [ ref for ref in self.child_ref_list \
|
|
if ref.ref not in handle_list ]
|
|
self.child_ref_list = new_list
|
|
if self.father_handle in handle_list:
|
|
self.father_handle = None
|
|
if self.mother_handle in handle_list:
|
|
self.mother_handle = None
|
|
elif classname == 'Place':
|
|
for x in self.lds_ord_list:
|
|
if x.place in handle_list:
|
|
x.place = 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 == 'Event':
|
|
handle_list = [ref.ref for ref in self.event_ref_list]
|
|
while old_handle in handle_list:
|
|
ix = handle_list.index(old_handle)
|
|
self.event_ref_list[ix].ref = new_handle
|
|
handle_list[ix] = ''
|
|
elif classname == 'Person':
|
|
handle_list = [ref.ref for ref in self.child_ref_list]
|
|
while old_handle in handle_list:
|
|
ix = handle_list.index(old_handle)
|
|
self.child_ref_list[ix].ref = new_handle
|
|
handle_list[ix] = ''
|
|
if self.father_handle == old_handle:
|
|
self.father_handle = new_handle
|
|
if self.mother_handle == old_handle:
|
|
self.mother_handle = new_handle
|
|
elif classname == 'Place':
|
|
for x in self.lds_ord_list:
|
|
if x.place == old_handle:
|
|
x.place = new_handle
|
|
|
|
def get_text_data_list(self):
|
|
"""
|
|
Return the list of all textual attributes of the object.
|
|
|
|
@return: Returns the list of all textual attributes of the object.
|
|
@rtype: list
|
|
"""
|
|
return [self.gramps_id]
|
|
|
|
def get_text_data_child_list(self):
|
|
"""
|
|
Return the list of child objects that may carry textual data.
|
|
|
|
@return: Returns the list of child objects that may carry textual data.
|
|
@rtype: list
|
|
"""
|
|
add_list = [item for item in self.lds_ord_list if item]
|
|
return self.media_list + self.attribute_list + \
|
|
self.source_list + add_list
|
|
|
|
def get_sourcref_child_list(self):
|
|
"""
|
|
Return the list of child secondary objects that may refer sources.
|
|
|
|
@return: Returns the list of child secondary child objects that may
|
|
refer sources.
|
|
@rtype: list
|
|
"""
|
|
check_list = self.media_list + self.attribute_list + \
|
|
self.lds_ord_list + self.child_ref_list
|
|
return check_list
|
|
|
|
def get_note_child_list(self):
|
|
"""
|
|
Return the list of child secondary objects that may refer notes.
|
|
|
|
@return: Returns the list of child secondary child objects that may
|
|
refer notes.
|
|
@rtype: list
|
|
"""
|
|
check_list = self.media_list + self.attribute_list + \
|
|
self.lds_ord_list + self.child_ref_list + self.source_list
|
|
return check_list
|
|
|
|
def get_referenced_handles(self):
|
|
"""
|
|
Return 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()
|
|
ret += [('Event', ref.ref) for ref in self.event_ref_list]
|
|
ret += [('Person', handle) for handle
|
|
in ([ref.ref for ref in self.child_ref_list] +
|
|
[self.father_handle, self.mother_handle])
|
|
if handle]
|
|
return ret
|
|
|
|
def get_handle_referents(self):
|
|
"""
|
|
Return 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.get_sourcref_child_list() + self.source_list
|
|
|
|
def set_relationship(self, relationship_type):
|
|
"""
|
|
Set the relationship type between the people identified as the
|
|
father and mother in the relationship.
|
|
|
|
The type is a tuple whose first item is an integer constant and whose
|
|
second item is the string. The valid values are:
|
|
|
|
- C{FamilyRelType.MARRIED} : indicates a legally recognized married
|
|
relationship between two individuals. This may be either
|
|
an opposite or a same sex relationship.
|
|
- C{FamilyRelType.UNMARRIED} : indicates a relationship between two
|
|
individuals that is not a legally recognized relationship.
|
|
- C{FamilyRelType.CIVIL_UNION} : indicates a legally recongnized,
|
|
non-married relationship between two individuals of the
|
|
same sex.
|
|
- C{FamilyRelType.UNKNOWN} : indicates that the type of relationship
|
|
between the two individuals is not know.
|
|
- C{FamilyRelType.CUSTOM} : indicates that the type of relationship
|
|
between the two individuals does not match any of the
|
|
other types.
|
|
|
|
@param relationship_type: (int,str) tuple of the relationship type
|
|
between the father and mother of the relationship.
|
|
@type relationship_type: tuple
|
|
"""
|
|
self.type.set(relationship_type)
|
|
|
|
def get_relationship(self):
|
|
"""
|
|
Return the relationship type between the people identified as the
|
|
father and mother in the relationship.
|
|
"""
|
|
return self.type
|
|
|
|
def set_father_handle(self, person_handle):
|
|
"""
|
|
Set the database handle for L{Person} that corresponds to male of the
|
|
relationship.
|
|
|
|
For a same sex relationship, this can represent either of people
|
|
involved in the relationship.
|
|
|
|
@param person_handle: L{Person} database handle
|
|
@type person_handle: str
|
|
"""
|
|
self.father_handle = person_handle
|
|
|
|
def get_father_handle(self):
|
|
"""
|
|
Return the database handle of the L{Person} identified as the father
|
|
of the Family.
|
|
|
|
@returns: L{Person} database handle
|
|
@rtype: str
|
|
"""
|
|
return self.father_handle
|
|
|
|
def set_mother_handle(self, person_handle):
|
|
"""
|
|
Set the database handle for L{Person} that corresponds to male of the
|
|
relationship.
|
|
|
|
For a same sex relationship, this can represent either of people
|
|
involved in the relationship.
|
|
|
|
@param person_handle: L{Person} database handle
|
|
@type person_handle: str
|
|
"""
|
|
self.mother_handle = person_handle
|
|
|
|
def get_mother_handle(self):
|
|
"""
|
|
Return the database handle of the L{Person} identified as the mother
|
|
of the Family.
|
|
|
|
@returns: L{Person} database handle
|
|
@rtype: str
|
|
"""
|
|
return self.mother_handle
|
|
|
|
def add_child_ref(self, child_ref):
|
|
"""
|
|
Add the database handle for L{Person} to the Family's list of children.
|
|
|
|
@param child_ref: Child Reference instance
|
|
@type child_ref: ChildRef
|
|
"""
|
|
if not isinstance(child_ref, ChildRef):
|
|
raise ValueError("expecting ChildRef instance")
|
|
self.child_ref_list.append(child_ref)
|
|
|
|
def remove_child_ref(self, child_ref):
|
|
"""
|
|
Remove the database handle for L{Person} to the Family's list of
|
|
children if the L{Person} is already in the list.
|
|
|
|
@param child_ref: Child Reference instance
|
|
@type child_ref: ChildRef
|
|
@return: True if the handle was removed, False if it was not
|
|
in the list.
|
|
@rtype: bool
|
|
"""
|
|
if not isinstance(child_ref, ChildRef):
|
|
raise ValueError("expecting ChildRef instance")
|
|
new_list = [ref for ref in self.child_ref_list
|
|
if ref.ref != child_ref.ref ]
|
|
self.child_ref_list = new_list
|
|
|
|
def remove_child_handle(self, child_handle):
|
|
"""
|
|
Remove the database handle for L{Person} to the Family's list of
|
|
children if the L{Person} is already in the list.
|
|
|
|
@param child_handle: L{Person} database handle
|
|
@type child_handle: str
|
|
@return: True if the handle was removed, False if it was not
|
|
in the list.
|
|
@rtype: bool
|
|
"""
|
|
new_list = [ref for ref in self.child_ref_list
|
|
if ref.ref != child_handle ]
|
|
self.child_ref_list = new_list
|
|
|
|
def get_child_ref_list(self):
|
|
"""
|
|
Return the list of L{ChildRef} handles identifying the children of the
|
|
Family.
|
|
|
|
@return: Returns the list of L{ChildRef} handles assocated with
|
|
the Family.
|
|
@rtype: list
|
|
"""
|
|
return self.child_ref_list
|
|
|
|
def set_child_ref_list(self, child_ref_list):
|
|
"""
|
|
Assign the passed list to the Family's list children.
|
|
|
|
@param child_ref_list: List of Child Reference instances to be
|
|
associated as the Family's list of children.
|
|
@type child_ref_list: list of L{ChildRef} instances
|
|
"""
|
|
self.child_ref_list = child_ref_list
|
|
|
|
def add_event_ref(self, event_ref):
|
|
"""
|
|
Add the L{EventRef} to the Family instance's L{EventRef} list.
|
|
|
|
This is accomplished by assigning the L{EventRef} for the valid
|
|
L{Event}in the current database.
|
|
|
|
@param event_ref: the L{EventRef} to be added to the
|
|
Person's L{EventRef} list.
|
|
@type event_ref: EventRef
|
|
"""
|
|
if event_ref and not isinstance(event_ref, EventRef):
|
|
raise ValueError("Expecting EventRef instance")
|
|
self.event_ref_list.append(event_ref)
|
|
|
|
def get_event_list(self) :
|
|
warn( "Use get_event_ref_list instead of get_event_list",
|
|
DeprecationWarning, 2)
|
|
# Wrapper for old API
|
|
# remove when transitition done.
|
|
event_handle_list = []
|
|
for event_ref in self.get_event_ref_list():
|
|
event_handle_list.append( event_ref.get_reference_handle())
|
|
return event_handle_list
|
|
|
|
def get_event_ref_list(self) :
|
|
"""
|
|
Return the list of L{EventRef} objects associated with L{Event}
|
|
instances.
|
|
|
|
@returns: Returns the list of L{EventRef} objects associated with
|
|
the Family instance.
|
|
@rtype: list
|
|
"""
|
|
return self.event_ref_list
|
|
|
|
def set_event_ref_list(self, event_ref_list) :
|
|
"""
|
|
Set the Family instance's L{EventRef} list to the passed list.
|
|
|
|
@param event_ref_list: List of valid L{EventRef} objects
|
|
@type event_ref_list: list
|
|
"""
|
|
self.event_ref_list = event_ref_list
|