org.researchstack.backbone.result

Class StepResult<T>

java.lang.Object

org.researchstack.backbone.result.Result

org.researchstack.backbone.result.StepResult<T>

All Implemented Interfaces:

java.io.Serializable

public class StepResult<T>
extends Result

The StepResult class represents a result produced by a StepLayout to hold all child results of type T produced by the step.

A step result is typically generated by the framework as the task proceeds. When the task completes, it may be appropriate to serialize it for transmission to a server, or to immediately perform analysis on it.

For example, an QuestionStep object produces a result of type T that becomes a child of the StepResult object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_KEY When StepResult only has a single value, pair that value with the following key

Constructor Summary

Constructors

Constructor and Description
StepResult(Step step) Creates a StepResult from a Step.

Method Summary

Modifier and Type	Method and Description
AnswerFormat	getAnswerFormat() Gets the AnswerFormat for this step result.
T	getResult() Returns the result stored using setResult(T).
T	getResultForIdentifier(java.lang.String identifier) Returns the result for the given identifier, use this when there are multiple results for the step.
java.util.Map<java.lang.String,T>	getResults()
void	setResult(T result) Sets the result using the default key, useful when there is only a single result.
void	setResultForIdentifier(java.lang.String identifier, T result) Sets the result for the given identifier, use when there are multiple results for the step.
void	setResults(java.util.Map<java.lang.String,T> results)

Methods inherited from class org.researchstack.backbone.result.Result

getEndDate, getIdentifier, getStartDate, setEndDate, setStartDate

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEY

public static final java.lang.String DEFAULT_KEY

When StepResult only has a single value, pair that value with the following key

See Also:

Constant Field Values

Constructor Detail

StepResult

public StepResult(Step step)

Creates a StepResult from a Step.

Using this constructor ensures that the StepResult has the correct identifier and answer format for the corresponding step.

Parameters:

step - the step from which to create the StepResult

Method Detail

getResults

public java.util.Map<java.lang.String,T> getResults()

setResults

public void setResults(java.util.Map<java.lang.String,T> results)

getResult

public T getResult()

Returns the result stored using setResult(T).

Returns:

the result with the default identifier

setResult

public void setResult(T result)

Sets the result using the default key, useful when there is only a single result.

Parameters:

result - the result to save with the default key

getResultForIdentifier

public T getResultForIdentifier(java.lang.String identifier)

Returns the result for the given identifier, use this when there are multiple results for the step.

Parameters:

identifier - the identifier used as the key for storing this result

Returns:

the result for the given identifier

setResultForIdentifier

public void setResultForIdentifier(java.lang.String identifier,
                                   T result)

Sets the result for the given identifier, use when there are multiple results for the step.

If there is only one result, use the setResult(T) convenience method instead.

Parameters:

identifier - the identifier for the result

result - the result to save

getAnswerFormat

public AnswerFormat getAnswerFormat()

Gets the AnswerFormat for this step result. May be useful when processing the result.

Returns:

the answer format associated with the step