Class GetDocuments

java.lang.Object

org.deltava.dao.DAO

org.deltava.dao.GetLibrary

org.deltava.dao.GetDocuments

public class GetDocuments
extends GetLibrary

A Data Access Object to load Documents from the Libraries.

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
GetDocuments(Connection c)	Initializes the Data Access Object.

Method Summary

Modifier and Type	Method	Description
Collection<Manual>	getByCertification(String dbName, String certName)	Returns all Manuals associated with a particular Flight Academy certification.
Manual	getManual(String fName, String dbName)	Returns metadata about a specific Manual .
Collection<Manual>	getManuals(String dbName)	Returns the contents of the Document Library.
Newsletter	getNewsletter(String fName, String dbName)	Returns metadata about a specific Newsletter.
Collection<Newsletter>	getNewsletters(String dbName)	Returns all newsletters.
Collection<Newsletter>	getNewslettersByCategory(String catName)	Returns all Newsletters within a particular category.
Collection<Manual>	getRegistrationManuals()	Returns the contents of the Document Library that are available on the Registration page.

Methods inherited from class GetLibrary

getFile, getFiles, getFleet, getInstaller, getInstallerByCode, getVideo, loadDownloadCount

Modifier and Type	Method	Description
FileEntry	getFile(String fName)	Returns metadata about a specifc file in the current database.
Collection<FileEntry>	getFiles(String dbName)	Returns the contents of the File Library.
List<Installer>	getFleet(String dbName, boolean isAdmin)	Returns the contents of a Fleet Library.
Installer	getInstaller(String fName, String dbName)	Returns metadata about a specifc Installer.
Installer	getInstallerByCode(String code, String dbName)	Returns metadata about a specifc Installer in the current database.
Video	getVideo(String fName)	Returns metadata about a specifc video in the current database.
protected void	loadDownloadCount(LibraryEntry le)	Helper method to load download counts for a Library Entry.

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

GetDocuments

public GetDocuments(Connection c)

Initializes the Data Access Object.

Parameters:

c - the JDBC connection to use

Method Details

getManual

public Manual getManual(String fName,
 String dbName)
                 throws DAOException

Returns metadata about a specific Manual .

Parameters:

fName - the filename

dbName - the database name

Returns:

a Manual, or null if not found

Throws:

DAOException - if a JDBC error occurs

getNewsletter

public Newsletter getNewsletter(String fName,
 String dbName)
                         throws DAOException

Returns metadata about a specific Newsletter.

Parameters:

fName - the filename

dbName - the database name

Returns:

a Newsletter, or null if not found

Throws:

DAOException - if a JDBC error occurs

getNewsletters

public Collection<Newsletter> getNewsletters(String dbName)
                                      throws DAOException

Returns all newsletters. This takes a database name so we can display the contents of other airlines' libraries.

Parameters:

dbName - the database name

Returns:

a Collection of Newsletter beans

Throws:

DAOException - if a JDBC error occurs

getNewslettersByCategory

public Collection<Newsletter> getNewslettersByCategory(String catName)
                                                throws DAOException

Returns all Newsletters within a particular category.

Parameters:

catName - the category name

Returns:

a Collection of Newsletter beans

Throws:

DAOException - if a JDBC error occurs

getRegistrationManuals

public Collection<Manual> getRegistrationManuals()
                                          throws DAOException

Returns the contents of the Document Library that are available on the Registration page.

Returns:

a Collection of Manual beans

Throws:

DAOException - if a JDBC error occurs

getManuals

public Collection<Manual> getManuals(String dbName)
                              throws DAOException

Returns the contents of the Document Library. This takes a database name so we can display the contents of other airlines' libraries.

Parameters:

dbName - the database name

Returns:

a Collection of Manual beans

Throws:

DAOException - if a JDBC error occurs

getByCertification

public Collection<Manual> getByCertification(String dbName,
 String certName)
                                      throws DAOException

Returns all Manuals associated with a particular Flight Academy certification.

Parameters:

dbName - the database name

certName - the Certification name

Returns:

a Collection of Manual beans

Throws:

DAOException - if a JDBC error occurs