197 lines
6.5 KiB
Python
197 lines
6.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.
|
|
#
|
|
|
|
"""
|
|
Address class for Gramps.
|
|
"""
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Gramps modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
from .secondaryobj import SecondaryObject
|
|
from .privacybase import PrivacyBase
|
|
from .citationbase import CitationBase
|
|
from .notebase import NoteBase
|
|
from .datebase import DateBase
|
|
from .locationbase import LocationBase
|
|
from .const import IDENTICAL, EQUAL, DIFFERENT
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# Address for Person/Repository
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class Address(SecondaryObject, PrivacyBase, CitationBase, NoteBase, DateBase,
|
|
LocationBase):
|
|
"""Provide address information."""
|
|
|
|
def __init__(self, source=None):
|
|
"""
|
|
Create a new Address instance, copying from the source if provided.
|
|
"""
|
|
PrivacyBase.__init__(self, source)
|
|
CitationBase.__init__(self, source)
|
|
NoteBase.__init__(self, source)
|
|
DateBase.__init__(self, source)
|
|
LocationBase.__init__(self, source)
|
|
|
|
def serialize(self):
|
|
"""
|
|
Convert the object to a serialized tuple of data.
|
|
"""
|
|
return (PrivacyBase.serialize(self),
|
|
CitationBase.serialize(self),
|
|
NoteBase.serialize(self),
|
|
DateBase.serialize(self),
|
|
LocationBase.serialize(self))
|
|
|
|
def unserialize(self, data):
|
|
"""
|
|
Convert a serialized tuple of data to an object.
|
|
"""
|
|
(privacy, citation_list, note_list, date, location) = data
|
|
|
|
PrivacyBase.unserialize(self, privacy)
|
|
CitationBase.unserialize(self, citation_list)
|
|
NoteBase.unserialize(self, note_list)
|
|
DateBase.unserialize(self, date)
|
|
LocationBase.unserialize(self, location)
|
|
return self
|
|
|
|
@classmethod
|
|
def get_schema(cls):
|
|
"""
|
|
Returns the JSON Schema for this class.
|
|
|
|
:returns: Returns a dict containing the schema.
|
|
:rtype: dict
|
|
"""
|
|
from .date import Date
|
|
return {
|
|
"type": "object",
|
|
"properties": {
|
|
"_class": {"enum": [cls.__name__]},
|
|
"private": {"type": "boolean"},
|
|
"citation_list": {"type": "array",
|
|
"items": {"type": "string",
|
|
"maxLength": 50}},
|
|
"note_list": {"type": "array",
|
|
"items": {"type": "string",
|
|
"maxLength": 50}},
|
|
"date": {"oneOf": [{"type": "null"}, Date.get_schema()]},
|
|
"street": {"type": "string"},
|
|
"locality": {"type": "string"},
|
|
"city": {"type": "string"},
|
|
"county": {"type": "string"},
|
|
"state": {"type": "string"},
|
|
"country": {"type": "string"},
|
|
"postal": {"type": "string"},
|
|
"phone": {"type": "string"}
|
|
}
|
|
}
|
|
|
|
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 LocationBase.get_text_data_list(self)
|
|
|
|
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 []
|
|
|
|
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 []
|
|
|
|
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 []
|
|
|
|
def get_referenced_handles(self):
|
|
"""
|
|
Return the list of (classname, handle) tuples for all directly
|
|
referenced primary objects.
|
|
|
|
:returns: List of (classname, handle) tuples for referenced objects.
|
|
:rtype: list
|
|
"""
|
|
return self.get_referenced_note_handles() + \
|
|
self.get_referenced_citation_handles()
|
|
|
|
def is_equivalent(self, other):
|
|
"""
|
|
Return if this address is equivalent, that is agrees in location and
|
|
date, to other.
|
|
|
|
:param other: The address to compare this one to.
|
|
:type other: Address
|
|
:returns: Constant indicating degree of equivalence.
|
|
:rtype: int
|
|
"""
|
|
if self.get_text_data_list() != other.get_text_data_list() or \
|
|
self.get_date_object() != other.get_date_object():
|
|
return DIFFERENT
|
|
else:
|
|
if self.is_equal(other):
|
|
return IDENTICAL
|
|
else:
|
|
return EQUAL
|
|
|
|
def merge(self, acquisition):
|
|
"""
|
|
Merge the content of acquisition into this address.
|
|
|
|
Lost: date, street, city, county, state, country, postal and phone of
|
|
acquisition.
|
|
|
|
:param acquisition: The address to merge with the present address.
|
|
:type acquisition: Address
|
|
"""
|
|
self._merge_privacy(acquisition)
|
|
self._merge_note_list(acquisition)
|
|
self._merge_citation_list(acquisition)
|