Source code for gramps.gen.lib.locationbase
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2006 Donald N. Allingham
# Copyright (C) 2010 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.
#
"""
LocationBase class for Gramps.
"""
#-------------------------------------------------------------------------
#
# LocationBase class
#
#-------------------------------------------------------------------------
[docs]
class LocationBase:
"""
Base class for all things Address.
"""
def __init__(self, source=None):
"""
Create a LocationBase object, copying from the source object if it
exists.
"""
if source:
self.street = source.street
self.locality = source.locality
self.city = source.city
self.county = source.county
self.state = source.state
self.country = source.country
self.postal = source.postal
self.phone = source.phone
else:
self.street = ""
self.locality = ""
self.city = ""
self.county = ""
self.state = ""
self.country = ""
self.postal = ""
self.phone = ""
[docs]
def serialize(self):
"""
Convert the object to a serialized tuple of data.
"""
return (self.street, self.locality, self.city, self.county, self.state,
self.country, self.postal, self.phone)
[docs]
def unserialize(self, data):
"""
Convert a serialized tuple of data to an object.
"""
(self.street, self.locality, self.city, self.county, self.state,
self.country, self.postal, self.phone) = data
return self
[docs]
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.street, self.locality, self.city, self.county,
self.state, self.country, self.postal, self.phone]
[docs]
def set_street(self, val):
"""Set the street portion of the Location."""
self.street = val
[docs]
def get_street(self):
"""Return the street portion of the Location."""
return self.street
[docs]
def set_locality(self, val):
"""Set the locality portion of the Location."""
self.locality = val
[docs]
def get_locality(self):
"""Return the locality portion of the Location."""
return self.locality
[docs]
def set_city(self, data):
"""Set the city name of the LocationBase object."""
self.city = data
[docs]
def get_city(self):
"""Return the city name of the LocationBase object."""
return self.city
[docs]
def set_postal_code(self, data):
"""Set the postal code of the LocationBase object."""
self.postal = data
[docs]
def get_postal_code(self):
"""Return the postal code of the LocationBase object."""
return self.postal
[docs]
def set_phone(self, data):
"""Set the phone number of the LocationBase object."""
self.phone = data
[docs]
def get_phone(self):
"""Return the phone number of the LocationBase object."""
return self.phone
[docs]
def set_state(self, data):
"""Set the state name of the LocationBase object."""
self.state = data
[docs]
def get_state(self):
"""Return the state name of the LocationBase object."""
return self.state
[docs]
def set_country(self, data):
"""Set the country name of the LocationBase object."""
self.country = data
[docs]
def get_country(self):
"""Return the country name of the LocationBase object."""
return self.country
[docs]
def set_county(self, data):
"""Set the county name of the LocationBase object."""
self.county = data
[docs]
def get_county(self):
"""Return the county name of the LocationBase object."""
return self.county