124 lines
3.9 KiB
Python
124 lines
3.9 KiB
Python
|
#
|
||
|
|
# Gramps - a GTK+/GNOME based genealogy program
|
||
|
|
#
|
||
|
|
# Copyright (C) 2004-2005 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$
|
||
|
|
|
||
|
|
"""
|
||
|
|
This module contains factory methods for accessing the different
|
||
|
|
GrampsDb backends. These methods should be used obtain the correct class
|
||
|
|
for a database backend.
|
||
|
|
|
||
|
|
The app_* constants in const.py can be used to indicate which backend is
|
||
|
|
required e.g.:
|
||
|
|
|
||
|
|
# To get the class for the grdb backend
|
||
|
|
db_class = GrampsDb.gramps_db_factory(db_type = const.app_gramps)
|
||
|
|
|
||
|
|
# To get a XML writer
|
||
|
|
GrampsDb.gramps_db_writer_factory(db_type = const.app_gramps_xml)
|
||
|
|
|
||
|
|
# To get a Gedcom reader
|
||
|
|
GrampsDb.gramps_db_reader_factory(db_type = const.app_gedcom)
|
||
|
|
|
||
|
|
"""
|
||
|
|
import const
|
||
|
|
|
||
|
|
from _GrampsDbExceptions import GrampsDbException
|
||
|
|
|
||
|
|
def gramps_db_factory(db_type):
|
||
|
|
"""Factory class for obtaining a Gramps database backend.
|
||
|
|
|
||
|
|
@param db_type: the type of backend required.
|
||
|
|
@type db_type: one of the app_* constants in const.py
|
||
|
|
|
||
|
|
Raises GrampsDbException if the db_type is not recognised.
|
||
|
|
"""
|
||
|
|
|
||
|
|
if db_type == const.app_gramps:
|
||
|
|
from _GrampsBSDDB import GrampsBSDDB
|
||
|
|
cls = GrampsBSDDB
|
||
|
|
elif db_type == const.app_gramps_xml:
|
||
|
|
from _GrampsXMLDB import GrampsXMLDB
|
||
|
|
cls = GrampsXMLDB
|
||
|
|
elif db_type == const.app_gedcom:
|
||
|
|
from _GrampsGEDDB import GrampsGEDDB
|
||
|
|
cls = GrampsGEDDB
|
||
|
|
else:
|
||
|
|
raise GrampsDbException("Attempt to create unknown "
|
||
|
|
"database backend class: "
|
||
|
|
"db_type = %s" % (str(db_type),))
|
||
|
|
|
||
|
|
return cls
|
||
|
|
|
||
|
|
|
||
|
|
def gramps_db_writer_factory(db_type):
|
||
|
|
"""Factory class for obtaining a Gramps database writers.
|
||
|
|
|
||
|
|
|
||
|
|
@param db_type: the type of backend required.
|
||
|
|
@type db_type: one of the app_* constants in const.py
|
||
|
|
|
||
|
|
Raises GrampsDbException if the db_type is not recognised.
|
||
|
|
"""
|
||
|
|
|
||
|
|
if db_type == const.app_gramps:
|
||
|
|
import _WriteGrdb as WriteGrdb
|
||
|
|
md = WriteGrdb.exportData
|
||
|
|
elif db_type == const.app_gramps_xml:
|
||
|
|
import _WriteXML as WriteXML
|
||
|
|
md = WriteXML.exportData
|
||
|
|
elif db_type == const.app_gedcom:
|
||
|
|
import _WriteGedcom as WriteGedcom
|
||
|
|
md = WriteGedcom.exportData
|
||
|
|
else:
|
||
|
|
raise GrampsDbException("Attempt to create a database "
|
||
|
|
"writer for unknown format: "
|
||
|
|
"db_type = %s" % (str(db_type),))
|
||
|
|
|
||
|
|
return md
|
||
|
|
|
||
|
|
def gramps_db_reader_factory(db_type):
|
||
|
|
"""Factory class for obtaining a Gramps database writers.
|
||
|
|
|
||
|
|
@param db_type: the type of backend required.
|
||
|
|
@type db_type: one of the app_* constants in const.py
|
||
|
|
|
||
|
|
Raises GrampsDbException if the db_type is not recognised.
|
||
|
|
"""
|
||
|
|
|
||
|
|
if db_type == const.app_gramps:
|
||
|
|
import _ReadGrdb as ReadGrdb
|
||
|
|
md = ReadGrdb.importData
|
||
|
|
elif db_type == const.app_gramps_xml:
|
||
|
|
import _ReadXML as ReadXML
|
||
|
|
md = ReadXML.importData
|
||
|
|
elif db_type == const.app_gedcom:
|
||
|
|
import _ReadGedcom as ReadGedcom
|
||
|
|
md = ReadGedcom.importData
|
||
|
|
else:
|
||
|
|
raise GrampsDbException("Attempt to create a database "
|
||
|
|
"reader for unknown format: "
|
||
|
|
"db_type = %s" % (str(db_type),))
|
||
|
|
|
||
|
|
return md
|
||
|
|
|
||
|
|
|
||
|
|
|