242 lines
7.5 KiB
Python
242 lines
7.5 KiB
Python
#
|
|
# Gramps - a GTK+/GNOME based genealogy program
|
|
#
|
|
# Copyright (C) 2000-2007 Donald N. Allingham
|
|
# Copyright (C) 2010 Michiel D. Nauta
|
|
# Copyright (C) 2011 Tim G L Lyons
|
|
# Copyright (C) 2013 Doug Blank <doug.blank@gmail.com>
|
|
# Copyright (C) 2017 Nick Hall
|
|
#
|
|
# 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
#
|
|
|
|
"""
|
|
Event Reference class for Gramps
|
|
"""
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Gramps modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
from .secondaryobj import SecondaryObject
|
|
from .privacybase import PrivacyBase
|
|
from .notebase import NoteBase
|
|
from .attrbase import AttributeBase
|
|
from .refbase import RefBase
|
|
from .eventroletype import EventRoleType
|
|
from .const import IDENTICAL, EQUAL, DIFFERENT
|
|
from .citationbase import IndirectCitationBase
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Event References for Person/Family
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class EventRef(PrivacyBase, NoteBase, AttributeBase, RefBase,
|
|
IndirectCitationBase, SecondaryObject):
|
|
"""
|
|
Event reference class.
|
|
|
|
This class is for keeping information about how the person relates
|
|
to the referenced event.
|
|
"""
|
|
|
|
def __init__(self, source=None):
|
|
"""
|
|
Create a new EventRef instance, copying from the source if present.
|
|
"""
|
|
PrivacyBase.__init__(self, source)
|
|
NoteBase.__init__(self, source)
|
|
AttributeBase.__init__(self, source)
|
|
RefBase.__init__(self, source)
|
|
if source:
|
|
self.__role = EventRoleType(source.role)
|
|
else:
|
|
self.__role = EventRoleType()
|
|
|
|
def serialize(self):
|
|
"""
|
|
Convert the object to a serialized tuple of data.
|
|
"""
|
|
return (
|
|
PrivacyBase.serialize(self),
|
|
NoteBase.serialize(self),
|
|
AttributeBase.serialize(self),
|
|
RefBase.serialize(self),
|
|
self.__role.serialize()
|
|
)
|
|
|
|
@classmethod
|
|
def get_schema(cls):
|
|
"""
|
|
Returns the JSON Schema for this class.
|
|
|
|
:returns: Returns a dict containing the schema.
|
|
:rtype: dict
|
|
"""
|
|
from .attribute import Attribute
|
|
return {
|
|
"type": "object",
|
|
"properties": {
|
|
"_class": {"enum": [cls.__name__]},
|
|
"private": {"type": "boolean"},
|
|
"note_list": {"type": "array",
|
|
"items": {"type": "string",
|
|
"maxLength": 50}},
|
|
"attribute_list": {"type": "array",
|
|
"items": Attribute.get_schema()},
|
|
"ref": {"type": "string",
|
|
"maxLength": 50},
|
|
"role": EventRoleType.get_schema(),
|
|
}
|
|
}
|
|
|
|
@classmethod
|
|
def get_labels(cls, _):
|
|
"""
|
|
Given a translation function, returns the labels for
|
|
each field of this object.
|
|
|
|
:returns: Returns a dict containing the fields to labels.
|
|
:rtype: dict
|
|
"""
|
|
return {
|
|
"private": _("Private"),
|
|
"note_list": _("Notes"),
|
|
"attribute_list": _("Attributes"),
|
|
"ref": _("Event"),
|
|
"role": _("Role"),
|
|
}
|
|
|
|
def unserialize(self, data):
|
|
"""
|
|
Convert a serialized tuple of data to an object.
|
|
"""
|
|
(privacy, note_list, attribute_list, ref, role) = data
|
|
PrivacyBase.unserialize(self, privacy)
|
|
NoteBase.unserialize(self, note_list)
|
|
AttributeBase.unserialize(self, attribute_list)
|
|
RefBase.unserialize(self, ref)
|
|
self.__role = EventRoleType()
|
|
self.__role.unserialize(role)
|
|
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 [self.__role.string]
|
|
|
|
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.attribute_list
|
|
|
|
def get_citation_child_list(self):
|
|
"""
|
|
Return the list of child secondary objects that may refer citations.
|
|
|
|
:returns: Returns the list of child secondary child objects that may
|
|
refer citations.
|
|
:rtype: list
|
|
"""
|
|
return self.attribute_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.attribute_list
|
|
|
|
def get_referenced_handles(self):
|
|
"""
|
|
Return the list of (classname, handle) tuples for all directly
|
|
referenced primary objects.
|
|
|
|
:returns: Returns the list of (classname, handle) tuples for referenced
|
|
objects.
|
|
:rtype: list
|
|
"""
|
|
ret = self.get_referenced_note_handles()
|
|
if self.ref:
|
|
ret += [('Event', 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.get_citation_child_list()
|
|
|
|
def is_equivalent(self, other):
|
|
"""
|
|
Return if this eventref is equivalent, that is agrees in handle and
|
|
role, to other.
|
|
|
|
:param other: The eventref to compare this one to.
|
|
:type other: EventRef
|
|
:returns: Constant indicating degree of equivalence.
|
|
:rtype: int
|
|
"""
|
|
if self.ref != other.ref or self.role != other.role:
|
|
return DIFFERENT
|
|
else:
|
|
if self.is_equal(other):
|
|
return IDENTICAL
|
|
else:
|
|
return EQUAL
|
|
|
|
def merge(self, acquisition):
|
|
"""
|
|
Merge the content of acquisition into this eventref.
|
|
|
|
Lost: hlink and role of acquisition.
|
|
|
|
:param acquisition: The eventref to merge with the present eventref.
|
|
:type acquisition: EventRef
|
|
"""
|
|
self._merge_privacy(acquisition)
|
|
self._merge_attribute_list(acquisition)
|
|
self._merge_note_list(acquisition)
|
|
|
|
def get_role(self):
|
|
"""
|
|
Return the tuple corresponding to the preset role.
|
|
"""
|
|
return self.__role
|
|
|
|
def set_role(self, role):
|
|
"""
|
|
Set the role according to the given argument.
|
|
"""
|
|
self.__role.set(role)
|
|
role = property(get_role, set_role, None, 'Returns or sets role property')
|