org.assistments.domain.content.tutor

Class Answer<P extends AnswerValuePart,V extends TeacherAnswerValue<P,R>,R extends StudentResponseValue<P>>

java.lang.Object

org.assistments.domain.content.tutor.Persistable

org.assistments.domain.content.tutor.Content

org.assistments.domain.content.tutor.Answer<P,V,R>

Type Parameters:

P - A subclass of AnswerValuePart representing a single part of an answer's or response's value.

V - A subclass of TeacherAnswerValue implementing a problem type-specific answer value.

R - A subclass of StudentResponseValue implementing a problem type-specific student response.

All Implemented Interfaces:

HasBuggyMessage, HasUID, IsPersistable, SelfValidating

Direct Known Subclasses:

ChooseNAnswer, ExternalAnswer, FillInAnswer, FillInUnitsAnswer, PlusMinusRangeAnswer, RangeAnswer

public abstract class Answer<P extends AnswerValuePart,V extends TeacherAnswerValue<P,R>,R extends StudentResponseValue<P>>
extends Content
implements HasBuggyMessage

Answer is the base class for creating problem type-specific answers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Answer(java.lang.String classType, java.lang.String uid) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBuggyMessage() Returns the message text
boolean	getIsCorrect() Returns whether this Answer is a correct answer.
V	getTeacherValue() Returns the value for this Answer.
protected Pair<java.lang.Boolean,java.lang.Boolean>	isCorrect(R response, java.util.Map<java.lang.String,java.lang.String> args) Determines whether the submitted response is correct.
protected abstract boolean	isMatch(R response, java.util.Map<java.lang.String,java.lang.String> args) Determines whether the provided response (that is to say the student's response to a question) matches this Answer.
protected boolean	isMatchDefault(R response, java.util.Map<java.lang.String,java.lang.String> args) Provides a default implementation for #isMatch(StudentResponseValue).
protected static boolean	preventIsMatch(java.lang.String className) Provides a default method to be called from a subclass implementation of Answer#isMatch(StudentResponseValue), TeacherAnswerValue#isMatch(StudentResponseValue), or AnswerValuePart#isMatch(AnswerValuePart) when that subclass' problem type by-passes the need for any one (or more) of those isMatch() implementation.
void	setBuggyMessage(java.lang.String buggyMessage) Sets the buggy message associated with an object.
void	setCorrect(boolean correct) Specifies whether this Answer is a correct answer.
void	setTeacherValue(V value) Specifies this Answer's value
java.lang.String	toString() Returns a string representation of this object.

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, validate, validateKey

Methods inherited from class java.lang.Object

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

Constructor Detail

Answer

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

Constructor

Parameters:

classType - Concrete subclass' fully specified class type

uid - Unique identifier for this Answer

Method Detail

setTeacherValue

public void setTeacherValue(V value)

Specifies this Answer's value

Parameters:

value - An AnswerValue concrete subclass

See Also:

getTeacherValue()

getTeacherValue

public V getTeacherValue()

Returns the value for this Answer.

See Also:

setTeacherValue(TeacherAnswerValue)

getIsCorrect

public boolean getIsCorrect()

Returns whether this Answer is a correct answer.

See Also:

setCorrect(boolean)

setCorrect

public void setCorrect(boolean correct)

Specifies whether this Answer is a correct answer.

Parameters:

correct - true if this Answer is correct; otherwise false

getBuggyMessage

public java.lang.String getBuggyMessage()

Description copied from interface: HasBuggyMessage

Returns the message text

Specified by:

getBuggyMessage in interface HasBuggyMessage

See Also:

HasBuggyMessage.setBuggyMessage(String)

setBuggyMessage

public void setBuggyMessage(java.lang.String buggyMessage)

Description copied from interface: HasBuggyMessage

Sets the buggy message associated with an object.

Specified by:

setBuggyMessage in interface HasBuggyMessage

Parameters:

buggyMessage - The error message

See Also:

HasBuggyMessage.getBuggyMessage()

isMatch

protected abstract boolean isMatch(R response,
                                   java.util.Map<java.lang.String,java.lang.String> args)

Determines whether the provided response (that is to say the student's response to a question) matches this Answer. A response matching an answer does not mean the answer is correct; only that the specified response matches this Answer.

Parameters:

response - A subclass of AnswerValue

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

Returns:

true if response matches this answer; otherwise false

See Also:

#isMatchDefault(StudentResponseValue), #isCorrect(StudentResponseValue)

isMatchDefault

protected boolean isMatchDefault(R response,
                                 java.util.Map<java.lang.String,java.lang.String> args)

Provides a default implementation for #isMatch(StudentResponseValue).

A student's response matches this answer if all the value parts match.

Parameters:

response - The student's response to match to this answer.

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

Returns:

true if response matches this answer if each of the response's value part matches this answer's corresponding value part; otherwise false.

See Also:

#isMatch(StudentResponseValue), TeacherAnswerValue#isMatch(StudentResponseValue)

preventIsMatch

protected static boolean preventIsMatch(java.lang.String className)
                                 throws java.lang.IllegalStateException

Provides a default method to be called from a subclass implementation of Answer#isMatch(StudentResponseValue), TeacherAnswerValue#isMatch(StudentResponseValue), or AnswerValuePart#isMatch(AnswerValuePart) when that subclass' problem type by-passes the need for any one (or more) of those isMatch() implementation. For example: If AnswerableProblem.isCorrect(StudentResponseValue) fully processes the student's response without the need to call isMatch(), then the Answer subclass implementation of Answer#isMatch(StudentResponseValue) would call preventIsMatch().

Parameters:

className - The subclass' class name.

Throws:

java.lang.IllegalStateException - If a call is made to isMatch() since the current problem type implementation does not expect that to happen.

isCorrect

protected Pair<java.lang.Boolean,java.lang.Boolean> isCorrect(R response,
                                                              java.util.Map<java.lang.String,java.lang.String> args)

Determines whether the submitted response is correct.

Parameters:

response - Value to be compared to the expected answer.

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

Returns:

A pair of booleans where:

1. The first boolean is true if response is a correct answer; otherwise false.
2. The second boolean is true if response matches this answer; otherwise false.

See Also:

#isMatch(StudentResponseValue), setCorrect(boolean)

toString

public java.lang.String toString()

Description copied from class: Persistable

Returns a string representation of this object.

Specified by:

toString in interface IsPersistable

Overrides:

toString in class Persistable