Class GetCoolerChannels

java.lang.Object

org.deltava.dao.DAO

org.deltava.dao.GetCoolerChannels

public class GetCoolerChannels
extends DAO

A Data Access Object to load Water Cooler channel profiles.

Since:

1.0

Version:

10.0

Author:

Luke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	GetCoolerChannels.LastPostMessage	Helper class to allow displaying of last subject in a channel.

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
GetCoolerChannels(Connection c)	Create this DAO using a JDBC connection.

Method Summary

Modifier and Type	Method	Description
Channel	get(String channelName)	Retrieves a specific Channel profile.
List<Channel>	getChannels(AirlineInformation al, boolean showInactive)	Retrieves all Channels for a particular airline.
List<Channel>	getChannels(AirlineInformation al, Collection<String> roles)	Retrieves all active Channels for a particular airline and available to users with a given Collection of roles.
Map<Integer,Message>	getLastPosts(Collection<Channel> channels)	Returns a Map of the last posts in a group of Channels, indexed by Post ID.

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

GetCoolerChannels

public GetCoolerChannels(Connection c)

Create this DAO using a JDBC connection.

Parameters:

c - the JDBC connection to use

Method Details

get

public Channel get(String channelName)
            throws DAOException

Retrieves a specific Channel profile. This populate the roles and airlines.

Parameters:

channelName - the Channel name

Returns:

the Channel profile

Throws:

DAOException - if a JDBC error occurs

getChannels

public List<Channel> getChannels(AirlineInformation al,
 boolean showInactive)
                          throws DAOException

Retrieves all Channels for a particular airline.

Parameters:

al - the Airline

showInactive - TRUE if inactive channels should be returned, otherwise FALSE

Returns:

a List of Channel beans

Throws:

DAOException - if a JDBC error occurs

getChannels

public List<Channel> getChannels(AirlineInformation al,
 Collection<String> roles)
                          throws DAOException

Retrieves all active Channels for a particular airline and available to users with a given Collection of roles. If any role in the list is "Admin" then all channels for the Airline will be returned.

Parameters:

al - the Airline

roles - a Collection of role names

Returns:

a List of channels

Throws:

DAOException - if a JDBC error occurs

getLastPosts

public Map<Integer,Message> getLastPosts(Collection<Channel> channels)
                                  throws DAOException

Returns a Map of the last posts in a group of Channels, indexed by Post ID.

Parameters:

channels - a Collection of channels to query

Returns:

a Map of Messages, keyed by database ID

Throws:

DAOException - if a JDBC error occurs