org.assistments.domain.content.tutor

Class AnswerValuePart

java.lang.Object

org.assistments.domain.content.tutor.AnswerValuePart

All Implemented Interfaces:

java.lang.Comparable<AnswerValuePart>

Direct Known Subclasses:

ChooseNAnswerValuePart, ExternalAnswerValuePart, FillInAnswerValuePart, FillInUnitsAnswerValuePart, PlusMinusRangeAnswerValuePart, RangeAnswerValuePart

public abstract class AnswerValuePart
extends java.lang.Object
implements java.lang.Comparable<AnswerValuePart>

AnswerValuePart represents one piece of data making up an answer value.

Each problem type defines the number of value parts that define a teacher (or content builder) answer value and the number of value parts expected in each student response to that problem type.

Each AnswerValuePart is composed of a value, represented as a String and a type which specifies how to evaluate the value.

See Also:

AnswerEvalType, AnswerValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnswerValuePart() Constructor
protected	AnswerValuePart(AnswerEvalType type, java.lang.String value) Constructor

Method Summary

Modifier and Type	Method and Description
int	compareTo(AnswerValuePart other) Compares another value part to this value part.
boolean	equals(java.lang.Object other) Returns whether the specified object is equivalent to this AnswerValuePart.
AnswerEvalType	getType() Returns this part's evaluation type.
java.lang.String	getValue() Returns this part's data value
protected abstract boolean	isMatch(AnswerValuePart response, java.util.Map<java.lang.String,java.lang.String> args) Determines whether the provided value part (that is to say a value part from the student's response to a question) matches this value part.
protected boolean	isMatchDefault(AnswerValuePart response, java.util.Map<java.lang.String,java.lang.String> args) Default method to determine whether a value part from a student's response matches this value part.
static Pair<BooleanResult,java.lang.Boolean>	isValid(AnswerValuePart avp) Calls isValid with the second parameter set to true.
static Pair<BooleanResult,java.lang.Boolean>	isValid(AnswerValuePart avp, boolean appendAnswer) Validates that the evaluation type specified in an answer value part is a known type and that the value (the data) is of that type.
void	setType(AnswerEvalType type) Sets this part's evaluation type.
protected void	setValue(java.lang.String value) Sets this part's data value
java.lang.String	toString() Returns a string representation of this value part.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnswerValuePart

protected AnswerValuePart()

Constructor

AnswerValuePart

protected AnswerValuePart(AnswerEvalType type,
                          java.lang.String value)

Constructor

Parameters:

type - The part's evaluation type

value - The part's value

Method Detail

setType

public void setType(AnswerEvalType type)

Sets this part's evaluation type.

Parameters:

type - The evaluation type.

See Also:

getType()

getType

public AnswerEvalType getType()

Returns this part's evaluation type.

See Also:

setType(AnswerEvalType)

setValue

protected void setValue(java.lang.String value)

Sets this part's data value

Parameters:

value - The part's value

See Also:

getValue()

getValue

public java.lang.String getValue()

Returns this part's data value

See Also:

setValue(String)

isValid

public static Pair<BooleanResult,java.lang.Boolean> isValid(AnswerValuePart avp)
                                                     throws java.lang.IllegalStateException,
                                                            java.lang.UnsupportedOperationException

Calls isValid with the second parameter set to true.

Throws:

java.lang.IllegalStateException

java.lang.UnsupportedOperationException

isValid

public static Pair<BooleanResult,java.lang.Boolean> isValid(AnswerValuePart avp,
                                                            boolean appendAnswer)
                                                     throws java.lang.IllegalStateException,
                                                            java.lang.UnsupportedOperationException

Validates that the evaluation type specified in an answer value part is a known type and that the value (the data) is of that type.

Parameters:

avp - The answer value part to validate

appendAnswer - boolean to decide whether or not to append the value of the answerValuePart to the end of the error message.

Returns:

true if the answer value part type is knownn and the value is of that type; otherwise false

Throws:

java.lang.IllegalStateException - on an unknown or undefined evaluation type.

java.lang.UnsupportedOperationException - if the evaluation type is a defined type, but not currently supported by the application.

isMatch

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

Determines whether the provided value part (that is to say a value part from the student's response to a question) matches this value part.

Your subclass can implement this method by calling the default method #isMatchDefault(AnswerValuePart).

Parameters:

response - An answer value part from the student's response.

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

See Also:

#isMatchDefault(AnswerValuePart), Answer.preventIsMatch(String), TeacherAnswerValue#isMatch(StudentResponseValue), Answer#isMatch(StudentResponseValue)

isMatchDefault

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

Default method to determine whether a value part from a student's response matches this value part.

isMatchDefault() assumes that the evaluation types of both value parts are compatible. That is to say isMatchDefault() expects:

• both value parts to be AnswerEvalType.STRING, or
• both value parts to be AnswerEvalType.ALGEBRA, or
• both value parts to be AnswerEvalType.NUMERIC, or
• both value parts to be AnswerEvalType.EXPRESSION, or
• both value parts to be AnswerEvalType.NUMERIC_OR_EXPRESSION, or
• one value part to be AnswerEvalType.NUMERIC and the other value part to be AnswerEvalType.NUMERIC_OR_EXPRESSION

Parameters:

response - The response value part to compare to this answer value part.

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

Returns:

true if response matches this value part; otherwise false

See Also:

#isMatch(AnswerValuePart), TeacherAnswerValue#isMatchDefault(StudentResponseValue), Answer#isMatchDefault(StudentResponseValue)

compareTo

public int compareTo(AnswerValuePart other)

Compares another value part to this value part.

Specified by:

compareTo in interface java.lang.Comparable<AnswerValuePart>

Parameters:

other - The other value part

See Also:

Comparable.compareTo(Object)

equals

public boolean equals(java.lang.Object other)

Returns whether the specified object is equivalent to this AnswerValuePart.

Overrides:

equals in class java.lang.Object

Parameters:

other - The object to compare to this instance.

Returns:

true if other refers to this instance or all of the data members of other are identical to the values in this instance.

toString

public java.lang.String toString()

Returns a string representation of this value part.

Overrides:

toString in class java.lang.Object