net.sf.jabref.sql

Class SQLUtil

java.lang.Object

net.sf.jabref.sql.SQLUtil

public class SQLUtil
extends java.lang.Object

Author:

pattonlk Reestructured by ifsteinm. Jan 20th Now it is possible to export more than one jabref database. BD creation, insertions and queries where reformulated to accomodate the changes. The changes include a refactory on import/export to SQL module, creating many other classes making them more readable This class just support Exporters and Importers

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createJDBCurl(DBStrings dbStrings, boolean withDBName) This routine returns the JDBC url corresponding to the DBStrings input.
static void	executeQuery(java.sql.Connection conn, java.lang.String qry) Utility method for executing DML
static java.sql.Statement	executeQueryWithResults(java.sql.Connection conn, java.lang.String qry) Utility method for executing DML
static java.lang.String	fieldsAsCols(java.util.ArrayList<java.lang.String> fields, java.lang.String datatype) Generates DML specifying table columns and their datatypes.
static java.util.ArrayList<java.lang.String>	getAllFields()
static java.lang.String	getExceptionMessage(java.lang.Exception ex) Return a message raised from a SQLException
static java.lang.String	getFieldStr()
static void	processQuery(java.lang.Object out, java.lang.String dml) Utility method for processing DML with proper output
static java.lang.Object	processQueryWithResults(java.lang.Object out, java.lang.String query) Utility method for processing DML with proper output
static java.lang.String	processQueryWithSingleResult(java.sql.Connection conn, java.lang.String query) Process a query and returns only the first result of a result set as a String.
static java.sql.ResultSet	queryAllFromTable(java.sql.Connection conn, java.lang.String tableName) return a ResultSet with the result of a "SELECT *" query for a given table
static void	refreshFields() loop through entry types to get required, optional, general and utility fields for this type.
static java.util.ArrayList<java.lang.String>	setFieldRequirement(java.util.ArrayList<java.lang.String> allFields, java.util.List<java.lang.String> reqFields, java.util.List<java.lang.String> optFields, java.util.List<java.lang.String> utiFields, java.util.ArrayList<java.lang.String> origList)

Methods inherited from class java.lang.Object

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

Method Detail

refreshFields

public static void refreshFields()

loop through entry types to get required, optional, general and utility fields for this type.

getAllFields

public static java.util.ArrayList<java.lang.String> getAllFields()

Returns:

All existent fields for a bibtex entry

getFieldStr

public static java.lang.String getFieldStr()

Returns:

Create a common separated field names

fieldsAsCols

public static java.lang.String fieldsAsCols(java.util.ArrayList<java.lang.String> fields,
                                            java.lang.String datatype)

Generates DML specifying table columns and their datatypes. The output of this routine should be used within a CREATE TABLE statement.

Parameters:

fields - Contains unique field names

datatype - Specifies the SQL data type that the fields should take on.

Returns:

The SQL code to be included in a CREATE TABLE statement.

setFieldRequirement

public static java.util.ArrayList<java.lang.String> setFieldRequirement(java.util.ArrayList<java.lang.String> allFields,
                                                                        java.util.List<java.lang.String> reqFields,
                                                                        java.util.List<java.lang.String> optFields,
                                                                        java.util.List<java.lang.String> utiFields,
                                                                        java.util.ArrayList<java.lang.String> origList)

Parameters:

allFields - All existent fields for a given entry type

reqFields - list containing required fields for an entry type

optFields - list containing optional fields for an entry type

utiFields - list containing utility fields for an entry type

origList - original list with the correct size filled with the default values for each field

Returns:

origList changing the values of the fields that appear on reqFields, optFields, utiFields set to 'req', 'opt' and 'uti' respectively

getExceptionMessage

public static java.lang.String getExceptionMessage(java.lang.Exception ex)

Return a message raised from a SQLException

Parameters:

ex - The SQLException raised

queryAllFromTable

public static java.sql.ResultSet queryAllFromTable(java.sql.Connection conn,
                                                   java.lang.String tableName)
                                            throws java.sql.SQLException

return a ResultSet with the result of a "SELECT *" query for a given table

Parameters:

conn - Connection to the database

tableName - String containing the name of the table you want to get the results.

Returns:

a ResultSet with the query result returned from the DB

Throws:

java.sql.SQLException

processQuery

public static void processQuery(java.lang.Object out,
                                java.lang.String dml)
                         throws java.sql.SQLException

Utility method for processing DML with proper output

Parameters:

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

dml - The DML statements to be processed

Throws:

java.sql.SQLException

processQueryWithResults

public static java.lang.Object processQueryWithResults(java.lang.Object out,
                                                       java.lang.String query)
                                                throws java.sql.SQLException

Utility method for processing DML with proper output

Parameters:

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

query - The DML statements to be processed

Returns:

the result of the statement

Throws:

java.sql.SQLException

createJDBCurl

public static java.lang.String createJDBCurl(DBStrings dbStrings,
                                             boolean withDBName)

This routine returns the JDBC url corresponding to the DBStrings input.

Parameters:

dbStrings - The DBStrings to use to make the connection

Returns:

The JDBC url corresponding to the input DBStrings

processQueryWithSingleResult

public static java.lang.String processQueryWithSingleResult(java.sql.Connection conn,
                                                            java.lang.String query)
                                                     throws java.sql.SQLException

Process a query and returns only the first result of a result set as a String. To be used when it is certain that only one String (single cell) will be returned from the DB

Parameters:

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

query - The query statements to be processed

Returns:

String with the result returned from the database

Throws:

java.sql.SQLException

executeQuery

public static void executeQuery(java.sql.Connection conn,
                                java.lang.String qry)
                         throws java.sql.SQLException

Utility method for executing DML

Parameters:

conn - The DML Connection object that will execute the SQL

qry - The DML statements to be executed

Throws:

java.sql.SQLException

executeQueryWithResults

public static java.sql.Statement executeQueryWithResults(java.sql.Connection conn,
                                                         java.lang.String qry)
                                                  throws java.sql.SQLException

Utility method for executing DML

Parameters:

conn - The DML Connection object that will execute the SQL

qry - The DML statements to be executed

Throws:

java.sql.SQLException