Class GetPilotDirectory

java.lang.Object

org.deltava.dao.DAO

org.deltava.dao.PilotReadDAO

org.deltava.dao.GetPilot

org.deltava.dao.GetPilotDirectory

All Implemented Interfaces:

PersonUniquenessDAO

public class GetPilotDirectory
extends GetPilot
implements PersonUniquenessDAO

A Data Access Object to obtain user Directory information for Pilots.

Since:

1.0

Version:

11.0

Author:

Luke

Field Summary

Fields inherited from class PilotReadDAO

_cache

Modifier and Type	Field	Description
protected static final Cache<Pilot>	_cache

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

Method Summary

Modifier and Type	Method	Description
Collection<Integer>	checkSoundex(Person usr, String dbName)	Performs a soundex search on a Person's last name to detect possible matches.
Collection<Integer>	checkUnique(Person p, String dbName)	Checks if a Person is unique, by checking the first/last names and the e-mail address.
Collection<Integer>	checkUnique(Person p, String dbName, int days)	Checks if a Person is unique, by checking the first/last names and the e-mail address.
Collection<Integer>	checkUniqueEMail(Person usr, String dbName)	Checks whether a particular e-mail address is unique.
Pilot	getByCode(String pilotCode)	Returns the Pilot with a particular Pilot Code.
Pilot	getByIMAddress(String addr)	Returns users from the current database based on their Instant Message address.
List<Pilot>	getByRole(String roleName, String dbName)	Returns all active Pilots who have a particular security role.
List<Pilot>	getByRole(String roleName, String dbName, boolean activeOnly)	Returns all Pilots who have a particular security role.
Collection<Pilot>	getPermanent()	Returns all Pilots with permanent accounts.

Methods inherited from class GetPilot

getActivePilots, getByEMail, getCurrencyPilots, getNewestPilots, getPilotByCode, getPilots, getPilotsByEQ, getPilotsByLetter, getPilotsByRank, getPilotsByStatus, search, search

Modifier and Type	Method	Description
List<Integer>	getActivePilots(String orderBy)	Returns all Active and On Leave Pilots.
Pilot	getByEMail(String eMail)	Gets a Pilot based on e-mail address.
Collection<Pilot>	getCurrencyPilots()	Returns pilots who have enabled currency-based Check Rides.
List<Pilot>	getNewestPilots()	Gets the newest pilots (with the highest pilot IDs).
Pilot	getPilotByCode(int pilotCode, String dbName)	Gets a Pilot based on a pilot code.
List<Pilot>	getPilots()	Returns all Pilots.
List<Pilot>	getPilotsByEQ(EquipmentType eq, String sortBy, boolean showActive, Rank rank)	Returns all active Pilots with a particular rank in a particular equipment program.
List<Pilot>	getPilotsByLetter(String letter)	Returns Pilots whose last name begins with a particular letter.
List<Pilot>	getPilotsByRank(Rank rank)	Returns all Active pilots with a particular rank.
List<Pilot>	getPilotsByStatus(PilotStatus status)	Returns Pilots based upon their status.
List<Pilot>	search(String dbName, String fName, String lName)	Searches for Pilots matching certain name criteria, using a SQL LIKE search.
List<Pilot>	search(String dbName, String fName, String lName, String eMail, Collection<String> ratings)	Searches for Pilots matching certain search criteria, using a SQL LIKE search.

Methods inherited from class PilotReadDAO

execute, get, get, get, getByID, getByName, loadAccomplishments, loadChildRows, loadIMAddrs, loadPushEndpoints, loadRatings, loadRoles, updatePilotCodes

Modifier and Type	Method	Description
protected static final List<Pilot>	execute(PreparedStatement ps)	Query pilot objects from the database, assuming a pre-prepared statement.
final Pilot	get(int id)	Gets a pilot object based on a database ID.
Pilot	get(UserData ud)	Returns a Pilot object which may be in another Airline's database.
Map<Integer,Pilot>	get(UserDataMap udm)	Returns Pilot objects which may be in another Airline's database.
Map<Integer,Pilot>	getByID(Collection<?> ids, String tableName)	Returns a Map of pilots based on a Set of pilot IDs.
final List<Pilot>	getByName(String fullName, String dbName)	Returns a Pilot based on a given full name.
protected final void	loadAccomplishments(Map<Integer,Pilot> pilots, String dbName)	Load the accomplishment IDs for a group of Pilots.
protected final void	loadChildRows(Pilot p, String dbName)	Load the ratings, roles and accomplishment IDs for a Pilot.
protected final void	loadIMAddrs(Map<Integer,Pilot> pilots, String dbName)	Load social media addresses for a group of Pilots.
protected final void	loadPushEndpoints(Map<Integer,Pilot> pilots, String dbName)	Loads push notification endpoints for a group of Pilots.
protected final void	loadRatings(Map<Integer,Pilot> pilots, String dbName)	Load the equipment ratings for a group of Pilots.
protected final void	loadRoles(Map<Integer,Pilot> pilots)	Load the security roles for a group of Pilots.
protected static final void	updatePilotCodes(Collection<Pilot> pilots, String dbName)	Updates the Pilot codes when loading Pilots from different databases.

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

Methods inherited from interface PersonUniquenessDAO

get

Modifier and Type	Method	Description
Map<Integer, ? extends Person>	get(UserDataMap udm)	Returns Person objects which may be in another Airline's database.

Constructor Details

GetPilotDirectory

public GetPilotDirectory(Connection c)

Initialize the Data Access Object.

Parameters:

c - the JDBC connection to use

Method Details

getByCode

public Pilot getByCode(String pilotCode)
                throws DAOException

Returns the Pilot with a particular Pilot Code.

Parameters:

pilotCode - the Pilot Code (eg DVA043)

Returns:

the Directory Name of the Pilot, or null if not found

Throws:

DAOException - if a JDBC error occurs

checkUnique

public Collection<Integer> checkUnique(Person p,
 String dbName)
                                throws DAOException

Checks if a Person is unique, by checking the first/last names and the e-mail address.

Specified by:

checkUnique in interface PersonUniquenessDAO

Parameters:

p - the Person

dbName - the database to search

Returns:

a Collection of database IDs

Throws:

DAOException - if a JDBC error occurs

checkUnique

public Collection<Integer> checkUnique(Person p,
 String dbName,
 int days)
                                throws DAOException

Checks if a Person is unique, by checking the first/last names and the e-mail address.

Specified by:

checkUnique in interface PersonUniquenessDAO

Parameters:

p - the Person

dbName - the database to search

days - restrict uniqueness search to users created in the last number of days, or -1 for all

Returns:

a Collection of database IDs

Throws:

DAOException - if a JDBC error occurs

checkUniqueEMail

public Collection<Integer> checkUniqueEMail(Person usr,
 String dbName)
                                     throws DAOException

Checks whether a particular e-mail address is unique.

Parameters:

usr - the Person to check for

dbName - the database to check

Returns:

a Collection of database IDs

Throws:

DAOException - if a JDBC error occurs

getByIMAddress

public Pilot getByIMAddress(String addr)
                     throws DAOException

Returns users from the current database based on their Instant Message address.

Parameters:

addr - the address

Returns:

a Pilot, or null if not found

Throws:

DAOException - if a JDBC error occurs

getPermanent

public Collection<Pilot> getPermanent()
                               throws DAOException

Returns all Pilots with permanent accounts.

Returns:

a Collection of Pilots

Throws:

DAOException - if a JDBC error occurs

getByRole

public List<Pilot> getByRole(String roleName,
 String dbName)
                      throws DAOException

Returns all active Pilots who have a particular security role.

Parameters:

roleName - the role name

dbName - the database name

Returns:

a List of Pilots

Throws:

DAOException - if a JDBC error occurs

getByRole

public List<Pilot> getByRole(String roleName,
 String dbName,
 boolean activeOnly)
                      throws DAOException

Returns all Pilots who have a particular security role.

Parameters:

roleName - the role name

dbName - the database name

activeOnly - TRUE to only include active Pilots, otherwise FALSE

Returns:

a List of Pilots

Throws:

DAOException - if a JDBC error occurs

checkSoundex

public Collection<Integer> checkSoundex(Person usr,
 String dbName)
                                 throws DAOException

Performs a soundex search on a Person's last name to detect possible matches. The soundex implementation is dependent on the capabilities of the underlying database engine, and is not guaranteed to be consistent (or even supported) across different database servers.

Specified by:

checkSoundex in interface PersonUniquenessDAO

Parameters:

usr - the Person to check for

dbName - the database name

Returns:

a Collection of Database IDs as Integers

Throws:

DAOException - if a JDBC error occurs