org.sakaiproject.tool.assessment.services

Class GradingService

java.lang.Object

org.sakaiproject.tool.assessment.services.GradingService

public class GradingService
extends Object

The GradingService calls the back end to get/store grading information. It also calculates scores for autograded types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANSWER_TYPE_COMPLEX Key for a complext numeric answer e.g. 9+9i
static String	ANSWER_TYPE_REAL key for a real number representation e.g 1 or 10E5

Constructor Summary

Constructors

Constructor and Description
GradingService()

Method Summary

Methods

Modifier and Type	Method and Description
String	applyPrecisionToNumberString(String numberStr, int decimalPlaces) CALCULATED_QUESTION applyPrecisionToNumberString() takes a string representation of a number and returns a string representation of that number, rounded to the specified number of decimal places, including trimming decimal places if needed.
void	autoSubmitAssessments()
static String	cleanFormula(String formula) Cleans up formula text so that whitespaces are normalized or removed
void	completeItemGradingData(AssessmentGradingData assessmentGradingData)
ItemGradingAttachment	createItemGradingAttachment(ItemGradingData itemGrading, String resourceId, String filename, String protocol)
void	deleteAll(Collection c)
Map<String,String>	determineRandomValuesForRanges(Map<String,String> variableRangeMap, long itemId, long gradingId, String agentId, int validAnswersAttemptCount) CALCULATED_QUESTION Takes a map of ranges and randomly chooses values for those ranges and stores them in a new map.
List<String>	extractCalcQAnswersArray(Map<Integer,String> answerList, ItemDataIfc item, Long gradingId, String agentId) CALCULATED_QUESTION This is a busy method.
List<String>	extractCalculations(String text) extractCalculations() is a utility function for Calculated Questions.
List<String>	extractFormulas(String text) extractFormulas() is a utility function for Calculated Questions.
protected List<String>	extractInstructionSegments(String instructions) CALCULATED_QUESTION Takes the instructions and breaks it into segments, based on the location of formula names.
List<String>	extractVariables(String text) extractVariables() is a utility function for Calculated Questions.
boolean	fibmatch(String answer, String input, boolean casesensitive)
int	getActualNumberRetake(Long publishedAssessmentId, String agentIdString)
HashMap	getActualNumberRetakeHash(String agentIdString)
List	getAllAssessmentGradingByAgentId(Long publishedAssessmentId, String agentIdString)
List	getAllAssessmentGradingData(Long publishedId)
List<ItemGradingData>	getAllItemGradingDataForItemInGrading(Long assesmentGradingId, Long publihsedItemId)
List	getAllSubmissions(String publishedId) Get all submissions for a published assessment from the back end.
double	getAnswerScore(ItemGradingData data, Map publishedAnswerHash) This grades multiple choice and true false questions.
double	getAnswerScoreMCQ(ItemGradingData data, Map publishedAnswerHash) This grades multiple choice and true false questions.
HashMap	getAssessmentGradingByItemGradingId(String publishedAssessmentId)
List	getAssessmentGradingIds(String publishedItemId)
ArrayList	getAssessmentGradingsByScoringType(Integer scoringType, Long publishedAssessmentId)
double	getCalcQScore(ItemGradingData data, ItemDataIfc itemdata, Map<Integer,String> calculatedAnswersMap, int calcQuestionAnswerSequence) CALCULATED_QUESTION Returns a double score value for the ItemGrading element being scored for a Calculated Question
List	getExportResponsesData(String publishedAssessmentId, boolean anonymous, String audioMessage, String fileUploadMessage, String noSubmissionMessage, boolean showPartAndTotalScoreSpreadsheetColumns, String poolString, String partString, String questionString, String textString, String rationaleString, String itemGradingCommentsString, Map useridMap)
boolean	getFIBResult(ItemGradingData data, HashMap fibmap, ItemDataIfc itemdata, HashMap publishedAnswerHash)
double	getFIBScore(ItemGradingData data, Map fibmap, ItemDataIfc itemdata, Map publishedAnswerHash) This grades Fill In Blank questions.
String	getFileName(Long itemGradingId, String agentId, String filename)
boolean	getFINResult(ItemGradingData data, ItemDataIfc itemdata, Map publishedAnswerHash)
double	getFINScore(ItemGradingData data, ItemDataIfc itemdata, Map publishedAnswerHash)
boolean	getHasGradingData(Long publishedAssessmentId)
ArrayList	getHasGradingDataAndHasSubmission(Long publishedAssessmentId)
AssessmentGradingData	getHighestAssessmentGrading(String publishedAssessmentId, String agentId)
ArrayList	getHighestAssessmentGradingList(Long publishedId)
AssessmentGradingData	getHighestSubmittedAssessmentGrading(String publishedAssessmentId, String agentId)
AssessmentGradingData	getHighestSubmittedAssessmentGrading(String publishedAssessmentId, String agentId, String assessmentGradingId)
List	getHighestSubmittedOrGradedAssessmentGradingList(Long publishedId)
HashMap	getInProgressCounts(String siteId)
ItemGradingData	getItemGrading(String itemGradingId)
ItemGradingData	getItemGradingData(String assessmentGradingId, String publishedItemId)
Set	getItemGradingSet(String assessmentGradingId)
HashMap	getItemScores(Long itemId, List scores, boolean loadItemGradingAttachment)
HashMap	getItemScores(Long publishedId, Long itemId, String which) Get the score information for each item from the assessment score.
HashMap	getItemScores(Long publishedId, Long itemId, String which, boolean loadItemGradingAttachment)
HashSet	getItemSet(Long publishedAssessmentId, Long sectionId)
AssessmentGradingData	getLastAssessmentGradingByAgentId(String publishedAssessmentId, String agentIdString)
ArrayList	getLastAssessmentGradingList(Long publishedId)
HashMap	getLastItemGradingData(String publishedId, String agentId) Get the last set of itemgradingdata for a student per assessment
ItemGradingData	getLastItemGradingDataByAgent(String publishedItemId, String agentId)
ArrayList	getLastItemGradingDataPosition(Long assessmentGradingId, String agentId)
AssessmentGradingData	getLastSavedAssessmentGradingByAgentId(String publishedAssessmentId, String agentIdString)
AssessmentGradingData	getLastSubmittedAssessmentGradingByAgentId(String publishedAssessmentId, String agentIdString, String assessmentGradingId)
List	getLastSubmittedAssessmentGradingList(Long publishedId)
List	getLastSubmittedOrGradedAssessmentGradingList(Long publishedId)
int	getLateSubmissionsNumberByAgentId(Long publishedAssessmentId, String agentIdString, Date dueDate)
MediaData	getMedia(String mediaId)
ArrayList	getMediaArray(ItemGradingData i)
ArrayList	getMediaArray(String itemGradingId)
List<MediaData>	getMediaArray(String publishedId, String publishItemId, String which)
ArrayList	getMediaArray2(String itemGradingId)
HashMap	getMediaItemGradingHash(Long assessmentGradingId)
int	getNumberRetake(Long publishedAssessmentId, String agentIdString)
HashMap	getNumberRetakeHash(String agentIdString)
PublishedAssessmentIfc	getPublishedAssessmentByAssessmentGradingId(String id)
PublishedAssessmentIfc	getPublishedAssessmentByPublishedItemId(String publishedItemId)
List	getPublishedItemIds(Long assessmentGradingId)
Integer	getScoringType(PublishedAssessmentIfc pub)
HashMap	getSiteActualNumberRetakeHash(String siteIdString)
HashMap	getSiteInProgressCountHash(String siteId)
List	getSiteNeedResubmitList(String siteId)
HashMap	getSiteNumberRetakeHash(String siteIdString)
HashMap	getSiteSubmissionCountHash(String siteId)
HashMap	getStudentGradingData(String assessmentGradingId) Get the grading data for a given submission
List	getStudentGradingSummaryData(Long publishedAssessmentId, String agentIdString)
int	getSubmissionSizeOfPublishedAssessment(String publishedAssessmentId)
HashMap	getSubmitData(String publishedId, String agentId, Integer scoringoption, String assessmentGradingId) Get the last submission for a student per assessment
HashMap	getSubmittedCounts(String siteId)
String	getTextForId(Long typeId)
double	getTotalCorrectScore(ItemGradingData data, Map publishedAnswerHash)
ArrayList	getTotalScores(String publishedId, String which) Get all scores for a published assessment from the back end.
ArrayList	getTotalScores(String publishedId, String which, boolean getSubmittedOnly)
Long	getTypeId(Long itemGradingId)
List	getUnSubmittedAssessmentGradingDataList(Long publishedAssessmentId, String agentIdString)
List	getUpdatedAssessmentList(String agentId, String siteId)
boolean	hasDistractors(ItemDataIfc item) hasDistractors looks at an itemData object for a Matching question and determines if all of the choices have correct matches or not.
boolean	isAnswerValid(String answer) CALCULATED_QUESTION Takes an answer string and checks for the value returned is NaN or Infinity, indicating a Samigo formula parse error Returns false if divide by zero is detected.
boolean	isDistractor(ItemTextIfc itemText) determines if the passed parameter is a distractor For ItemTextIfc objects that hold data for matching type questions, a distractor is a choice that has no valid matches (i.e. no correct answers).
boolean	isNegativeSqrt(String expression) isNegativeSqrt() looks at the incoming expression and looks specifically to see if it executes the SQRT function.
AssessmentGradingData	load(String assessmentGradingId)
AssessmentGradingData	load(String assessmentGradingId, boolean loadGradingAttachment)
void	notifyGradebook(AssessmentGradingData data, PublishedAssessmentIfc pub)
String	processFormulaIntoValue(String formula, int decimalPlaces) CALCULATED_QUESTION Process a single formula into a final string representing the calculated value of the formula
void	removeItemGradingAttachment(String attachmentId)
String	replaceCalculationsWithValues(String expression, int decimalPlaces) CALCULATED_QUESTION replaceMappedVariablesWithNumbers() takes a string and substitutes any variable names found with the value of the variable.
String	replaceMappedVariablesWithNumbers(String expression, Map<String,String> variables) CALCULATED_QUESTION replaceMappedVariablesWithNumbers() takes a string and substitutes any variable names found with the value of the variable.
void	saveItemGrading(ItemGradingData item)
Long	saveMedia(byte[] media, String mimeType)
Long	saveMedia(MediaData mediaData)
void	saveOrUpdateAll(Collection c)
void	saveOrUpdateAssessmentGrading(AssessmentGradingData assessment)
void	saveOrUpdateAssessmentGradingOnly(AssessmentGradingData assessment)
void	saveOrUpdateAttachments(List list)
void	saveStudentGradingSummaryData(StudentGradingSummaryIfc studentGradingSummaryData)
void	saveTotalScores(ArrayList gdataList, PublishedAssessmentIfc pub)
void	storeGrades(AssessmentGradingData data, boolean regrade, PublishedAssessmentIfc pub, HashMap publishedItemHash, HashMap publishedItemTextHash, HashMap publishedAnswerHash, boolean persistToDB)
void	storeGrades(AssessmentGradingData data, boolean regrade, PublishedAssessmentIfc pub, HashMap publishedItemHash, HashMap publishedItemTextHash, HashMap publishedAnswerHash, boolean persistToDB, HashMap invalidFINMap, ArrayList invalidSALengthList) This is the big, complicated mess where we take all the items in an assessment, store the grading data, auto-grade it, and update everything.
void	storeGrades(AssessmentGradingData data, PublishedAssessmentIfc pub, HashMap publishedItemHash, HashMap publishedItemTextHash, HashMap publishedAnswerHash, boolean persistToDB, HashMap invalidFINMap, ArrayList invalidSALengthList) Assume this is a new item.
void	storeGrades(AssessmentGradingData data, PublishedAssessmentIfc pub, HashMap publishedItemHash, HashMap publishedItemTextHash, HashMap publishedAnswerHash, HashMap invalidFINMap, ArrayList invalidSALengthList) Assume this is a new item.
void	updateAssessmentGradingScore(AssessmentGradingData adata, PublishedAssessmentIfc pub)
void	updateItemScore(ItemGradingData gdata, double scoreDifference, PublishedAssessmentIfc pub)
Map	validate(String value) Validate a students numeric answer

Methods inherited from class java.lang.Object

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

Field Detail

ANSWER_TYPE_COMPLEX

public static final String ANSWER_TYPE_COMPLEX

Key for a complext numeric answer e.g. 9+9i

See Also:

Constant Field Values

ANSWER_TYPE_REAL

public static final String ANSWER_TYPE_REAL

key for a real number representation e.g 1 or 10E5

See Also:

Constant Field Values

Constructor Detail

GradingService

public GradingService()

Method Detail

getTotalScores

public ArrayList getTotalScores(String publishedId,
                       String which)

Get all scores for a published assessment from the back end.

getTotalScores

public ArrayList getTotalScores(String publishedId,
                       String which,
                       boolean getSubmittedOnly)

getAllSubmissions

public List getAllSubmissions(String publishedId)

Get all submissions for a published assessment from the back end.

getAllAssessmentGradingData

public List getAllAssessmentGradingData(Long publishedId)

getHighestAssessmentGradingList

public ArrayList getHighestAssessmentGradingList(Long publishedId)

getHighestSubmittedOrGradedAssessmentGradingList

public List getHighestSubmittedOrGradedAssessmentGradingList(Long publishedId)

getLastAssessmentGradingList

public ArrayList getLastAssessmentGradingList(Long publishedId)

getLastSubmittedAssessmentGradingList

public List getLastSubmittedAssessmentGradingList(Long publishedId)

getLastSubmittedOrGradedAssessmentGradingList

public List getLastSubmittedOrGradedAssessmentGradingList(Long publishedId)

saveTotalScores

public void saveTotalScores(ArrayList gdataList,
                   PublishedAssessmentIfc pub)

getAssessmentGradingsByScoringType

public ArrayList getAssessmentGradingsByScoringType(Integer scoringType,
                                           Long publishedAssessmentId)

getScoringType

public Integer getScoringType(PublishedAssessmentIfc pub)

getItemScores

public HashMap getItemScores(Long publishedId,
                    Long itemId,
                    String which)

Get the score information for each item from the assessment score.

getItemScores

public HashMap getItemScores(Long publishedId,
                    Long itemId,
                    String which,
                    boolean loadItemGradingAttachment)

getItemScores

public HashMap getItemScores(Long itemId,
                    List scores,
                    boolean loadItemGradingAttachment)

getLastItemGradingData

public HashMap getLastItemGradingData(String publishedId,
                             String agentId)

Get the last set of itemgradingdata for a student per assessment

getStudentGradingData

public HashMap getStudentGradingData(String assessmentGradingId)

Get the grading data for a given submission

getSubmitData

public HashMap getSubmitData(String publishedId,
                    String agentId,
                    Integer scoringoption,
                    String assessmentGradingId)

Get the last submission for a student per assessment

getTextForId

public String getTextForId(Long typeId)

getSubmissionSizeOfPublishedAssessment

public int getSubmissionSizeOfPublishedAssessment(String publishedAssessmentId)

saveMedia

public Long saveMedia(byte[] media,
             String mimeType)

saveMedia

public Long saveMedia(MediaData mediaData)

getMedia

public MediaData getMedia(String mediaId)

getMediaArray

public ArrayList getMediaArray(String itemGradingId)

getMediaArray2

public ArrayList getMediaArray2(String itemGradingId)

getMediaArray

public ArrayList getMediaArray(ItemGradingData i)

getMediaItemGradingHash

public HashMap getMediaItemGradingHash(Long assessmentGradingId)

getMediaArray

public List<MediaData> getMediaArray(String publishedId,
                            String publishItemId,
                            String which)

getLastItemGradingDataByAgent

public ItemGradingData getLastItemGradingDataByAgent(String publishedItemId,
                                            String agentId)

getItemGradingData

public ItemGradingData getItemGradingData(String assessmentGradingId,
                                 String publishedItemId)

load

public AssessmentGradingData load(String assessmentGradingId)

load

public AssessmentGradingData load(String assessmentGradingId,
                         boolean loadGradingAttachment)

getItemGrading

public ItemGradingData getItemGrading(String itemGradingId)

getLastAssessmentGradingByAgentId

public AssessmentGradingData getLastAssessmentGradingByAgentId(String publishedAssessmentId,
                                                      String agentIdString)

getLastSavedAssessmentGradingByAgentId

public AssessmentGradingData getLastSavedAssessmentGradingByAgentId(String publishedAssessmentId,
                                                           String agentIdString)

getLastSubmittedAssessmentGradingByAgentId

public AssessmentGradingData getLastSubmittedAssessmentGradingByAgentId(String publishedAssessmentId,
                                                               String agentIdString,
                                                               String assessmentGradingId)

saveItemGrading

public void saveItemGrading(ItemGradingData item)

saveOrUpdateAssessmentGrading

public void saveOrUpdateAssessmentGrading(AssessmentGradingData assessment)

saveOrUpdateAssessmentGradingOnly

public void saveOrUpdateAssessmentGradingOnly(AssessmentGradingData assessment)

getAssessmentGradingIds

public List getAssessmentGradingIds(String publishedItemId)

getHighestAssessmentGrading

public AssessmentGradingData getHighestAssessmentGrading(String publishedAssessmentId,
                                                String agentId)

getHighestSubmittedAssessmentGrading

public AssessmentGradingData getHighestSubmittedAssessmentGrading(String publishedAssessmentId,
                                                         String agentId,
                                                         String assessmentGradingId)

getHighestSubmittedAssessmentGrading

public AssessmentGradingData getHighestSubmittedAssessmentGrading(String publishedAssessmentId,
                                                         String agentId)

getItemGradingSet

public Set getItemGradingSet(String assessmentGradingId)

getAssessmentGradingByItemGradingId

public HashMap getAssessmentGradingByItemGradingId(String publishedAssessmentId)

updateItemScore

public void updateItemScore(ItemGradingData gdata,
                   double scoreDifference,
                   PublishedAssessmentIfc pub)

storeGrades

public void storeGrades(AssessmentGradingData data,
               PublishedAssessmentIfc pub,
               HashMap publishedItemHash,
               HashMap publishedItemTextHash,
               HashMap publishedAnswerHash,
               HashMap invalidFINMap,
               ArrayList invalidSALengthList)
                 throws GradebookServiceException,
                        FinFormatException

Assume this is a new item.

Throws:

GradebookServiceException

FinFormatException

storeGrades

public void storeGrades(AssessmentGradingData data,
               PublishedAssessmentIfc pub,
               HashMap publishedItemHash,
               HashMap publishedItemTextHash,
               HashMap publishedAnswerHash,
               boolean persistToDB,
               HashMap invalidFINMap,
               ArrayList invalidSALengthList)
                 throws GradebookServiceException,
                        FinFormatException

Assume this is a new item.

Throws:

GradebookServiceException

FinFormatException

storeGrades

public void storeGrades(AssessmentGradingData data,
               boolean regrade,
               PublishedAssessmentIfc pub,
               HashMap publishedItemHash,
               HashMap publishedItemTextHash,
               HashMap publishedAnswerHash,
               boolean persistToDB)
                 throws GradebookServiceException,
                        FinFormatException

Throws:

GradebookServiceException

FinFormatException

storeGrades

public void storeGrades(AssessmentGradingData data,
               boolean regrade,
               PublishedAssessmentIfc pub,
               HashMap publishedItemHash,
               HashMap publishedItemTextHash,
               HashMap publishedAnswerHash,
               boolean persistToDB,
               HashMap invalidFINMap,
               ArrayList invalidSALengthList)
                 throws GradebookServiceException,
                        FinFormatException

This is the big, complicated mess where we take all the items in an assessment, store the grading data, auto-grade it, and update everything. If regrade is true, we just recalculate the graded score. If it's false, we do everything from scratch.

Throws:

GradebookServiceException

FinFormatException

getAnswerScore

public double getAnswerScore(ItemGradingData data,
                    Map publishedAnswerHash)

This grades multiple choice and true false questions. Since multiple choice/multiple select has a separate ItemGradingData for each choice, they're graded the same way the single choice are. Choices should be given negative score values if one wants them to lose points for the wrong choice.

notifyGradebook

public void notifyGradebook(AssessmentGradingData data,
                   PublishedAssessmentIfc pub)
                     throws GradebookServiceException

Throws:

GradebookServiceException

getFIBScore

public double getFIBScore(ItemGradingData data,
                 Map fibmap,
                 ItemDataIfc itemdata,
                 Map publishedAnswerHash)

This grades Fill In Blank questions. (see SAK-1685) There will be two valid cases for scoring when there are multiple fill in blanks in a question: Case 1- There are different sets of answers (a set can contain one or more item) for each blank (e.g. The {dog|coyote|wolf} howls and the {lion|cougar} roars.) In this case each blank is tested for correctness independently. Case 2-There is the same set of answers for each blank: e.g. The flag of the US is {red|white|blue},{red|white|blue}, and {red|white|blue}. These are the only two valid types of questions. When authoring, it is an ERROR to include: (1) a mixture of independent answer and common answer blanks (e.g. The {dog|coyote|wolf} howls at the {red|white|blue}, {red|white|blue}, and {red|white|blue} flag.) (2) more than one set of blanks with a common answer ((e.g. The US flag is {red|white|blue}, {red|white|blue}, and {red|white|blue} and the Italian flag is {red|white|greem}, {red|white|greem}, and {red|white|greem}.) These two invalid questions specifications should be authored as two separate questions. Here are the definition and 12 cases I came up with (lydia, 01/2006): single answers : roses are {red} and vilets are {blue} multiple answers : {dogs|cats} have 4 legs multiple answers , mutually exclusive, all answers must be identical, can be in diff. orders : US flag has {red|blue|white} and {red |white|blue} and {blue|red|white} colors multiple answers , mutually non-exclusive : {dogs|cats} have 4 legs and {dogs|cats} can be pets. wildcard uses * to mean one of more characters -. wildcard single answer, case sensitive -. wildcard single answer, case insensitive -. single answer, no wildcard , case sensitive -. single answer, no wildcard , case insensitive -. multiple answer, mutually non-exclusive, no wildcard , case sensitive -. multiple answer, mutually non-exclusive, no wildcard , case in sensitive -. multiple answer, mutually non-exclusive, wildcard , case sensitive -. multiple answer, mutually non-exclusive, wildcard , case insensitive -. multiple answer, mutually exclusive, no wildcard , case sensitive -. multiple answer, mutually exclusive, no wildcard , case in sensitive -. multiple answer, mutually exclusive, wildcard , case sensitive -. multiple answer, mutually exclusive, wildcard , case insensitive

getFIBResult

public boolean getFIBResult(ItemGradingData data,
                   HashMap fibmap,
                   ItemDataIfc itemdata,
                   HashMap publishedAnswerHash)

getFINScore

public double getFINScore(ItemGradingData data,
                 ItemDataIfc itemdata,
                 Map publishedAnswerHash)
                   throws FinFormatException

Throws:

FinFormatException

getFINResult

public boolean getFINResult(ItemGradingData data,
                   ItemDataIfc itemdata,
                   Map publishedAnswerHash)
                     throws FinFormatException

Throws:

FinFormatException

validate

public Map validate(String value)

Validate a students numeric answer

Parameters:

The - answer to validate

Returns:

a Map containing either Real or Complex answer keyed by ANSWER_TYPE_REAL or ANSWER_TYPE_COMPLEX

getCalcQScore

public double getCalcQScore(ItemGradingData data,
                   ItemDataIfc itemdata,
                   Map<Integer,String> calculatedAnswersMap,
                   int calcQuestionAnswerSequence)

CALCULATED_QUESTION Returns a double score value for the ItemGrading element being scored for a Calculated Question

Parameters:

calcQuestionAnswerSequence - the order of answers in the list

Returns:

score for the item.

getTotalCorrectScore

public double getTotalCorrectScore(ItemGradingData data,
                          Map publishedAnswerHash)

deleteAll

public void deleteAll(Collection c)

updateAssessmentGradingScore

public void updateAssessmentGradingScore(AssessmentGradingData adata,
                                PublishedAssessmentIfc pub)

saveOrUpdateAll

public void saveOrUpdateAll(Collection c)

getPublishedAssessmentByAssessmentGradingId

public PublishedAssessmentIfc getPublishedAssessmentByAssessmentGradingId(String id)

getPublishedAssessmentByPublishedItemId

public PublishedAssessmentIfc getPublishedAssessmentByPublishedItemId(String publishedItemId)

getLastItemGradingDataPosition

public ArrayList getLastItemGradingDataPosition(Long assessmentGradingId,
                                       String agentId)

getPublishedItemIds

public List getPublishedItemIds(Long assessmentGradingId)

getItemSet

public HashSet getItemSet(Long publishedAssessmentId,
                 Long sectionId)

getTypeId

public Long getTypeId(Long itemGradingId)

fibmatch

public boolean fibmatch(String answer,
               String input,
               boolean casesensitive)

getAllAssessmentGradingByAgentId

public List getAllAssessmentGradingByAgentId(Long publishedAssessmentId,
                                    String agentIdString)

getAllItemGradingDataForItemInGrading

public List<ItemGradingData> getAllItemGradingDataForItemInGrading(Long assesmentGradingId,
                                                          Long publihsedItemId)

getSiteSubmissionCountHash

public HashMap getSiteSubmissionCountHash(String siteId)

getSiteInProgressCountHash

public HashMap getSiteInProgressCountHash(String siteId)

getActualNumberRetake

public int getActualNumberRetake(Long publishedAssessmentId,
                        String agentIdString)

getActualNumberRetakeHash

public HashMap getActualNumberRetakeHash(String agentIdString)

getSiteActualNumberRetakeHash

public HashMap getSiteActualNumberRetakeHash(String siteIdString)

getStudentGradingSummaryData

public List getStudentGradingSummaryData(Long publishedAssessmentId,
                                String agentIdString)

getNumberRetake

public int getNumberRetake(Long publishedAssessmentId,
                  String agentIdString)

getNumberRetakeHash

public HashMap getNumberRetakeHash(String agentIdString)

getSiteNumberRetakeHash

public HashMap getSiteNumberRetakeHash(String siteIdString)

saveStudentGradingSummaryData

public void saveStudentGradingSummaryData(StudentGradingSummaryIfc studentGradingSummaryData)

getLateSubmissionsNumberByAgentId

public int getLateSubmissionsNumberByAgentId(Long publishedAssessmentId,
                                    String agentIdString,
                                    Date dueDate)

getExportResponsesData

public List getExportResponsesData(String publishedAssessmentId,
                          boolean anonymous,
                          String audioMessage,
                          String fileUploadMessage,
                          String noSubmissionMessage,
                          boolean showPartAndTotalScoreSpreadsheetColumns,
                          String poolString,
                          String partString,
                          String questionString,
                          String textString,
                          String rationaleString,
                          String itemGradingCommentsString,
                          Map useridMap)

Parameters:

publishedAssessmentId -

anonymous -

audioMessage -

fileUploadMessage -

noSubmissionMessage -

showPartAndTotalScoreSpreadsheetColumns -

poolString -

partString -

questionString -

textString -

rationaleString -

itemGradingCommentsString -

useridMap -

Returns:

a list of responses or null if there are none

getHasGradingData

public boolean getHasGradingData(Long publishedAssessmentId)

extractCalculations

public List<String> extractCalculations(String text)

extractCalculations() is a utility function for Calculated Questions. It takes one parameter, which is a block of text, and looks for any calculations that are encoded in the text. A calculations is enclosed in [[ ]].

For example, if the passed parameter is {a} + {b} = {{c}}, [[{a}+{b}]], the resulting list would contain one entry: a string of "{a}+{b}"

Formulas must contain at least one variable OR parens OR calculation symbol (*-+/)

Parameters:

text - contents to be searched

Returns:

a list of matching calculations. If no calculations are found, the list will be empty.

extractFormulas

public List<String> extractFormulas(String text)

extractFormulas() is a utility function for Calculated Questions. It takes one parameter, which is a block of text, and looks for any formula names that are encoded in the text. A formula name is enclosed in {{ }}. The formula itself is encoded elsewhere.

For example, if the passed parameter is {a} + {b} = {{c}}, the resulting list would contain one entry: a string of "c"

Formulas must begin with an alpha, but subsequent character can be alpha-numeric

Parameters:

text - contents to be searched

Returns:

a list of matching formula names. If no formulas are found, the list will be empty.

extractVariables

public List<String> extractVariables(String text)

extractVariables() is a utility function for Calculated Questions. It takes one parameter, which is a block of text, and looks for any variable names that are encoded in the text. A variable name is enclosed in { }. The values of the variable are encoded elsewhere.

For example, if the passed parameter is {a} + {b} = {{c}}, the resulting list would contain two entries: strings of "a" and "b"

Variables must begin with an alpha, but subsequent character can be alpha-numeric.

Note - a formula, encoded as {{ }}, will not be mistaken for a variable.

Parameters:

text - content to be searched

Returns:

a list of matching variable names. If no variables are found, the list will be empty

extractInstructionSegments

protected List<String> extractInstructionSegments(String instructions)

CALCULATED_QUESTION Takes the instructions and breaks it into segments, based on the location of formula names. One formula would give two segments, two formulas gives three segments, etc.

Note - in this context, it would probably be easier if any variable value substitutions have occurred before the breakup is done; otherwise, each segment will need to have substitutions done.

Parameters:

instructions - string to be broken up

Returns:

the original string, broken up based on the formula name delimiters

applyPrecisionToNumberString

public String applyPrecisionToNumberString(String numberStr,
                                  int decimalPlaces)

CALCULATED_QUESTION applyPrecisionToNumberString() takes a string representation of a number and returns a string representation of that number, rounded to the specified number of decimal places, including trimming decimal places if needed. Will also throw away the extra trailing zeros as well as removing a trailing decimal point.

Parameters:

numberStr -

decimalPlaces -

Returns:

processed number string (will never be null or empty string)

extractCalcQAnswersArray

public List<String> extractCalcQAnswersArray(Map<Integer,String> answerList,
                                    ItemDataIfc item,
                                    Long gradingId,
                                    String agentId)

CALCULATED_QUESTION This is a busy method. It does three things:
1. It removes the answer expressions ie. {{x+y}} from the question text. This value is returned in the ArrayList texts. This format is necessary so that input boxes can be placed in the text where the {{..}}'s appear.
2. It will call methods to swap out the defined variables with randomly generated values within the ranges defined by the user.
3. It updates the HashMap answerList with the calculated answers in sequence. It will parse and calculate what each answer needs to be.

Note: If a divide by zero occurs. We change the random values and try again. It gets limited chances to get valid values and then will return "infinity" as the answer.

Parameters:

answerList - will enter the method empty and be filled with sequential answers to the question

Returns:

ArrayList of the pieces of text to display surrounding input boxes

isAnswerValid

public boolean isAnswerValid(String answer)

CALCULATED_QUESTION Takes an answer string and checks for the value returned is NaN or Infinity, indicating a Samigo formula parse error Returns false if divide by zero is detected.

replaceMappedVariablesWithNumbers

public String replaceMappedVariablesWithNumbers(String expression,
                                       Map<String,String> variables)

CALCULATED_QUESTION replaceMappedVariablesWithNumbers() takes a string and substitutes any variable names found with the value of the variable. Variables look like {a}, the name of that variable is "a", and the value of that variable is in variablesWithValues

Note - this function comprehends syntax like "5{x}". If "x" is 37, the result would be "5*37"

Parameters:

expression - - the string being substituted into

variables - - Map key is the variable name, value is what will be substituted into the expression.

Returns:

a string with values substituted. If answerExpression is null, returns a blank string (i.e ""). If variablesWithValues is null, returns the original answerExpression

replaceCalculationsWithValues

public String replaceCalculationsWithValues(String expression,
                                   int decimalPlaces)
                                     throws SamigoExpressionError

CALCULATED_QUESTION replaceMappedVariablesWithNumbers() takes a string and substitutes any variable names found with the value of the variable. Variables look like {a}, the name of that variable is "a", and the value of that variable is in variablesWithValues

Note - this function comprehends syntax like "5{x}". If "x" is 37, the result would be "5*37"

Parameters:

expression - - the string which will be scanned for calculations

Returns:

the input string with calculations replaced with number values. If answerExpression is null, returns a blank string (i.e "") and if no calculations are found then original string is returned.

Throws:

IllegalStateException - if the formula value cannot be calculated

SamigoExpressionError - if the formula cannot be parsed

processFormulaIntoValue

public String processFormulaIntoValue(String formula,
                             int decimalPlaces)
                               throws SamigoExpressionError

CALCULATED_QUESTION Process a single formula into a final string representing the calculated value of the formula

Parameters:

formula - the formula to process (e.g. 1 * 2 + 3 - 4), All variable replacement must have already happened

decimalPlaces - number of decimals to include in the final output

Returns:

the value of the formula OR empty string if there is nothing to process

Throws:

IllegalStateException - if the formula value cannot be calculated (typically caused by 0 divisors and the like)

SamigoExpressionError - if the formula cannot be parsed

cleanFormula

public static String cleanFormula(String formula)

Cleans up formula text so that whitespaces are normalized or removed

Parameters:

formula - formula with variables or without

Returns:

the cleaned formula

isNegativeSqrt

public boolean isNegativeSqrt(String expression)
                       throws SamigoExpressionError

isNegativeSqrt() looks at the incoming expression and looks specifically to see if it executes the SQRT function. If it does, it evaluates it. If it has an error, it assumes that the SQRT function tried to evaluate a negative number and evaluated to NaN.

Note - the incoming expression should have no variables. They should have been replaced before this function was called

Parameters:

expression - a mathematical formula, with all variables replaced by real values, to be evaluated

Returns:

true if the function uses the SQRT function, and the SQRT function evaluates as an error; else false

Throws:

SamigoExpressionError - if the evaluation of the SQRT function throws some other parse error

determineRandomValuesForRanges

public Map<String,String> determineRandomValuesForRanges(Map<String,String> variableRangeMap,
                                                long itemId,
                                                long gradingId,
                                                String agentId,
                                                int validAnswersAttemptCount)

CALCULATED_QUESTION Takes a map of ranges and randomly chooses values for those ranges and stores them in a new map.

getHasGradingDataAndHasSubmission

public ArrayList getHasGradingDataAndHasSubmission(Long publishedAssessmentId)

getFileName

public String getFileName(Long itemGradingId,
                 String agentId,
                 String filename)

getUpdatedAssessmentList

public List getUpdatedAssessmentList(String agentId,
                            String siteId)

getSiteNeedResubmitList

public List getSiteNeedResubmitList(String siteId)

autoSubmitAssessments

public void autoSubmitAssessments()

createItemGradingAttachment

public ItemGradingAttachment createItemGradingAttachment(ItemGradingData itemGrading,
                                                String resourceId,
                                                String filename,
                                                String protocol)

removeItemGradingAttachment

public void removeItemGradingAttachment(String attachmentId)

saveOrUpdateAttachments

public void saveOrUpdateAttachments(List list)

getInProgressCounts

public HashMap getInProgressCounts(String siteId)

getSubmittedCounts

public HashMap getSubmittedCounts(String siteId)

completeItemGradingData

public void completeItemGradingData(AssessmentGradingData assessmentGradingData)

getAnswerScoreMCQ

public double getAnswerScoreMCQ(ItemGradingData data,
                       Map publishedAnswerHash)

This grades multiple choice and true false questions. Since multiple choice/multiple select has a separate ItemGradingData for each choice, they're graded the same way the single choice are. BUT since we have Partial Credit stuff around we have to have a separate method here --mustansar Choices should be given negative score values if one wants them to lose points for the wrong choice.

hasDistractors

public boolean hasDistractors(ItemDataIfc item)

hasDistractors looks at an itemData object for a Matching question and determines if all of the choices have correct matches or not.

Parameters:

item -

Returns:

true if any of the choices do not have a correct answer (a distractor choice), or false if all choices have at least one correct answer

isDistractor

public boolean isDistractor(ItemTextIfc itemText)

determines if the passed parameter is a distractor

For ItemTextIfc objects that hold data for matching type questions, a distractor is a choice that has no valid matches (i.e. no correct answers). This function returns if this ItemTextIfc object has any correct answers

Parameters:

itemText -

Returns:

true if itemtext has no correct answers (a distrator) or false if itemtext has at least one correct answer

getUnSubmittedAssessmentGradingDataList

public List getUnSubmittedAssessmentGradingDataList(Long publishedAssessmentId,
                                           String agentIdString)