edu.umass.cs.surveyman.survey

Class Survey

java.lang.Object

edu.umass.cs.surveyman.survey.Survey

All Implemented Interfaces:

Serializable

public class Survey
extends Object
implements Serializable

The class representing a Survey object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Block>	blocks Map of all block identifiers to Blockobjects.
Map<String,List<Question>>	correlationMap Map from correlation labels to the Questions that are correlated.
String	encoding Source string encoding.
String[]	otherHeaders Array of headers not contained in knownHeaders.
List<Question>	questions Top level list of all questions in this survey.
String	sid Internal survey identifier.
String	source Source input url.
String	sourceName Name of this survey derived from the source input URL
List<Block>	topLevelBlocks List of all top-level blocks.

Constructor Summary

Constructors

Constructor and Description
Survey()
Survey(Question... surveyQuestions)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlock(Block b)
void	addQuestion(Question q)
void	addQuestions(Question... surveyQuestions) Adds the questions provided in the arguments to a top level block and adds this block to the survey.
boolean	equals(Object o)
Set<Block>	getAllBlocks() Gets all blocks (top level and subblocks) in this survey.
String	getCorrelationLabel(Question q) Returns the correlation label associated with the input question.
Question	getQuestionById(String quid) Returns the Question object associated with the input question identifier.
Question	getQuestionByLineNo(int lineno) Returns the Question that contains the associated input line number.
Question	getQuestionByText(String text) Returns the Question whose surface text corresponds with the input.
Question[]	getQuestionListByIndex()
Set<Question>	getVariantSet(Question thisQ) If the input question belongs to a Block having Block.BranchParadigm equal to ALL, it is part of a question variant set.
String	jsonize()
org.supercsv.cellprocessor.ift.CellProcessor[]	makeProcessorsForResponse() Returns the CellProcessors needed to parse the output of a deployed SurveyMan survey.
boolean	permitsBreakoff() Indicates whether any breakoff is permitted in this survey.
String	toString() A string representation of the survey is an indented illustration of the blocks and their questions.

Methods inherited from class java.lang.Object

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

Field Detail

sid

public String sid

Internal survey identifier.

questions

public List<Question> questions

Top level list of all questions in this survey.

blocks

public Map<String,Block> blocks

Map of all block identifiers to Blockobjects. Includes top level blocks, sub-blocks, and "phantom" blocks.

topLevelBlocks

public List<Block> topLevelBlocks

List of all top-level blocks.

encoding

public String encoding

Source string encoding. Typically UTF-8.

otherHeaders

public String[] otherHeaders

Array of headers not contained in knownHeaders.

sourceName

public String sourceName

Name of this survey derived from the source input URL

source

public String source

Source input url.

correlationMap

public Map<String,List<Question>> correlationMap

Map from correlation labels to the Questions that are correlated.

Constructor Detail

Survey

public Survey()

Survey

public Survey(Question... surveyQuestions)
       throws SurveyException

Throws:

SurveyException

Method Detail

getQuestionById

public Question getQuestionById(String quid)
                         throws SurveyException

Returns the Question object associated with the input question identifier. If the input identifier matches a known ad hoc custom question id, it will return a new Question object with the idenfier "q_-1_-1".

Parameters:

quid - A question identifier.

Returns:

A Question object.

Throws:

QuestionNotFoundException - if a question with this identifier is not found in this survey.

SurveyException

getQuestionByLineNo

public Question getQuestionByLineNo(int lineno)
                             throws SurveyException

Returns the Question that contains the associated input line number.

Parameters:

lineno - The input line number.

Returns:

The associated Question object.

Throws:

QuestionNotFoundException - if none of the questions associated with this survey span the input line number.

SurveyException

getQuestionByText

public Question getQuestionByText(String text)
                           throws SurveyException

Returns the Question whose surface text corresponds with the input. Matches exactly. Only works on questions whose contents are strings, not those that are specified by HTML.

Throws:

SurveyException

getQuestionListByIndex

public Question[] getQuestionListByIndex()

getAllBlocks

public Set<Block> getAllBlocks()

Gets all blocks (top level and subblocks) in this survey.

Returns:

A set of blocks.

permitsBreakoff

public boolean permitsBreakoff()

Indicates whether any breakoff is permitted in this survey.

Returns:

true if at least one question permits breakoff.

getVariantSet

public Set<Question> getVariantSet(Question thisQ)

If the input question belongs to a Block having Block.BranchParadigm equal to ALL, it is part of a question variant set.

Parameters:

thisQ - Input question that may belong to a variant set.

Returns:

The variant set if it exists; otherwise, null.

makeProcessorsForResponse

public org.supercsv.cellprocessor.ift.CellProcessor[] makeProcessorsForResponse()

Returns the CellProcessors needed to parse the output of a deployed SurveyMan survey. See the SurveyMan Runtime.

Returns:

Array of cell processors for parsing Runtime output CSVs.

getCorrelationLabel

public String getCorrelationLabel(Question q)

Returns the correlation label associated with the input question. If there is no correlation label assocaited with the input question, returns an empty string.

Parameters:

q - The question whose correlation label we would like.

Returns:

String indicating a label or empty string indicating none. Note that only one correlation label may be assocaited with a particular question.

jsonize

public String jsonize()
               throws SurveyException,
                      IOException

Throws:

SurveyException

IOException

addBlock

public void addBlock(Block b)

addQuestions

public void addQuestions(Question... surveyQuestions)
                  throws SurveyException

Adds the questions provided in the arguments to a top level block and adds this block to the survey. The default top level block id is "1".

Parameters:

surveyQuestions - The questions to be added to the top-level block of the survey.

Throws:

SurveyException

addQuestion

public void addQuestion(Question q)
                 throws SurveyException

Throws:

SurveyException

toString

public String toString()

A string representation of the survey is an indented illustration of the blocks and their questions.

Overrides:

toString in class Object

Returns:

String of survey.

equals

public boolean equals(Object o)

Overrides:

equals in class Object