Class GetHelp

java.lang.Object

org.deltava.dao.DAO

org.deltava.dao.GetHelp

public class GetHelp
extends DAO

A Data Access Object to load Online Help and Help Desk entries.

Since:

1.0

Version:

11.0

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

Method Summary

Modifier and Type	Method	Description
Collection<Issue>	getActive()	Returns all active Help Desk Issues.
Collection<Issue>	getAll()	Returns all Help Desk Issues.
Collection<Integer>	getAssignees()	Returns all Help Desk Issue assignees.
Collection<Integer>	getAuthors()	Returns all Help Desk Issue authors.
Collection<Issue>	getByPilot(int authorID, int assigneeID, boolean showPublic, boolean activeOnly)	Returns all Help Desk Issues for a Pilot, or Public Issues.
Collection<Issue>	getFAQ()	Returns the Help Desk FAQ Issues.
IssueComment	getFile(int id, Instant createdOn)	Loads an attached File.
Issue	getIssue(int id)	Returns a particular Help Desk Issue.
List<Issue>	search(String searchStr, boolean includeComments)	Searches all Issues for a particular phrase.

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

GetHelp

public GetHelp(Connection c)

Initializes the Data Access Object.

Parameters:

c - the JDBC Connection to use

Method Details

getIssue

public Issue getIssue(int id)
               throws DAOException

Returns a particular Help Desk Issue. This loads the Issue Comments.

Parameters:

id - the database ID

Returns:

an Issue bean, or null if not found

Throws:

DAOException - if a JDBC error occurs

getAll

public Collection<Issue> getAll()
                         throws DAOException

Returns all Help Desk Issues.

Returns:

a Collection of Issue beans

Throws:

DAOException - if a JDBC error occurs

getFile

public IssueComment getFile(int id,
 Instant createdOn)
                     throws DAOException

Loads an attached File.

Parameters:

id - the issue database ID

createdOn - the comment creation epoch timestamp

Returns:

the file data

Throws:

DAOException - if a JDBC error occurs

getAuthors

public Collection<Integer> getAuthors()
                               throws DAOException

Returns all Help Desk Issue authors.

Returns:

a Collection of Database IDs

Throws:

DAOException - if a JDBC error occurs

getAssignees

public Collection<Integer> getAssignees()
                                 throws DAOException

Returns all Help Desk Issue assignees.

Returns:

a Collection of Database IDs

Throws:

DAOException - if a JDBC error occurs

getByPilot

public Collection<Issue> getByPilot(int authorID,
 int assigneeID,
 boolean showPublic,
 boolean activeOnly)
                             throws DAOException

Returns all Help Desk Issues for a Pilot, or Public Issues.

Parameters:

authorID - the author's database ID

assigneeID - the assignee's database ID

showPublic - TRUE to show public issues, otherwise FALSE

activeOnly - TRUE to show active issues only, otherwise FALSE

Returns:

a Collection of Issue beans

Throws:

DAOException - if a JDBC error occurs

getActive

public Collection<Issue> getActive()
                            throws DAOException

Returns all active Help Desk Issues.

Returns:

a Collection of Issue beans

Throws:

DAOException - if a JDBC error occurs

getFAQ

public Collection<Issue> getFAQ()
                         throws DAOException

Returns the Help Desk FAQ Issues.

Returns:

a Collection of Issue beans

Throws:

DAOException - if a JDBC error occurs

search

public List<Issue> search(String searchStr,
 boolean includeComments)
                   throws DAOException

Searches all Issues for a particular phrase.

Parameters:

searchStr - the search phrase

includeComments - TRUE if Issue Comments should be searched, otherwise FALSE

Returns:

a List of Issues

Throws:

DAOException - if a JDBC error occurs