edu.umass.cs.surveyman

Class SurveyMan

java.lang.Object

edu.umass.cs.surveyman.SurveyMan

public class SurveyMan
extends Object

Top level access point for the program. If you have downloaded the source, call make package from the top level of the directory. Then call java -jar target/surveyman-x.y.jar, which will print out instructions for running survey programs, the kinds of arguments you should use, etc. If you are using SurveyMan programmatically, look at the description of how main is called.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.logging.log4j.Logger	LOGGER If SurveyMan is not called as a command line program, then this class simply provides a single instance of the logger.

Method Summary

Methods

Modifier and Type	Method and Description
static void	analyze(Survey survey, Analyses analyses, Classifier classifier, int n, double granularity, double alpha, String outputFile, String resultsfile, boolean smoothing) Analyzes the survey.
static void	main(String[] args) The main entry point for the program.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.apache.logging.log4j.Logger LOGGER

If SurveyMan is not called as a command line program, then this class simply provides a single instance of the logger.

Method Detail

analyze

public static void analyze(Survey survey,
           Analyses analyses,
           Classifier classifier,
           int n,
           double granularity,
           double alpha,
           String outputFile,
           String resultsfile,
           boolean smoothing)
                    throws IOException,
                           SurveyException,
                           com.github.fge.jsonschema.core.exceptions.ProcessingException

Analyzes the survey. Note that this does not set the rules used in static checking! You will need to call AbstractRule.getDefaultRules() first. This allows the user to extend or remove rules as needed.

Parameters:

survey - The survey object.

analyses - The type of analysis to run: static or dynamic.

classifier - The type of classifier to use for bad actors.

n - The total number of respondents to simulate (if running static analysis).

granularity - The granularity of random respondents to increment by, for static analysis.

alpha - The cutoff.

outputFile - The file to write results to.

resultsfile - The file containing results from running a survey (if running dynamic analyses).

smoothing - Boolean indicating whether the system should use Laplace smoothing for question options.

Throws:

IOException

com.github.fge.jsonschema.core.exceptions.ProcessingException

SurveyException

main

public static void main(String[] args)

The main entry point for the program. Running the jar with no arguments will call this function and then print out a description of the arguments. If you would like to embed a SurveyMan program in another program, you will need to:

1. Instantiate a lexer:
   AbstractLexer lexer = new CSVLexer("my_survey.csv", ",");
2. Instantiate a parser:
   AbstractParser parser = new CSVParser(lexer);
3. Parse the survey:
   Survey survey = parser.parse();
4. Specify the rules you want to use to statically analyse the survey:
   AbstractRule.getDefaultRules();
5. Then call analyze:
   SurveyMan.analyze(survey, analyses, classifier, n, granularity, alpha, outputfile, resultsfile, smoothing);

Parameters:

args - Arguments the top-level program. Execute java -jar target/surveyman-x.y.jar for guidance.