org.assistments.domain.content.tutor

Class FillInProblem

java.lang.Object

org.assistments.domain.content.tutor.Persistable

org.assistments.domain.content.tutor.Content

org.assistments.domain.content.tutor.AssessmentContent

org.assistments.domain.content.tutor.Problem

org.assistments.domain.content.tutor.AnswerableProblem<FillInAnswerValuePart,FillInAnswer,FillInAnswerValue,FillInResponseValue>

org.assistments.domain.content.tutor.FillInProblem

All Implemented Interfaces:

HasUID, IsPersistable, SelfValidating

public class FillInProblem
extends AnswerableProblem<FillInAnswerValuePart,FillInAnswer,FillInAnswerValue,FillInResponseValue>

Field Summary

Fields inherited from class org.assistments.domain.content.tutor.AnswerableProblem

answerableClasses, probProperties

Fields inherited from class org.assistments.domain.content.tutor.Problem

defaultResponseDescription

Constructor Summary

Constructors

Modifier	Constructor and Description
	FillInProblem(java.lang.String uid) Constructor For use when calling code directly needs an instance of ProblemFillIn.
protected	FillInProblem(java.lang.String classType, java.lang.String uid) Constructor For use when ProblemFillIn has been subclassed.
	FillInProblem(java.lang.String uid, java.lang.String name, java.lang.String description) Constructor For use when calling code directly needs an instance of ProblemFillIn.

Method Summary

Modifier and Type	Method and Description
protected FillInAnswer	addAnswer(java.lang.String uid, boolean isCorrect, FillInAnswerValuePart... valueParts) Given a list of value parts, returns a subclass instance of an Answer containing those values.
FillInAnswer	addAnswer(java.lang.String uid, boolean isCorrect, java.lang.String value)
static java.lang.String	getClassName() Returns this class' fully specified name.
static AnswerableProblemAttributes	getProblemAttributes() Returns the problem type attributes for FillInProblem.
java.util.List<java.lang.String>	getResponseTypeDescription()
boolean	isCorrect(FillInResponseValue response, java.util.Map<java.lang.String,java.lang.String> args) Determines whether the submitted response to this question is correct.
protected FillInResponseValue	makeResponse(java.lang.String... responseParts) For the given values entered, returns an AnswerValue containing those parts.
FillInResponseValue	makeResponse(java.lang.String studentResponse) Creates and returns a student response value.

Methods inherited from class org.assistments.domain.content.tutor.AnswerableProblem

addAnswer, addProperty, getAnswer, getAnswerCount, getAnswerEvalType, getAnswerEvalTypes, getAnswers, getAnswers, getAnswerValuePartsList, getCorrectAnswer, getProblemTypeAttributes, getProblemTypeAttributes, getProperties, getProperty, getResponseEvalType, getResponseEvalTypes, getUnscrambledAnswerIndexes, getUnscrambledAnswerIndexes, getWrongAnswer, isAllowedAnswerEvalType, isAllowedResponseEvalType, isAnswerable, isCorrect, isCorrectDefault, isScrambleAnswers, registerProblemTypeAttributes, setAnswerEvalTypes, setAnswerEvalTypes, setAnswers, setCorrectAnswer, setProperties, setResponseEvalTypes, setResponseEvalTypes, setScrambleAnswers, setWrongAnswer, validate

Methods inherited from class org.assistments.domain.content.tutor.Problem

getQuestion, setQuestion

Methods inherited from class org.assistments.domain.content.tutor.AssessmentContent

initializeContent

Methods inherited from class org.assistments.domain.content.tutor.Content

getDescription, getName, setDescription, setName

Methods inherited from class org.assistments.domain.content.tutor.Persistable

createKey, createKey, equals, extractType, extractUID, getKey, getShortKey, getShortKey, getType, getUID, getValidatorUtilities, setValidatorUtilities, toString, validateKey

Methods inherited from class java.lang.Object

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

Constructor Detail

FillInProblem

public FillInProblem(java.lang.String uid)

Constructor For use when calling code directly needs an instance of ProblemFillIn.

Parameters:

uid - UID of this instance.

FillInProblem

public FillInProblem(java.lang.String uid,
                     java.lang.String name,
                     java.lang.String description)

Constructor For use when calling code directly needs an instance of ProblemFillIn.

Parameters:

uid - UID of this instance.

name - The name given to the problem

description - A short description of the problem

FillInProblem

protected FillInProblem(java.lang.String classType,
                        java.lang.String uid)

Constructor For use when ProblemFillIn has been subclassed. In that case the subclass will need to use this constructor to specify its classType.

Parameters:

classType - Subclass' class type as a fully specified name. For example: org.assistments.core.domain.FillInWithUnitsProblem .

uid -

Method Detail

getProblemAttributes

public static AnswerableProblemAttributes getProblemAttributes()

Returns the problem type attributes for FillInProblem.

This is a convenience method so that a caller can gain access to the problem type attributes without having to first instantiate an instance of FillInProblem.

See Also:

AnswerableProblem.getProblemTypeAttributes(), AnswerableProblem.getProblemTypeAttributes(String)

getClassName

public static java.lang.String getClassName()

Returns this class' fully specified name.

addAnswer

public FillInAnswer addAnswer(java.lang.String uid,
                              boolean isCorrect,
                              java.lang.String value)

Parameters:

uid -

isCorrect -

value -

Returns:

The answer added to this problem.

See Also:

AnswerableProblem.getAnswerEvalTypes()

addAnswer

protected FillInAnswer addAnswer(java.lang.String uid,
                                 boolean isCorrect,
                                 FillInAnswerValuePart... valueParts)

Description copied from class: AnswerableProblem

Given a list of value parts, returns a subclass instance of an Answer containing those values.

It is highly recommended that each AnswerableProblem subclass implements a custom, public version of the addAnswer(...) method which hides from the calling code the variable arguments AnswerValuePart... valueParts.

For example, a fill in problem would implement:

public FillInAnswer addAnswer(String uid, boolean isCorrect, String value)

The implementation of this abstract method would be responsible for obtaining the evaluation type, and the subsequent creation of an AnswerValuePart.

Specified by:

addAnswer in class AnswerableProblem<FillInAnswerValuePart,FillInAnswer,FillInAnswerValue,FillInResponseValue>

Parameters:

uid - Unique identifier for this answer

valueParts - The value parts comprising this answer.

Returns:

For informational purposes, the newly create Answer

See Also:

AnswerableProblem.getAnswerEvalTypes(), AnswerValuePart

makeResponse

public FillInResponseValue makeResponse(java.lang.String studentResponse)

Creates and returns a student response value.

Parameters:

studentResponse - The fill-in value entered by a student.

makeResponse

protected FillInResponseValue makeResponse(java.lang.String... responseParts)

Description copied from class: AnswerableProblem

For the given values entered, returns an AnswerValue containing those parts.

Specified by:

makeResponse in class AnswerableProblem<FillInAnswerValuePart,FillInAnswer,FillInAnswerValue,FillInResponseValue>

Parameters:

responseParts - One or more values entered in response to a question. For example, a fill-in problem expects a single response string. An ordered pair problem expects two response strings.

Returns:

A subclass of AnswerValue. By convention the subclass should be named: <problem name>StudentResponseValue

isCorrect

public boolean isCorrect(FillInResponseValue response,
                         java.util.Map<java.lang.String,java.lang.String> args)

Description copied from class: AnswerableProblem

Determines whether the submitted response to this question is correct.

If your problem type defines correctness as when the student's response matches any one of the answers marked as a correct answer, then your subclass can implement this method to call #isCorrectDefault(StudentResponseValue).

If your problem type requires a different semantic for determining correctness, you must implement that logic yourself in isCorrect(). In this case, your implementation may want (or need) to call AnswerableProblem.setWrongAnswer(Answer) so that a common wrong answer is available later to a caller.

Specified by:

isCorrect in class AnswerableProblem<FillInAnswerValuePart,FillInAnswer,FillInAnswerValue,FillInResponseValue>

Parameters:

response - The student's response to compare to this problem's answer list.

args - Map for problem specific properties that will be used in calculating correctness for the problem.

Returns:

true if the response matches one of the correct answers; otherwise false

See Also:

#isCorrectDefault(StudentResponseValue), AnswerableProblem.setWrongAnswer(Answer)

getResponseTypeDescription

public java.util.List<java.lang.String> getResponseTypeDescription()

Specified by:

getResponseTypeDescription in class Problem