org.assistments.domain.content.tutor

Class AnswerValue<P extends AnswerValuePart>

java.lang.Object

org.assistments.domain.content.tutor.AnswerValue<P>

Direct Known Subclasses:

StudentResponseValue, TeacherAnswerValue

public abstract class AnswerValue<P extends AnswerValuePart>
extends java.lang.Object

AnswerValue is base class for creating problem type-specific answer values.

An AnswerValue contains one or more data parts kept as a List of AnswerValueParts.

The direct subclasses of AnswerValue, TeacherAnswerValue and StudentResponseValue provide base classes to separately define concrete classes representing teacher (or content builder) provided answer values vs the expected form of a student's response.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AnswerValue() Constructor
protected	AnswerValue(java.util.List<P> valueParts) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
protected P	getValuePart() Returns the first value part of this answer.
protected P	getValuePart(int index) Returns the value part, at the specified position, of this answer.
java.util.List<P>	getValueParts() Returns the list of AnswerValueParts making up this AnswerValue.
int	getValuePartsCount() Returns the number of value parts in this answer value.
protected AnswerEvalType	getValuePartType() Returns the evaluation type of the first value part of this answer.
protected AnswerEvalType	getValuePartType(int index) Returns the evaluation type of the value part, at the specified position, of this answer.
protected java.lang.String	getValuePartValue() Returns the data value of the first value part of this answer.
protected java.lang.String	getValuePartValue(int index) Returns the data value of the value part, at the specified position, of this answer.
int	hashCode()
protected abstract boolean	isAllowedEvalType(AnswerEvalType evalType) Returns whether an evaluation type is allowed for responses to this problem.
java.util.List<P>	partsToList(P... parts) Creates and returns a List of AnswerValueParts.
void	setValueParts(java.util.List<P> valueParts) Specifies the value parts that makes up this answer value.
void	setValueParts(P... valueParts) Specifies the value parts that makes up this answer value.
java.lang.String	toString()
java.lang.String	toViewString() Returns an end-user readable representation of the String value of each AnswerValuePart
protected abstract void	validatePartsCount() Validates whether count of value parts in this answer value match the expected count for this type of answer value.
protected abstract void	validatePartsCount(java.util.List<P> valueParts) Validates whether specified list contains exactly the correct number of value parts expected for this type of answer value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnswerValue

public AnswerValue()

Constructor

AnswerValue

protected AnswerValue(java.util.List<P> valueParts)

Constructor

Parameters:

valueParts - The list of AnswerValueParts making up this AnswerValue.

See Also:

getValueParts()

Method Detail

getValueParts

public java.util.List<P> getValueParts()

Returns the list of AnswerValueParts making up this AnswerValue.

getValuePartsCount

public int getValuePartsCount()

Returns the number of value parts in this answer value.

setValueParts

public void setValueParts(P... valueParts)

Specifies the value parts that makes up this answer value. The value parts specified here overwrites any previously set value parts.

Parameters:

valueParts - The value parts making up this answer value.

See Also:

setValueParts(List)

setValueParts

public void setValueParts(java.util.List<P> valueParts)
                   throws java.lang.IllegalArgumentException

Specifies the value parts that makes up this answer value. The value parts specified here overwrites any previously set value parts.

Parameters:

valueParts - The value parts making up this answer value.

Throws:

java.lang.IllegalArgumentException

See Also:

setValueParts(AnswerValuePart...)

validatePartsCount

protected abstract void validatePartsCount(java.util.List<P> valueParts)
                                    throws java.lang.IllegalArgumentException

Validates whether specified list contains exactly the correct number of value parts expected for this type of answer value.

Parameters:

valueParts - List of value parts

Throws:

java.lang.IllegalArgumentException - if the number of value parts found was unexpected

See Also:

AnswerableProblemAttributes.getAnswerValuePartsCount(), AnswerableProblemAttributes.getResponseValuePartsCount()

validatePartsCount

protected abstract void validatePartsCount()
                                    throws java.lang.IllegalArgumentException

Validates whether count of value parts in this answer value match the expected count for this type of answer value.

Throws:

java.lang.IllegalArgumentException - if the number of value parts found was unexpected

See Also:

AnswerableProblemAttributes.getAnswerValuePartsCount(), AnswerableProblemAttributes.getResponseValuePartsCount()

isAllowedEvalType

protected abstract boolean isAllowedEvalType(AnswerEvalType evalType)

Returns whether an evaluation type is allowed for responses to this problem.

Parameters:

evalType - Evaluation type to check

Returns:

true if evalType is valid for this problem's responses; otherwise false

See Also:

AnswerEvalType, AnswerableProblem.registerProblemTypeAttributes(String, String, String, String, int, int, int, List, List)

getValuePart

protected P getValuePart()

Returns the first value part of this answer.

See Also:

getValuePart(int)

getValuePartValue

protected java.lang.String getValuePartValue()

Returns the data value of the first value part of this answer.

See Also:

getValuePartValue(int)

getValuePartType

protected AnswerEvalType getValuePartType()

Returns the evaluation type of the first value part of this answer.

See Also:

getValuePartType(int)

getValuePart

protected P getValuePart(int index)

Returns the value part, at the specified position, of this answer.

Parameters:

index - index of the value part to return

See Also:

getValuePart()

getValuePartValue

protected java.lang.String getValuePartValue(int index)

Returns the data value of the value part, at the specified position, of this answer.

Parameters:

index - index of the value part to return

See Also:

getValuePartValue()

getValuePartType

protected AnswerEvalType getValuePartType(int index)

Returns the evaluation type of the value part, at the specified position, of this answer.

Parameters:

index - index of the value part to return

See Also:

getValuePartType()

partsToList

public java.util.List<P> partsToList(P... parts)

Creates and returns a List of AnswerValueParts.

Parameters:

parts - One or more AnswerValueParts. You can pass each part as a separate argument, or you can pass an array where each element is a single answer part.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toViewString

public java.lang.String toViewString()

Returns an end-user readable representation of the String value of each AnswerValuePart

Returns:

the result String

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object