Merge pull request sakaiproject#1295 from davnavarro/SAM-2656

SAM-2656 SamLite: required rationale in multiple choice questions and true/false questions

Author: ern

samigo/samigo-api/src/java/org/sakaiproject/tool/assessment/samlite/api/Question.java

@@ -34,7 +34,8 @@ public class Question {
 	private String feedbackOK;
 	private String feedbackNOK;
 	private boolean randomize;
-	
+	private boolean rationale;
+
 	public Question() {
 		this.questionNumber = 0;
 		this.questionPoints = "";
@@ -135,6 +136,14 @@ public int getQuestionType() {
 	public void setQuestionType(int questionType) {
 		this.questionType = questionType;
 	}
+
+	public boolean isRationale() {
+		return rationale;
+	}
+
+	public void setRationale(boolean rationale) {
+		this.rationale = rationale;
+	}
 
 	public void postProcessing() {
 		if (getQuestionType() == EXTENDED_MATCHING_ITEMS_QUESTION) {

samigo/samigo-app/src/java/org/sakaiproject/tool/assessment/bundle/SamLite.properties

@@ -22,6 +22,7 @@ general_instructions_feedback=To add correct feedback you need to add a line lik
 example_mc_label=Multiple Choice
 example_mc_instructions=Each answer should begin with its appropriate letter, in alphabetical order. The correct answer should be prefixed with an asterisk (*).
 example_mc_instructions_1=Optionally, the key word \#randomize will create questions with randomized answers
+example_mc_instructions_2=Optionally, the key word \#rationale will create questions with required rationale
 example_mc_question_format1=Question 1 (10 points) (2.5 discount)
 example_mc_question_format2=Question (10 points) (2.5 discount)
 example_mc_question_format3=Question 1
@@ -33,10 +34,12 @@ example_mc_answer_b=b. Jefferson
 example_mc_answer_c=c. Lincoln 
 example_mc_answer_d=d. Clinton
 example_mc_question_random=\#randomize
+example_mc_question_rationale=\#rationale
 
 example_mcmc_label=Multiple Correct Answer
 example_mcmc_instructions=Each answer should begin with its appropriate letter, in alphabetical order. The correct answer should be prefixed with an asterisk (*).
 example_mcmc_instructions_1=Optionally, the key word \#randomize will create questions with randomized answers
+example_mcmc_instructions_2=Optionally, the key word \#rationale will create questions with required rationale
 example_mcmc_question_format1=Question 2 (15 points) 
 example_mcmc_question_format2=Question (15 points)
 example_mcmc_question_format3=Question 2
@@ -47,6 +50,7 @@ example_mcmc_answer_a=*a. Bill Faulkner
 example_mcmc_answer_b=b. Ginny Woolf 
 example_mcmc_answer_c=*c. Tom Eliot
 example_mcmc_question_random=\#randomize
+example_mcmc_question_rationale=\#rationale
 
 example_fib_label=Fill in the Blank
 example_fib_instructions=The correct answer should be prefixed with an asterisk (*).

samigo/samigo-app/src/java/org/sakaiproject/tool/assessment/bundle/SamLite_ca.properties

@@ -22,6 +22,7 @@ general_instructions_conclude=El text de la pregunta es pot posar a la mateixa l
 example_mc_label=Selecci\u00f3 m\u00faltiple 
 example_mc_instructions=Cada resposta ha de comen\u00e7ar amb la lletra apropiada, en ordre alfab\u00e8tic. La resposta correcta ha de dur al davant un asterisc(*).
 example_mc_instructions_1=Opcionalment, la paraula clau \#aleatorizar crear\u00e0 preguntes amb les respostes aleatorizades
+example_mc_instructions_2=Opcionalment, la paraula clau \#raonament crear\u00E0 preguntes amb el raonament requerit
 example_mc_question_format1=Pregunta 1 (10 punts) (2.5 descompte)
 example_mc_question_format2=Pregunta (10 punts) (2.5 descompte)
 example_mc_question_format3=Pregunta 1
@@ -33,10 +34,12 @@ example_mc_answer_b=b. Jefferson
 example_mc_answer_c=c. Lincoln 
 example_mc_answer_d=d. Clinton 
 example_mc_question_random=\#aleatorizar
+example_mc_question_rationale=\#raonament
 
 example_mcmc_label=Resposta correcta m\u00faltiple
 example_mcmc_instructions=Cada resposta ha de comen\u00e7ar amb la lletra apropiada, en ordre alfab\u00e8tic. La resposta correcta ha de dur al davant un asterisc (*).
 example_mcmc_instructions_1=Opcionalment, la paraula clau \#aleatorizar crear\u00e0 preguntes amb les respostes aleatorizades
+example_mcmc_instructions_2=Opcionalment, la paraula clau \#raonament crear\u00E0 preguntes amb el raonament requerit
 example_mcmc_question_format1=Pregunta 2 (15 punts) 
 example_mcmc_question_format2=Pregunta (15 punts) 
 example_mcmc_question_format3=Pregunta 2
@@ -47,6 +50,7 @@ example_mcmc_answer_a=*a. Bill Faulkner
 example_mcmc_answer_b=b. Ginny Woolf 
 example_mcmc_answer_c=*c. Tom Eliot 
 example_mcmc_question_random=\#aleatorizar
+example_mcmc_question_rationale=\#raonament
 
 example_fib_label=Ompliu l'espai en blanc
 example_fib_instructions=La resposta correcta ha de dur al davant un asterisc (*).

samigo/samigo-app/src/java/org/sakaiproject/tool/assessment/bundle/SamLite_es.properties

@@ -22,6 +22,7 @@ general_instructions_feedback=Para a\u00f1adir comentarios en caso de respuesta
 example_mc_label=Selecci\u00f3n M\u00faltiple
 example_mc_instructions=Cada respuesta debe comenzar con su letra apropiada, en orden alfab\u00e9tico. La respuesta correcta debe ir precedida de un asterisco (*).
 example_mc_instructions_1=Opcionalmente, la palabra clave  \#randomize crear\u00e1 preguntas con las respuestas ordenadas de forma aleatoria.
+example_mc_instructions_2=Opcionalmente, la palabra clave \#razonamiento crear\u00E1 preguntas con el razonamiento requerido.
 example_mc_question_format1=Pregunta 1 (10 puntos) (2.5 descuento)
 example_mc_question_format2=Pregunta (10 puntos) (2.5 descuento)
 example_mc_question_format3=Pregunta 1
@@ -33,10 +34,12 @@ example_mc_answer_b=b. Hernan Cort\u00e9s
 example_mc_answer_c=c. Carlo Magno 
 example_mc_answer_d=d. Julio C\u00e9sar 
 example_mc_question_random=\#randomize
+example_mc_question_rationale=\#razonamiento
 
 example_mcmc_label=M\u00faltiple respuesta correcta 
 example_mcmc_instructions=Cada respuesta debe comenzar por sus letra apropiada, en \norden alfab\u00e9tico. La respuestas correctas deben ir precedidas de un asterisco (*).
 example_mcmc_instructions_1=Opcionalmente, la palabra clave  \#randomize crear\u00e1 preguntas con las respuestas ordenadas de forma aleatoria.
+example_mcmc_instructions_2=Opcionalmente, la palabra clave \#razonamiento crear\u00E1 preguntas con el razonamiento requerido
 example_mcmc_question_format1=Pregunta 2 (15 puntos) 
 example_mcmc_question_format2=Pregunta (15 puntos)
 example_mcmc_question_format3=Pregunta 2
@@ -47,6 +50,7 @@ example_mcmc_answer_a=*a. Camilo Jos\u00e9 Cela
 example_mcmc_answer_b=b. William Shakespeare 
 example_mcmc_answer_c=*c. Miguel de Unamuno 
 example_mcmc_question_random=\#randomize
+example_mcmc_question_rationale=\#razonamiento
 
 example_fib_label=Completar los espacios en blanco
 example_fib_instructions=La respuesta correcta debe ir precedida de un asterisco (*).

samigo/samigo-app/src/webapp/jsf/samlite/samLiteEntry.jsp

@@ -136,15 +136,17 @@
 					    <div id="example_mc_question" class="inopPanel" style="display:none">
 					    	<strong><h:outputText value="#{samLiteMessages.example_instruction_label}"/></strong>
 					    	<h:outputText value="#{samLiteMessages.example_mc_instructions}"/><br/>
-					    	<h:outputText value="#{samLiteMessages.example_mc_instructions_1}"/><p/>
+					    	<h:outputText value="#{samLiteMessages.example_mc_instructions_1}"/><br/>
+					    	<h:outputText value="#{samLiteMessages.example_mc_instructions_2}"/><p/>
 				   			<strong><h:outputText value="#{samLiteMessages.example_example_label}"/></strong><br/>
 				   			<h:outputText value="#{samLiteMessages.example_mc_question_format4}"/><br/>
 				   			<h:outputText value="#{samLiteMessages.example_mc_question_text}"/><p/>
 				   			<h:outputText value="#{samLiteMessages.example_mc_answer_a}"/><br/>
 				   			<h:outputText value="#{samLiteMessages.example_mc_answer_b}"/><br/>
 				   			<h:outputText value="#{samLiteMessages.example_mc_answer_c}"/><br/>
 				   			<h:outputText value="#{samLiteMessages.example_mc_answer_d}"/><br/>
-				   			<h:outputText value="#{samLiteMessages.example_mc_question_random}"/>
+				   			<h:outputText value="#{samLiteMessages.example_mc_question_random}"/><br/>
+				   			<h:outputText value="#{samLiteMessages.example_mc_question_rationale}"/>
 				   		</div>
 				    </td>
 				</tr>
@@ -154,14 +156,16 @@
 						    <div id="example_mcmc_question" class="inopPanel" style="display:none">
 				    			<strong><h:outputText value="#{samLiteMessages.example_instruction_label}"/></strong>
 				    			<h:outputText value="#{samLiteMessages.example_mcmc_instructions}"/><br/>
-				    			<h:outputText value="#{samLiteMessages.example_mcmc_instructions_1}"/><p/>
+				    			<h:outputText value="#{samLiteMessages.example_mcmc_instructions_1}"/><br/>
+				    			<h:outputText value="#{samLiteMessages.example_mcmc_instructions_2}"/><p/>
 				    			<strong><h:outputText value="#{samLiteMessages.example_example_label}"/></strong><br/>
 				    			<h:outputText value="#{samLiteMessages.example_mcmc_question_format4}"/><br/>
 				    			<h:outputText value="#{samLiteMessages.example_mcmc_question_text}"/><p/>
 				    			<h:outputText value="#{samLiteMessages.example_mcmc_answer_a}"/><br/>
 				    			<h:outputText value="#{samLiteMessages.example_mcmc_answer_b}"/><br/>
 				    			<h:outputText value="#{samLiteMessages.example_mcmc_answer_c}"/><br/>
 				    			<h:outputText value="#{samLiteMessages.example_mcmc_question_random}"/><br/>
+				    			<h:outputText value="#{samLiteMessages.example_mcmc_question_rationale}"/><br/>
 				    		</div>
 					    </td>
 					  </tr>
@@ -192,12 +196,15 @@
 					  	<td align="left" valign="top">
 						    <a href="javascript:toggleLayer('example_tf_question');"><h:outputText value="#{samLiteMessages.example_tf_label}"/></a>
 						    <div id="example_tf_question" class="inopPanel" style="display:none">
-				    			<strong><h:outputText value="#{samLiteMessages.example_instruction_label}"/></strong><h:outputText value="#{samLiteMessages.example_tf_instructions}"/><p/>
+				    			<strong><h:outputText value="#{samLiteMessages.example_instruction_label}"/>
+				    			</strong><h:outputText value="#{samLiteMessages.example_tf_instructions}"/><br/>
+				    			<h:outputText value="#{samLiteMessages.example_mcmc_instructions_2}"/><p/>
 				    			<strong><h:outputText value="#{samLiteMessages.example_example_label}"/></strong><br/>
 				    			<h:outputText value="#{samLiteMessages.example_tf_question_format4}"/><br/>
 				    			<h:outputText value="#{samLiteMessages.example_tf_question_text}"/><p/>
 				    			<h:outputText value="#{samLiteMessages.example_tf_answer_a}"/><br/>
-				    			<h:outputText value="#{samLiteMessages.example_tf_answer_b}"/>
+				    			<h:outputText value="#{samLiteMessages.example_tf_answer_b}"/><br/>
+				    			<h:outputText value="#{samLiteMessages.example_mcmc_question_rationale}"/><br/>
 				    		</div>
 					    </td>
 					  </tr>

samigo/samlite-impl/src/java/org/sakaiproject/tool/assessment/bundle/SamLitePatternMessages.properties

@@ -3,6 +3,7 @@ question=Question
 points=point(s?)
 discount=discount(s?)
 randomize=\#randomize
+rationale=\#rationale
 save_answer=Save answer
 true=True
 false=False

samigo/samlite-impl/src/java/org/sakaiproject/tool/assessment/bundle/SamLitePatternMessages_ca.properties

@@ -7,4 +7,5 @@ save_answer=Desa la resposta
 true=Veritat
 false=Fals
 randomize=\#aleatorizar
+rationale=\#raonament
 

samigo/samlite-impl/src/java/org/sakaiproject/tool/assessment/bundle/SamLitePatternMessages_es.properties

@@ -3,6 +3,7 @@ question=Pregunta
 points=Punto(s?)
 discount=Descuento(s?)
 randomize=\#randomize
+rationale=\#razonamiento
 save_answer=Guardar la respuesta
 true=Verdadero
 false=Falso

samigo/samlite-impl/src/java/org/sakaiproject/tool/assessment/samlite/impl/SamLiteServiceImpl.java

@@ -79,6 +79,7 @@ public class SamLiteServiceImpl implements SamLiteService {
 	private Pattern discountPattern;
 	String realPatternString = "((\\+||\\-)?(\\d+((\\.|\\,)\\d+)?)((E|e)(\\-|\\+)?\\d+)?)";
 	private Pattern randomizePattern;
+	private Pattern rationalePattern;
 
 	private Pattern extendedMatchingCorrectAnswersPattern;
 
@@ -192,7 +193,12 @@ public QuestionGroup parse(String name, String description, String data) {
 		unnecessaryFalsePattern = Pattern.compile("^" + stFalse + "$");
 		String txtRandomize = rb.getString("randomize", "#randomize");
 		randomizePattern = Pattern.compile("^" + txtRandomize + "$", Pattern.CASE_INSENSITIVE);
-		
+		String txtRationale = rb.getString("rationale", "#rationale");
+		rationalePattern = Pattern.compile("^" + txtRationale + "$", Pattern.CASE_INSENSITIVE);
+
+
+
+
 		QuestionGroup questionGroup = new QuestionGroup(name, description);
 
 		String cleanData = data; 
@@ -274,6 +280,7 @@ private void parseLine(Question question, String line) {
 		Matcher feedbackNOKMatcher = feedbackNOKPattern.matcher(line);
 		boolean hasfeedbackNOK = feedbackNOKMatcher.find();
 		boolean randomize = randomizePattern.matcher(line).find();
+		boolean rationale = rationalePattern.matcher(line).find();
 
 		boolean isEMICorrectAnswer = extendedMatchingCorrectAnswersPattern.matcher(line).find();
 
@@ -337,7 +344,21 @@ private void parseLine(Question question, String line) {
 				question.getQuestionType() == Question.MULTIPLE_CHOICE_MULTIPLE_ANSWER_QUESTION) {
 				question.setRandomize(randomize);
 			}
-		} else {
+
+
+		} else if (rationale) {
+			if (question.getQuestionType() == Question.MULTIPLE_CHOICE_QUESTION || 
+					question.getQuestionType() == Question.MULTIPLE_CHOICE_MULTIPLE_ANSWER_QUESTION || 
+					question.getQuestionType() == Question.TRUE_FALSE_QUESTION) {
+				question.setRationale(rationale);
+			}
+
+			
+		}
+
+
+
+		else {
 			// If we didn't match anything, then assume it's just part of the question text
 			question.append(line);
 		}
@@ -728,6 +749,7 @@ private void processTrueFalseQuestion(SectionType section, Question question) {
 
 		buildMetaDataField(qtiMetaData, "qmd_itemtype", "True False");
 		buildMetaDataField(qtiMetaData, "TEXT_FORMAT", "HTML");
+		buildMetaDataField(qtiMetaData, "hasRationale", Boolean.valueOf(question.isRationale()).toString());
 
 		ItemrubricType itemRubric = item.addNewItemrubric();
 		itemRubric.setView(ItemrubricType.View.ALL);
@@ -754,7 +776,7 @@ private void processMultipleChoiceQuestion(SectionType section, Question questio
 
 		buildMetaDataField(qtiMetaData, "qmd_itemtype", "Multiple Choice");
 		buildMetaDataField(qtiMetaData, "TEXT_FORMAT", "HTML");
-		buildMetaDataField(qtiMetaData, "hasRationale", "False");
+		buildMetaDataField(qtiMetaData, "hasRationale", Boolean.valueOf(question.isRationale()).toString());
 		buildMetaDataField(qtiMetaData, ItemMetaDataIfc.RANDOMIZE, Boolean.valueOf(question.isRandomize()).toString());
 
 		ItemrubricType itemRubric = item.addNewItemrubric();
@@ -786,7 +808,7 @@ private void processMultipleChoiceMultipleAnswerQuestion(SectionType section, Qu
 
 		buildMetaDataField(qtiMetaData, "qmd_itemtype", "Multiple Correct Answer");
 		buildMetaDataField(qtiMetaData, "TEXT_FORMAT", "HTML");
-		buildMetaDataField(qtiMetaData, "hasRationale", "False");
+		buildMetaDataField(qtiMetaData, "hasRationale", Boolean.valueOf(question.isRationale()).toString());
 		buildMetaDataField(qtiMetaData, ItemMetaDataIfc.RANDOMIZE, Boolean.valueOf(question.isRandomize()).toString());
 
 		ItemrubricType itemRubric = item.addNewItemrubric();