Class GetCoolerThreads

java.lang.Object

org.deltava.dao.DAO

org.deltava.dao.GetCoolerThreads

public class GetCoolerThreads
extends DAO

A Data Access Object to retrieve Water Cooler threads and thread notifications.

Since:

1.0

Version:

11.1

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

Method Summary

Modifier and Type	Method	Description
List<MessageThread>	getByAuthor(int userID, boolean showImgs)	Get all Water Cooler threads from a particular Author.
List<MessageThread>	getByChannel(String channelName, boolean showImgs)	Get all Water Cooler threads from a particular Channel.
protected List<MessageThread>	getByID(Collection<Integer> IDs)	Loads a number of message threads based on their ID.
List<MessageThread>	getByNotification(int userID)	Get all Water Cooler threads where a particular user has signed up for notifications.
ThreadNotifications	getNotifications(int id)	Returns thread notifications for a particular message thread.
List<MessageThread>	getScreenShots()	Returns all Screen Shot message threads.
List<MessageThread>	getSince(Instant sd, boolean showImgs)	Returns all Water Cooler threads updated since a particular date.
MessageThread	getThread(int id)	Retrieves a particular discussion thread with posts and warnings.
MessageThread	getThread(int id, boolean loadPosts)	Retrieves a particular discussion thread.
List<MessageThread>	search(SearchCriteria criteria)	Returns all Message Threads matching particular search criteria.

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

GetCoolerThreads

public GetCoolerThreads(Connection c)

Initializes the Data Access Object.

Parameters:

c - the JDBC connection to use

Method Details

getByChannel

public List<MessageThread> getByChannel(String channelName,
 boolean showImgs)
                                 throws DAOException

Get all Water Cooler threads from a particular Channel.

Parameters:

channelName - the Channle name

showImgs - TRUE if screen shot threads should be included, otherwise FALSE

Returns:

a List of MessageThread beans

Throws:

DAOException - if a JDBC error occurs

getScreenShots

public List<MessageThread> getScreenShots()
                                   throws DAOException

Returns all Screen Shot message threads.

Returns:

a List of MessageThread beans

Throws:

DAOException - if a JDBC error occurs

getByAuthor

public List<MessageThread> getByAuthor(int userID,
 boolean showImgs)
                                throws DAOException

Get all Water Cooler threads from a particular Author.

Parameters:

userID - the Author's database ID

showImgs - TRUE if screen shot threads should be included, otherwise FALSE

Returns:

a List of MessageThread beans

Throws:

DAOException - if a JDBC error occurs

getByNotification

public List<MessageThread> getByNotification(int userID)
                                      throws DAOException

Get all Water Cooler threads where a particular user has signed up for notifications.

Parameters:

userID - the User's database ID

Returns:

a List of MessageThread beans

Throws:

DAOException - if a JDBC error occurs

getSince

public List<MessageThread> getSince(Instant sd,
 boolean showImgs)
                             throws DAOException

Returns all Water Cooler threads updated since a particular date.

Parameters:

sd - the date/time

showImgs - TRUE if screen shot threads should be included, otherwise FALSE

Returns:

a List of MessageThreads

Throws:

DAOException - if a JDBC error occurs

getThread

public MessageThread getThread(int id)
                        throws DAOException

Retrieves a particular discussion thread with posts and warnings.

Parameters:

id - the thread ID

Returns:

a MessageThread bean, or null if not found

Throws:

DAOException - if a JDBC error occurs

See Also:

• getThread(int, boolean)

getThread

public MessageThread getThread(int id,
 boolean loadPosts)
                        throws DAOException

Retrieves a particular discussion thread.

Parameters:

id - the thread ID

loadPosts - TRUE if posts/warnings should be loaded, otherwise FALSE

Returns:

a MessageThread bean, or null if not found

Throws:

DAOException - if a JDBC error occurs

getNotifications

public ThreadNotifications getNotifications(int id)
                                     throws DAOException

Returns thread notifications for a particular message thread.

Parameters:

id - the message thread database ID

Returns:

a ThreadNotifications bean

Throws:

DAOException - if a JDBC error occurs

search

public List<MessageThread> search(SearchCriteria criteria)
                           throws DAOException

Returns all Message Threads matching particular search criteria.

Parameters:

criteria - the search criteria

Returns:

a List of MessageThreads

Throws:

DAOException - if a JDBC error occurs

getByID

protected List<MessageThread> getByID(Collection<Integer> IDs)
                               throws DAOException

Loads a number of message threads based on their ID.

Parameters:

IDs - a Collection of database IDs

Returns:

a List of MessageThread beans

Throws:

DAOException - if a JDBC error occurs