Package edu.suffolk.litlab.efsp.utils

Class InfoCollector

java.lang.Object

edu.suffolk.litlab.efsp.utils.InfoCollector

Direct Known Subclasses:

AllWrongCollector, FailFastCollector, NeverSubmitCollector

public abstract class InfoCollector
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InfoCollector.Dep

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<FilingError>	err
protected List<InterviewVariable>	optionalVars
protected List<InterviewVariable>	requiredVars
protected Stack<String>	variableAttributes
protected List<InterviewVariable>	wrongVars

Constructor Summary

Constructors

Constructor	Description
InfoCollector()

Method Summary

Modifier and Type	Method	Description
InterviewVariable	addCodeError(CodesParser.CodeError err, InterviewVariable.VarBuilder varBuilder)
InterviewVariable	addCrossRefError(CodesParser.CrossReferenceError err, InterviewVariable.VarBuilder varBuilder)
void	addOptional(InterviewVariable var)
void	addRequired(InterviewVariable var)
InterviewVariable	addTextError(CodesParser.TextVarError err, InterviewVariable.VarBuilder varBuilder)
void	addWrong(InterviewVariable var)
void	error(FilingError err)
abstract boolean	finished()	Says if the Info collector is finished with the current unit of information and should break control flow and return.
List<InterviewVariable>	getOptional()
List<InterviewVariable>	getRequired()
List<InterviewVariable>	getWrong()
boolean	hasError()
String	jsonSummary()
boolean	okToSubmit()
void	popAttributeStack()	Should never throw exceptions, that's a silly java thing.
void	pushAttributeStack(String variableName)
InterviewVariable	requestVar(String localName, String description, String datatype)
InterviewVariable	requestVar(String localName, String desc, String datatype, List<String> choices, Optional<String> currentVal)	Creates an InterviewVariable with the correct stack information in the variable name.
InterviewVariable	requestVar(String localName, String desc, List<String> choices)
InterviewVariable	requestVar(String localName, String desc, List<String> choices, String currentVal)
String	unwrap(com.hubspot.algebra.Result<String,CodesParser.TextVarError> res, InterviewVariable.VarBuilder varBuilder)
String	unwrapCode(com.hubspot.algebra.Result<String,CodesParser.CodeError> res, InterviewVariable.VarBuilder varBuilder)
Optional<String>	unwrapOpt(com.hubspot.algebra.Result<Optional<String>,CodesParser.CodeError> res, InterviewVariable.VarBuilder varBuilder)
InterviewVariable.VarBuilder	varBuilder()

Methods inherited from class java.lang.Object

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

Field Details

optionalVars

protected List<InterviewVariable> optionalVars

requiredVars

protected List<InterviewVariable> requiredVars

wrongVars

protected List<InterviewVariable> wrongVars

err

protected Optional<FilingError> err

variableAttributes

protected Stack<String> variableAttributes

Constructor Details

InfoCollector

public InfoCollector()

Method Details

error

public void error(FilingError err)
           throws FilingError

Throws:

FilingError

hasError

public boolean hasError()

finished

public abstract boolean finished()

Says if the Info collector is finished with the current unit of information and should break control flow and return.

okToSubmit

public boolean okToSubmit()

addRequired

public void addRequired(InterviewVariable var)
                 throws FilingError

Throws:

FilingError

addOptional

public void addOptional(InterviewVariable var)

addWrong

public void addWrong(InterviewVariable var)
              throws FilingError

Throws:

FilingError

addCodeError

public InterviewVariable addCodeError(CodesParser.CodeError err,
 InterviewVariable.VarBuilder varBuilder)
                               throws FilingError

Throws:

FilingError

addTextError

public InterviewVariable addTextError(CodesParser.TextVarError err,
 InterviewVariable.VarBuilder varBuilder)
                               throws FilingError

Throws:

FilingError

addCrossRefError

public InterviewVariable addCrossRefError(CodesParser.CrossReferenceError err,
 InterviewVariable.VarBuilder varBuilder)
                                   throws FilingError

Throws:

FilingError

pushAttributeStack

public void pushAttributeStack(String variableName)

popAttributeStack

public void popAttributeStack()

Should never throw exceptions, that's a silly java thing.

getRequired

public List<InterviewVariable> getRequired()

getOptional

public List<InterviewVariable> getOptional()

getWrong

public List<InterviewVariable> getWrong()

requestVar

public InterviewVariable requestVar(String localName,
 String desc,
 String datatype,
 List<String> choices,
 Optional<String> currentVal)

Creates an InterviewVariable with the correct stack information in the variable name.

Parameters:

localName -

desc -

datatype -

choices -

currentVal - the current value (if any) of the variable in this round of processing

Returns:

varBuilder

public InterviewVariable.VarBuilder varBuilder()

requestVar

public InterviewVariable requestVar(String localName,
 String desc,
 List<String> choices,
 String currentVal)

requestVar

public InterviewVariable requestVar(String localName,
 String desc,
 List<String> choices)

requestVar

public InterviewVariable requestVar(String localName,
 String description,
 String datatype)

unwrap

public String unwrap(com.hubspot.algebra.Result<String,CodesParser.TextVarError> res,
 InterviewVariable.VarBuilder varBuilder)
              throws FilingError

Throws:

FilingError

unwrapCode

public String unwrapCode(com.hubspot.algebra.Result<String,CodesParser.CodeError> res,
 InterviewVariable.VarBuilder varBuilder)
                  throws FilingError

Throws:

FilingError

unwrapOpt

public Optional<String> unwrapOpt(com.hubspot.algebra.Result<Optional<String>,CodesParser.CodeError> res,
 InterviewVariable.VarBuilder varBuilder)
                           throws FilingError

Throws:

FilingError

jsonSummary

public String jsonSummary()