cusack.hcg.comm

Class DataSource

java.lang.Object

cusack.hcg.comm.DataSource

public class DataSource
extends java.lang.Object

This is the class that serves as the interface between the game and the server/database. It is a singleton with a static method to get access. This makes it easier to gain access from anywhere in the code.

Author:

cusack

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Enum<?>	ALGORITHM

Method Summary

Modifier and Type	Method and Description
void	addNews(java.lang.String title, java.lang.String message)
java.lang.String	anyMessages()
void	badQuery()
void	broadcastMessage(java.lang.String message)
void	callNonExistentMethod() To cause a client crash.
boolean	changePassword(java.lang.String password, int userID)
int	checkStopTheRock()
int	checkTimeTraveler()
static DataSource	createDS(boolean isAlpha)
boolean	deleteGraph(int graphId)
boolean	deletePuzzle(int puzzleID)
boolean	deleteSolution(int solutionID)
boolean	deleteTutorialForPuzzle(int puzzle_id)
boolean	deleteUser(User user)
java.util.ArrayList<Achievement>	getAllAchievements()
java.util.ArrayList<GlobalScore>	getAllGlobalHighScores()
java.util.ArrayList<GraphWithUsage>	getAllGraphs()
java.util.ArrayList<PlayablePuzzle>	getAllPuzzlesForGame(java.lang.String problemName)
java.util.ArrayList<PlayablePuzzle>	getAllPuzzlesForSubclassOf(java.lang.Class<? extends PuzzleInstance> piClass)
java.util.ArrayList<UserAchievement>	getAllUserAchievements()
java.util.ArrayList<UserAlgorithm>	getAllUserAlgs()
java.util.ArrayList<java.lang.String>	getAllUserNames()
java.util.ArrayList<User>	getAllUsers()
java.lang.String[]	getCountryNames()
static DataSource	getDS()
java.util.ArrayList<Achievement>	getFamilyAchievements(int probFamilyID)
java.util.ArrayList<Achievement>	getGeneralAchievements()
int	getGlobalHighScore()
Graph	getGraph(int graphID)
Graph	getGraph(java.lang.String name)
Graph	getGraphForPuzzle(int gameID) This method is used for Replays since they do not store a graph_id.
java.util.ArrayList<HighScore>	getHighScores(int gameID, boolean lowerBetter)
java.lang.String	getIP()
java.lang.String	getMessage()
java.util.ArrayList<PostGameAchievement>	getNewAchievements()
java.util.ArrayList<News>	getNews(int n)
int	getNumberOfSolutions(int gameID)
java.util.ArrayList<UserAlgorithm>	getPersonalAndPublicUserAlgs()
java.util.ArrayList<PlayablePuzzle>	getPlayablePuzzles(java.lang.String problemName, java.lang.String gameType) This method does NOT use the puzzle cache since it needs to append scores and whatnot to the entry based on the player, and if we cached this instead of getting it from the DB, it would mean we would need to do all the filtering in Java instead of in an SQL query.
Problem	getProblem(java.lang.String gameName)
java.util.ArrayList<Achievement>	getProblemAchievements(int probID)
java.util.ArrayList<ProblemFamily>	getProblemFamilies()
ProblemFamily	getProblemFamily(java.lang.String familyName)
ProblemFamily	getProblemFamilyForPuzzle(java.lang.String puzzleName)
java.util.ArrayList<java.lang.String>	getProblemFamilyNames()
Problems	getProblems()
PlayablePuzzle	getPuzzle(int puzzle_id) This method assumes the puzzle is in the cache.
java.util.ArrayList<Puzzle>	getPuzzlesForGraph(int graphID)
java.util.ArrayList<Replay>	getRecentReplays(int hours)
java.util.ArrayList<Replay>	getReplays(java.lang.String problemName, java.lang.String puzzleName, java.lang.String userName, java.lang.String mode, java.lang.String algorithm)
java.util.ArrayList<Replay>	getReplaysWithinTimePeriod(java.lang.String problemName, java.lang.String puzzleName, java.lang.String userName, java.lang.String mode, java.lang.String algorithm, int minutes)
java.util.ArrayList<Solution>	getSolutionsForAllAlgorithms(int gameID)
java.util.ArrayList<Solution>	getSolutionsForThisAlgorithm(java.lang.String algorithmName, int gameID)
User	getUser()
UserAlgorithm	getUserAlgorithm(java.lang.String algName, int userID)
byte[]	getUserAlgorithmJarfile(java.lang.String name, int userID)
java.util.ArrayList<Solution>	getUserSolutions(int userID, int gameID)
int	insertGraph(Graph graph)
int	insertPuzzle(Puzzle puzzle) returns the puzzle ID assigned in the DB.
int	insertSolution(Solution solution)
boolean	insertTutorial(Tutorial tut)
boolean	insertUser(User user, java.lang.String password)
void	insertUserAlgorithm(UserAlgorithm userAlg)
boolean	isRecentClientVersion(double version)
boolean	isUniqueGraphName(java.lang.String name)
boolean	isUniquePuzzleName(java.lang.String name, int problemID)
boolean	isUniqueSolutionName(java.lang.String name, int gameID)
boolean	isUniqueUserName(java.lang.String name)
void	logError(java.lang.Throwable error, boolean isCaught)
User	logInUser(java.lang.String userName, java.lang.String password)
boolean	logOutUser()
void	logStuff(java.lang.String error)
void	lookupIP()
boolean	markAchievementsViewed(int[] achievementIDs)
void	preloadStuff()
java.lang.String	resetPassword(java.lang.String name, java.lang.String answer)
void	sendMessage(java.lang.String email, java.lang.String subject, java.lang.String message)
void	sendReport(java.lang.String subject, java.lang.String message)
boolean	updateGraph(Graph graph)
boolean	updateGraph(Graph graph)
boolean	updatePuzzle(Puzzle puzzle)
boolean	updatePuzzleData(int gameID, java.lang.String puzzleData)
boolean	updateSolution(int solutionId, java.lang.String name, int userVisible)
boolean	updateSolution(Solution solution)
boolean	updateTutorialForPuzzle(Tutorial tut)
boolean	updateUser(User user)
void	updateUserAlgorithm(UserAlgorithm userAlg)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALGORITHM

public java.lang.Enum<?> ALGORITHM

Method Detail

createDS

public static DataSource createDS(boolean isAlpha)

getDS

public static DataSource getDS()

preloadStuff

public void preloadStuff()

lookupIP

public void lookupIP()

badQuery

public void badQuery()

getUser

public User getUser()

getIP

public java.lang.String getIP()

isRecentClientVersion

public boolean isRecentClientVersion(double version)

callNonExistentMethod

public void callNonExistentMethod()

To cause a client crash.

logInUser

public User logInUser(java.lang.String userName,
                      java.lang.String password)

addNews

public void addNews(java.lang.String title,
                    java.lang.String message)

insertUserAlgorithm

public void insertUserAlgorithm(UserAlgorithm userAlg)

getAllUserAlgs

public java.util.ArrayList<UserAlgorithm> getAllUserAlgs()

getPersonalAndPublicUserAlgs

public java.util.ArrayList<UserAlgorithm> getPersonalAndPublicUserAlgs()

getUserAlgorithm

public UserAlgorithm getUserAlgorithm(java.lang.String algName,
                                      int userID)

getUserAlgorithmJarfile

public byte[] getUserAlgorithmJarfile(java.lang.String name,
                                      int userID)

updateUserAlgorithm

public void updateUserAlgorithm(UserAlgorithm userAlg)

getNews

public java.util.ArrayList<News> getNews(int n)

anyMessages

public java.lang.String anyMessages()

broadcastMessage

public void broadcastMessage(java.lang.String message)

changePassword

public boolean changePassword(java.lang.String password,
                              int userID)

deletePuzzle

public boolean deletePuzzle(int puzzleID)

deleteGraph

public boolean deleteGraph(int graphId)

deleteSolution

public boolean deleteSolution(int solutionID)

deleteUser

public boolean deleteUser(User user)

getPuzzle

public PlayablePuzzle getPuzzle(int puzzle_id)

This method assumes the puzzle is in the cache.

getAllPuzzlesForGame

public java.util.ArrayList<PlayablePuzzle> getAllPuzzlesForGame(java.lang.String problemName)

getAllPuzzlesForSubclassOf

public java.util.ArrayList<PlayablePuzzle> getAllPuzzlesForSubclassOf(java.lang.Class<? extends PuzzleInstance> piClass)

getGeneralAchievements

public java.util.ArrayList<Achievement> getGeneralAchievements()

insertTutorial

public boolean insertTutorial(Tutorial tut)

updateTutorialForPuzzle

public boolean updateTutorialForPuzzle(Tutorial tut)

deleteTutorialForPuzzle

public boolean deleteTutorialForPuzzle(int puzzle_id)

getFamilyAchievements

public java.util.ArrayList<Achievement> getFamilyAchievements(int probFamilyID)

getProblemAchievements

public java.util.ArrayList<Achievement> getProblemAchievements(int probID)

getAllAchievements

public java.util.ArrayList<Achievement> getAllAchievements()

getAllUserAchievements

public java.util.ArrayList<UserAchievement> getAllUserAchievements()

getNewAchievements

public java.util.ArrayList<PostGameAchievement> getNewAchievements()

markAchievementsViewed

public boolean markAchievementsViewed(int[] achievementIDs)

checkTimeTraveler

public int checkTimeTraveler()

checkStopTheRock

public int checkStopTheRock()

getAllGraphs

public java.util.ArrayList<GraphWithUsage> getAllGraphs()

getAllUserNames

public java.util.ArrayList<java.lang.String> getAllUserNames()

getAllUsers

public java.util.ArrayList<User> getAllUsers()

getCountryNames

public java.lang.String[] getCountryNames()

getPuzzlesForGraph

public java.util.ArrayList<Puzzle> getPuzzlesForGraph(int graphID)

getGraph

public Graph getGraph(int graphID)

getGraph

public Graph getGraph(java.lang.String name)

getGraphForPuzzle

public Graph getGraphForPuzzle(int gameID)

This method is used for Replays since they do not store a graph_id. So we can't call getGraph that takes graph_id as a parameter. Thus we have no choice but to look it up by problem_id. But we can get it locally since we have the puzzles all cached.

Parameters:

gameID -

Returns:

getHighScores

public java.util.ArrayList<HighScore> getHighScores(int gameID,
                                                    boolean lowerBetter)

getAllGlobalHighScores

public java.util.ArrayList<GlobalScore> getAllGlobalHighScores()

getGlobalHighScore

public int getGlobalHighScore()

getMessage

public java.lang.String getMessage()

getPlayablePuzzles

public java.util.ArrayList<PlayablePuzzle> getPlayablePuzzles(java.lang.String problemName,
                                                              java.lang.String gameType)

This method does NOT use the puzzle cache since it needs to append scores and whatnot to the entry based on the player, and if we cached this instead of getting it from the DB, it would mean we would need to do all the filtering in Java instead of in an SQL query.

Parameters:

problemName -

gameType -

Returns:

getProblemFamilies

public java.util.ArrayList<ProblemFamily> getProblemFamilies()

getProblem

public Problem getProblem(java.lang.String gameName)

getProblemFamilyForPuzzle

public ProblemFamily getProblemFamilyForPuzzle(java.lang.String puzzleName)

getProblemFamily

public ProblemFamily getProblemFamily(java.lang.String familyName)

getProblems

public Problems getProblems()

getProblemFamilyNames

public java.util.ArrayList<java.lang.String> getProblemFamilyNames()

getRecentReplays

public java.util.ArrayList<Replay> getRecentReplays(int hours)

getReplaysWithinTimePeriod

public java.util.ArrayList<Replay> getReplaysWithinTimePeriod(java.lang.String problemName,
                                                              java.lang.String puzzleName,
                                                              java.lang.String userName,
                                                              java.lang.String mode,
                                                              java.lang.String algorithm,
                                                              int minutes)

Parameters:

problemName -

puzzleName -

userName -

mode -

algorithm -

minutes - get all solutions within the last minutes minutes, or all if minutes==0.

Returns:

getReplays

public java.util.ArrayList<Replay> getReplays(java.lang.String problemName,
                                              java.lang.String puzzleName,
                                              java.lang.String userName,
                                              java.lang.String mode,
                                              java.lang.String algorithm)

getUserSolutions

public java.util.ArrayList<Solution> getUserSolutions(int userID,
                                                      int gameID)

getNumberOfSolutions

public int getNumberOfSolutions(int gameID)

getSolutionsForThisAlgorithm

public java.util.ArrayList<Solution> getSolutionsForThisAlgorithm(java.lang.String algorithmName,
                                                                  int gameID)

getSolutionsForAllAlgorithms

public java.util.ArrayList<Solution> getSolutionsForAllAlgorithms(int gameID)

insertPuzzle

public int insertPuzzle(Puzzle puzzle)

returns the puzzle ID assigned in the DB.

Parameters:

puzzle -

Returns:

insertGraph

public int insertGraph(Graph graph)

insertSolution

public int insertSolution(Solution solution)

insertUser

public boolean insertUser(User user,
                          java.lang.String password)

isUniquePuzzleName

public boolean isUniquePuzzleName(java.lang.String name,
                                  int problemID)

isUniqueGraphName

public boolean isUniqueGraphName(java.lang.String name)

isUniqueSolutionName

public boolean isUniqueSolutionName(java.lang.String name,
                                    int gameID)

isUniqueUserName

public boolean isUniqueUserName(java.lang.String name)

logError

public void logError(java.lang.Throwable error,
                     boolean isCaught)

logOutUser

public boolean logOutUser()

logStuff

public void logStuff(java.lang.String error)

resetPassword

public java.lang.String resetPassword(java.lang.String name,
                                      java.lang.String answer)

sendMessage

public void sendMessage(java.lang.String email,
                        java.lang.String subject,
                        java.lang.String message)

sendReport

public void sendReport(java.lang.String subject,
                       java.lang.String message)

updatePuzzle

public boolean updatePuzzle(Puzzle puzzle)

updatePuzzleData

public boolean updatePuzzleData(int gameID,
                                java.lang.String puzzleData)

updateGraph

public boolean updateGraph(Graph graph)

updateGraph

public boolean updateGraph(Graph graph)

updateSolution

public boolean updateSolution(Solution solution)

updateSolution

public boolean updateSolution(int solutionId,
                              java.lang.String name,
                              int userVisible)

updateUser

public boolean updateUser(User user)