net.sf.jabref.sql.exporter

Class DBExporter

java.lang.Object

net.sf.jabref.sql.DBImporterExporter

net.sf.jabref.sql.exporter.DBExporter

Direct Known Subclasses:

MySQLExporter, PostgreSQLExporter

public abstract class DBExporter
extends DBImporterExporter

Author:

ifsteinm. Jan 20th Abstract Class to provide main features to export entries to a DB. To insert a new DB it is necessary to extend this class and add the DB name the enum available at net.sf.jabref.sql.DBImporterAndExporterFactory (and to the GUI). This class and its subclasses create database, entries and related stuff within a DB.

Constructor Summary

Constructors

Constructor and Description
DBExporter()

Method Summary

Modifier and Type	Method and Description
abstract java.sql.Connection	connectToDB(DBStrings dbstrings) Given a DBStrings it connects to the DB and returns the java.sql.Connection object
protected abstract void	createTables(java.lang.Object out) Generates DML code necessary to create all tables in a database, and writes it to appropriate output.
void	exportDatabaseAsFile(BibtexDatabase database, MetaData metaData, java.util.Set<java.lang.String> keySet, java.lang.String file) Accepts the BibtexDatabase and MetaData, generates the DML required to create and populate SQL database tables, and writes this DML to the specified output file.
void	exportDatabaseToDBMS(BibtexDatabase database, MetaData metaData, java.util.Set<java.lang.String> keySet, DBStrings dbStrings, JabRefFrame frame) Accepts the BibtexDatabase and MetaData, generates the DML required to create and populate SQL database tables, and writes this DML to the specified SQL database.

Methods inherited from class net.sf.jabref.sql.DBImporterExporter

getDatabaseIDByName, removeAGivenDB, removeAllRecordsForAGivenDB, removeDB

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DBExporter

public DBExporter()

Method Detail

connectToDB

public abstract java.sql.Connection connectToDB(DBStrings dbstrings)
                                         throws java.lang.Exception

Given a DBStrings it connects to the DB and returns the java.sql.Connection object

Parameters:

dbstrings - The DBStrings to use to make the connection

Returns:

java.sql.Connection to the DB chosen

Throws:

java.lang.Exception

createTables

protected abstract void createTables(java.lang.Object out)
                              throws java.sql.SQLException

Generates DML code necessary to create all tables in a database, and writes it to appropriate output.

Parameters:

out - The output (PrintStream or Connection) object to which the DML should be written.

Throws:

java.sql.SQLException

exportDatabaseAsFile

public void exportDatabaseAsFile(BibtexDatabase database,
                                 MetaData metaData,
                                 java.util.Set<java.lang.String> keySet,
                                 java.lang.String file)
                          throws java.lang.Exception

Accepts the BibtexDatabase and MetaData, generates the DML required to create and populate SQL database tables, and writes this DML to the specified output file.

Parameters:

database - The BibtexDatabase to export

metaData - The MetaData object containing the groups information

keySet - The set of IDs of the entries to export.

file - The name of the file to which the DML should be written

Throws:

java.lang.Exception

exportDatabaseToDBMS

public void exportDatabaseToDBMS(BibtexDatabase database,
                                 MetaData metaData,
                                 java.util.Set<java.lang.String> keySet,
                                 DBStrings dbStrings,
                                 JabRefFrame frame)
                          throws java.lang.Exception

Accepts the BibtexDatabase and MetaData, generates the DML required to create and populate SQL database tables, and writes this DML to the specified SQL database.

Parameters:

database - The BibtexDatabase to export

metaData - The MetaData object containing the groups information

keySet - The set of IDs of the entries to export.

dbStrings - The necessary database connection information

Throws:

java.lang.Exception