com.example.staysafe

Class SSJsonReader

java.lang.Object

com.example.staysafe.SSJsonReader

public class SSJsonReader
extends java.lang.Object

The SSJsonReader is the class that the StaySafe application will use to read in the dynamic text for the curriculum. This class also functions to retain pertinent information that can be used through the session but does not necessarily require file I/O. These methods are noted as such. This class should only be instantiated once for a given session. The instance of the class should be passed from Screen to Screen. This will ensure no data loss or repetitive calls thus resulting in minimal I/O for the application. The JSON file that this class reads from should be placed in the root directory of the tablet and should be titled StaySafe.json

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	bestOption
private java.lang.String	choice
private java.lang.String	optionLetter
private org.json.simple.JSONObject	people
private org.json.simple.JSONObject	places
private org.json.simple.JSONObject	problemChoice
private java.lang.String	problemNumber
private java.lang.String	selectedOption1
private java.lang.String	selectedOption2
private java.lang.String	temp1SL2
private java.lang.String	temp1SL3
private int	temp3type
private org.json.simple.JSONObject	template1
private org.json.simple.JSONObject	template2
private org.json.simple.JSONObject	template3
private org.json.simple.JSONObject	things
private java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
SSJsonReader(int template) Convenience constructor for initiating the StaySafe JSON reader for Templates 1 and 3.
SSJsonReader(int template, int temp3type) Method call for initiating the JSON reader.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAffectedPersonsFacts() Method for retrieving the affected person facts for the problem.
java.lang.String	getAffectedPersonsTitle() Method for retrieving the title for the affected person screen.
java.lang.String	getBestOption() Retrieves the best option as set with setBestOption(String, String).
java.lang.String[][]	getGame() Method for retrieving the games question and answers for the current problem choice.
java.lang.String[]	getOptions() Method for retrieving the options for the problem.
java.lang.String[]	getOptionsFacts() Method for retrieving the options factoids for the problem.
java.lang.String[]	getPeopleProblemChoices() A method for retrieving the problem themes in the people category
java.lang.String[]	getPlacesProblemChoices() A method for retrieving the problem themes in the places category
java.lang.String	getProblemChoice() Method for retrieving a String representing the current problem choice.
java.lang.String	getProblemNumber() Method for retrieving a String representing the current problem choice number.
java.lang.String[]	getSelectedOptions() Retrieves the selected options for the session as set with setOptions(String, String).
java.lang.String[]	getSurvey() Method for retrieving the survey question for the current problem choice.
java.lang.String	getT1(int sildeNumber) This method returns in the dynamic text description required for Template 1's introduction video screens that was read in when the class was constructed.
java.lang.String[]	getTemplate3Facts() A method for retrieving the template 3 HIV facts.
java.lang.String	getTheLetter() Retrieves the corresponding letter to the best option as set with setBestOption(String, String).
java.lang.String[]	getThingsProblemChoices() A method for retrieving the problem themes in the things category
java.lang.String	getVersion() Retrieves the version of curriculum in the JSON file
java.lang.String	getVideoConsequences() Method for retrieving the consequences related to the video for the current problem selection
void	setBestOption(java.lang.String bestOption, java.lang.String optionLetter) Saves the selected best option for the session from one of the two items options from getSelectedOptions().
void	setOptions(java.lang.String option1, java.lang.String option2) Saves the selected options for the session.
void	setProblemChoice(java.lang.String theme, java.lang.String problemNumber) After a theme selection has been made by the user, this method will assure that future calls to this class reference the appropriate values from the selected problem.

Methods inherited from class java.lang.Object

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

Field Detail

bestOption

private java.lang.String bestOption

choice

private java.lang.String choice

optionLetter

private java.lang.String optionLetter

people

private org.json.simple.JSONObject people

places

private org.json.simple.JSONObject places

problemChoice

private org.json.simple.JSONObject problemChoice

problemNumber

private java.lang.String problemNumber

selectedOption1

private java.lang.String selectedOption1

selectedOption2

private java.lang.String selectedOption2

temp1SL2

private java.lang.String temp1SL2

temp1SL3

private java.lang.String temp1SL3

temp3type

private int temp3type

template1

private org.json.simple.JSONObject template1

template2

private org.json.simple.JSONObject template2

template3

private org.json.simple.JSONObject template3

things

private org.json.simple.JSONObject things

version

private java.lang.String version

Constructor Detail

SSJsonReader

public SSJsonReader(int template)

Convenience constructor for initiating the StaySafe JSON reader for Templates 1 and 3. This constructor does not require the temp3type param. The default value, 4, is passed.

Parameters:

template - used for determining what template the application is currently using

SSJsonReader

public SSJsonReader(int template,
                    int temp3type)

Method call for initiating the JSON reader.

Parameters:

template - used for determining what template the application is currently using

temp3type - indication of what session with template 3 is currently being run through (4, 7, or 10)

Method Detail

getAffectedPersonsFacts

public java.lang.String[] getAffectedPersonsFacts()

Method for retrieving the affected person facts for the problem.

Returns:

A String[4] containing factoids for the affected persons.

getAffectedPersonsTitle

public java.lang.String getAffectedPersonsTitle()

Method for retrieving the title for the affected person screen.

Returns:

A String with the title pertaining to the affected persons.

getBestOption

public java.lang.String getBestOption()

Retrieves the best option as set with setBestOption(String, String). This action is performed without file I/O.

Returns:

A String with the best option.

getGame

public java.lang.String[][] getGame()

Method for retrieving the games question and answers for the current problem choice.

Returns:

A String[7][3] containing text for the game. The first index is the question number. The second index denotes the question, the correct answer, and the incorrect answer. (0,1,2 respectively)

getOptions

public java.lang.String[] getOptions()

Method for retrieving the options for the problem.

Returns:

A String[4] containing options.

getOptionsFacts

public java.lang.String[] getOptionsFacts()

Method for retrieving the options factoids for the problem.

Returns:

A String[4] containing options factoids.

getPeopleProblemChoices

public java.lang.String[] getPeopleProblemChoices()

A method for retrieving the problem themes in the people category

Returns:

A String[] with the people problem themes in the current version of the StaySafe curriculum.

getPlacesProblemChoices

public java.lang.String[] getPlacesProblemChoices()

A method for retrieving the problem themes in the places category

Returns:

A String[] with the places problem themes in the current version of the StaySafe curriculum.

getProblemChoice

public java.lang.String getProblemChoice()

Method for retrieving a String representing the current problem choice. The String returned will not have the problem number at the beginning.

Returns:

A String with the current problem theme without the prefix of problem number.

getProblemNumber

public java.lang.String getProblemNumber()

Method for retrieving a String representing the current problem choice number.

Returns:

A String with the current problem theme number.

getSelectedOptions

public java.lang.String[] getSelectedOptions()

Retrieves the selected options for the session as set with setOptions(String, String). This action is performed without file I/O.

Returns:

A String[2] with the selected options.

getSurvey

public java.lang.String[] getSurvey()

Method for retrieving the survey question for the current problem choice.

Returns:

A String[7] containing text for the survey. The index is the question number.

getT1

public java.lang.String getT1(int sildeNumber)

This method returns in the dynamic text description required for Template 1's introduction video screens that was read in when the class was constructed.

Parameters:

sildeNumber - indicates the screen for which the text will be returned, either 2 or 3. The default value is 3.

Returns:

A String with the video description for the passed video screen.

getTemplate3Facts

public java.lang.String[] getTemplate3Facts()

A method for retrieving the template 3 HIV facts. These items are for displaying the content in Screen 5.

Returns:

A String[4] with all text for the HIV facts screen. index 0 = fact 1 title, 1 = fact 1, 2 = fact 2 title, and 3 = fact 2

getTheLetter

public java.lang.String getTheLetter()

Retrieves the corresponding letter to the best option as set with setBestOption(String, String). This action is performed without file I/O.

Returns:

A String with the letter corresponding to the best option. ("A" or "B")

getThingsProblemChoices

public java.lang.String[] getThingsProblemChoices()

A method for retrieving the problem themes in the things category

Returns:

A String[] with the things problem themes in the current version of the StaySafe curriculum.

getVersion

public java.lang.String getVersion()

Retrieves the version of curriculum in the JSON file

Returns:

A String with the current version of the curriculum.

getVideoConsequences

public java.lang.String getVideoConsequences()

Method for retrieving the consequences related to the video for the current problem selection

Returns:

A String with consequences related to the problems video. This string may contain uni-code characters to simulate a bulleted list.

setBestOption

public void setBestOption(java.lang.String bestOption,
                          java.lang.String optionLetter)

Saves the selected best option for the session from one of the two items options from getSelectedOptions(). This action is performed without file I/O

Parameters:

bestOption - The best option the user has selected.

optionLetter - The letter corresponding to the option.

setOptions

public void setOptions(java.lang.String option1,
                       java.lang.String option2)

Saves the selected options for the session. This action is performed without file I/O

Parameters:

option1 - The first option the user has selected as one of their top two options.

option2 - The second option the user has selected as one of their top two options.

setProblemChoice

public void setProblemChoice(java.lang.String theme,
                             java.lang.String problemNumber)

After a theme selection has been made by the user, this method will assure that future calls to this class reference the appropriate values from the selected problem.

Parameters:

theme - Represents the category of the problem theme chosen. This value must be "People", "Places", or "Things"

problemNumber - The problem number that was selected by the user.