com.screenscraper.util

Class DataMain

java.lang.Object

com.screenscraper.util.DataMain

public class DataMain
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	DataMain.FileSorter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cacheDatabasePath The default database that will be used if another isn't specified.
static int	databasePort The port the db will listen on.
static int	DEFAULT_HYPERSONIC_PORT The default Hypersonic database port (http://www.hsqldb.org/doc/guide/ch01.html)
static java.lang.String	defaultDatabasePath The default database that will be used if another isn't specified.

Constructor Summary

Constructors

Constructor and Description
DataMain()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	backupDatabase() Backs up the database.
static void	closeConnection(boolean doCompact) Manually closes the connection.
static void	closeResultSet(java.sql.ResultSet rs) Closes a ResultSet and associated cursors
static boolean	databaseConnectionIsGood() Tests the database connection.
static void	deleteAllDatabaseBackupFolders() Deletes all backup folders.
static void	execute(java.lang.String sql) Executes a generic SQL statement.
static void	execute(java.lang.String sql, java.lang.String databasePath) Executes a generic SQL statement.
static void	executeDelete(java.lang.String sql) An alias for executeDelete(String, String) that uses the default database.
static void	executeDelete(java.lang.String sql, java.lang.String databasePath) Executes a DELETE statement.
static int	executeInsert(java.lang.String sql) An alias for executeInsert(String, String) that uses the default database.
static int	executeInsert(java.lang.String sql, java.lang.String databasePath) Executes an INSERT statement and returns the newly generated ID.
static java.sql.ResultSet	executeSelect(java.lang.String sql) An alias for executeSelect(String, String) that uses the default database.
static java.sql.ResultSet	executeSelect(java.lang.String sql, java.lang.String databasePath) Given a SELECT SQL statement, this function executes the statement and returns the resulting ResultSet.
static void	executeThrowable(java.lang.String sql) Executes a statement, throwing an exception if one occurs.
static void	executeThrowable(java.lang.String sql, java.lang.String databasePath) Executes a statement, throwing an exception if one occurs.
static java.sql.ResultSet	executeThrowableSelect(java.lang.String sql) An alias for executeSelect(String, String) that uses the default database and throws an exception.
static void	executeUpdate(java.lang.String sql) An alias for executeUpdate(String, String) that uses the default database.
static void	executeUpdate(java.lang.String sql, java.lang.String databasePath) Executes an UPDATE statement.
static java.lang.String	getSQLGlobalSearchSnippet(java.lang.String columnName, java.lang.String textToFind, boolean isCaseSensitive) Gets a snippet of SQL used with the global search feature.
static boolean	isConnected() Indicates whether or not the class currently holds a connection to the database.
static boolean	isReadOnly() Indicates whether or not the database connection is ready-only.
static void	setReadOnly(boolean isReadOnly) Sets the connection read-only state of the connection.
static void	startHypersonic() Starts up the Hypersonic database in server mode, in a separate process.
static boolean	verifyConnection() Verifies whether or not the connection to the database is alive.

Methods inherited from class java.lang.Object

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

Field Detail

defaultDatabasePath

public static final java.lang.String defaultDatabasePath

The default database that will be used if another isn't specified.

cacheDatabasePath

public static final java.lang.String cacheDatabasePath

The default database that will be used if another isn't specified.

DEFAULT_HYPERSONIC_PORT

public static int DEFAULT_HYPERSONIC_PORT

The default Hypersonic database port (http://www.hsqldb.org/doc/guide/ch01.html)

databasePort

public static int databasePort

The port the db will listen on.

Constructor Detail

DataMain

public DataMain()

Method Detail

verifyConnection

public static boolean verifyConnection()

Verifies whether or not the connection to the database is alive.

Returns:

A boolean.

closeConnection

public static void closeConnection(boolean doCompact)

Manually closes the connection.

Parameters:

doCompact - Indicates whether or not the database should be shut down as well as compacted.

databaseConnectionIsGood

public static boolean databaseConnectionIsGood()

Tests the database connection.

Returns:

true if the connection is good; false, otherwise.

isConnected

public static boolean isConnected()

Indicates whether or not the class currently holds a connection to the database.

Returns:

A boolean.

setReadOnly

public static void setReadOnly(boolean isReadOnly)

Sets the connection read-only state of the connection.

Parameters:

isReadOnly - A boolean.

isReadOnly

public static boolean isReadOnly()

Indicates whether or not the database connection is ready-only.

Returns:

A boolean.

executeSelect

public static java.sql.ResultSet executeSelect(java.lang.String sql,
                                               java.lang.String databasePath)

Given a SELECT SQL statement, this function executes the statement and returns the resulting ResultSet.

Parameters:

sql - The query to execute

databasePath - The database path

Returns:

The result of the query

executeSelect

@Nullable
public static java.sql.ResultSet executeSelect(java.lang.String sql)

An alias for executeSelect(String, String) that uses the default database.

Parameters:

sql - The query to execute

Returns:

The result of the query

executeThrowableSelect

public static java.sql.ResultSet executeThrowableSelect(java.lang.String sql)
                                                 throws java.sql.SQLException

An alias for executeSelect(String, String) that uses the default database and throws an exception.

Parameters:

sql - The SQL statement to execute.

Returns:

A ResultSet.

Throws:

java.sql.SQLException - On error executing the sql

executeInsert

public static int executeInsert(java.lang.String sql,
                                java.lang.String databasePath)

Executes an INSERT statement and returns the newly generated ID.

Parameters:

sql - The query to execute

databasePath - The database path

Returns:

The new identity value

executeInsert

public static int executeInsert(java.lang.String sql)

An alias for executeInsert(String, String) that uses the default database.

Parameters:

sql - The query to execute

Returns:

The new identity value

executeUpdate

public static void executeUpdate(java.lang.String sql,
                                 java.lang.String databasePath)

Executes an UPDATE statement.

Parameters:

sql - The query to execute

databasePath - The database path

executeUpdate

public static void executeUpdate(java.lang.String sql)

An alias for executeUpdate(String, String) that uses the default database.

Parameters:

sql - The query to execute

execute

public static void execute(java.lang.String sql)

Executes a generic SQL statement.

Parameters:

sql - The statement to execute.

execute

public static void execute(java.lang.String sql,
                           java.lang.String databasePath)

Executes a generic SQL statement.

Parameters:

sql - The statement to execute.

databasePath - The path to the database.

executeDelete

public static void executeDelete(java.lang.String sql,
                                 java.lang.String databasePath)

Executes a DELETE statement.

Parameters:

sql - The query to execute

databasePath - The database path

executeThrowable

public static void executeThrowable(java.lang.String sql)
                             throws java.sql.SQLException

Executes a statement, throwing an exception if one occurs.

Parameters:

sql - The query to execute

Throws:

java.sql.SQLException - On error executing the sql

executeThrowable

public static void executeThrowable(java.lang.String sql,
                                    java.lang.String databasePath)
                             throws java.sql.SQLException

Executes a statement, throwing an exception if one occurs.

Parameters:

sql - The query to execute

databasePath - The database path

Throws:

java.sql.SQLException - On error executing the sql

executeDelete

public static void executeDelete(java.lang.String sql)

An alias for executeDelete(String, String) that uses the default database.

Parameters:

sql - The query to execute

closeResultSet

public static void closeResultSet(@Nullable
                                  java.sql.ResultSet rs)

Closes a ResultSet and associated cursors

Parameters:

rs - ResultSet to be closed

startHypersonic

public static void startHypersonic()

Starts up the Hypersonic database in server mode, in a separate process.

backupDatabase

public static java.lang.String backupDatabase()

Backs up the database.

Returns:

The path where the backup was stored.

deleteAllDatabaseBackupFolders

public static void deleteAllDatabaseBackupFolders()

Deletes all backup folders. This should be used in cases where the database is being upgraded.

getSQLGlobalSearchSnippet

public static java.lang.String getSQLGlobalSearchSnippet(java.lang.String columnName,
                                                         @NotNull
                                                         java.lang.String textToFind,
                                                         boolean isCaseSensitive)

Gets a snippet of SQL used with the global search feature.

Parameters:

columnName - The name of the column.

textToFind - The text to find.

isCaseSensitive - Case sensitive?

Returns:

The SQL snippet.