Class SetLibrary

java.lang.Object

org.deltava.dao.DAO

org.deltava.dao.SetLibrary

public class SetLibrary
extends DAO

A Data Access Object to write and update Fleet/Document Library metadata.

Since:

1.0

Version:

10.2

Author:

Luke

Field Summary

Fields inherited from class DAO

_queryMax, _queryStart, _queryTimeout, WGS84_SRID

Modifier and Type	Field	Description
protected int	_queryMax	The maximum number of rows to return.
protected int	_queryStart	The row number at which to start returning results.
protected int	_queryTimeout	The query timeout, in seconds.
protected static final int	WGS84_SRID	The SRID used for geolocation queries.

Constructor Summary

Constructors

Constructor	Description
SetLibrary(Connection c)	Initialize the Data Access Object.

Method Summary

Modifier and Type	Method	Description
void	delete(LibraryEntry entry)	Deletes a Library Entry from the database.
void	download(String fName, int pilotID)	Logs a file downlaod.
void	write(FileEntry e)	Writes a File Library entry to the database.
void	write(Installer i)	Writes an Installer to the Fleet Library.
void	write(Manual m, boolean isNew)	Writes a Manual to the Document Library.
void	write(Newsletter nws)	Writes a Newsletter to the Document Library.
void	write(Video v)	Writes a Video Library entry to the database.

Methods inherited from class DAO

commitTransaction, createTimestamp, executeIDs, executeUpdate, executeUpdate, expandDate, formatDBName, formatLocation, getNewID, getQueryCount, prepare, prepareWithoutLimits, rollbackTransaction, setQueryMax, setQueryStart, setQueryTimeout, startTransaction, toID, toID, toInstant

Modifier and Type	Method	Description
protected void	commitTransaction()	Commits a multi-step transaction to the database.
protected static Timestamp	createTimestamp(Instant i)	Null-safe conversion of an Instant to a Timestamp.
protected static List<Integer>	executeIDs(PreparedStatement ps)	Helper method to extract database ID data from the result set.
protected static int	executeUpdate(PreparedStatement ps, int minUpdateCount)	Executes an UPDATE transaction on a prepared statement, and throws a SQLExceptionif less than the expected number of rows were updated.
protected static int	executeUpdate(PreparedStatement ps, int minPerUpdate, int minTotal)	Executes an batched UPDATE transaction on a prepared statement, and throws a SQLExceptionif less than the expected number of rows were updated per batch entry.
protected static Instant	expandDate(Date dt)	Converts a date-only JDBC value into a full timestamp.
protected static String	formatDBName(String db)	Formats a database name by converting to lowercase.
protected static String	formatLocation(GeoLocation loc)	Converts a geographic location into a MySQL WKT formatted point.
protected int	getNewID()	Returns the AUTO_INC column value generated by the previous JDBC transaction.
static final long	getQueryCount()	Returns the total number of queries executed since the JVM was started.
protected PreparedStatement	prepare(String sql)	Initialize the prepared statement with an arbitrary SQL statement.
protected PreparedStatement	prepareWithoutLimits(String sql)	Initialize the prepared statement with an abitrary SQL statement, without applying the DAO's query result limitations.
protected void	rollbackTransaction()	Rolls back a multi-step transaction before it is completed.
final void	setQueryMax(int maxRows)	Sets the maximum number of rows in the returned result set.
final void	setQueryStart(int rowStart)	Sets the first row of the results to return.
void	setQueryTimeout(int timeout)	Sets the timeout for any SQL operations.
protected void	startTransaction()	Marks the start of a multi-step database transaction.
protected static Integer	toID(Object o)	Converts a Database bean or an Integer into an Integer.
protected static Collection<Integer>	toID(Collection<?> ids)	Converts a collection of Objects into Integer IDs.
protected static Instant	toInstant(Timestamp dt)	Null-safe conversion of a Timestamp to an Instant.

Methods inherited from class Object

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

Constructor Details

SetLibrary

public SetLibrary(Connection c)

Initialize the Data Access Object.

Parameters:

c - the JDBC connection to use

Method Details

download

public void download(String fName,
 int pilotID)
              throws DAOException

Logs a file downlaod.

Parameters:

fName - the download file name

pilotID - the Database ID of the user downloading the file

Throws:

DAOException - if a JDBC error occurs

write

public void write(Manual m,
 boolean isNew)
           throws DAOException

Writes a Manual to the Document Library. This handles INSERT and UPDATE operations.

Parameters:

m - the Manual metadata

isNew - if we are performing an INSERT instead of an UPDATE

Throws:

DAOException - if a JDBC error occurs

write

public void write(Newsletter nws)
           throws DAOException

Writes a Newsletter to the Document Library. This handles INSERT and UPDATE operations.

Parameters:

nws - the Newsletter metadata

Throws:

DAOException - if a JDBC error occurs

write

public void write(Installer i)
           throws DAOException

Writes an Installer to the Fleet Library. This handles INSERT and UPDATE operations.

Parameters:

i - the Installer metadata

Throws:

DAOException - if a JDBC error occurs

write

public void write(FileEntry e)
           throws DAOException

Writes a File Library entry to the database. This handles INSERT and UPDATE operations.

Parameters:

e - the Library entry

Throws:

DAOException - if a JDBC error occurs

write

public void write(Video v)
           throws DAOException

Writes a Video Library entry to the database. This handles INSERT and UPDATE operations.

Parameters:

v - the Library entry

Throws:

DAOException - if a JDBC error occurs

delete

public void delete(LibraryEntry entry)
            throws DAOException

Deletes a Library Entry from the database.

Parameters:

entry - the Library entry

Throws:

DAOException - if a JDBC error occurs

IllegalArgumentException - if an unknown LibraryEntry subclass is passed