sbr.plugin
Interface PlugIn


public interface PlugIn


Method Summary
 java.lang.String[][] getCode(int lastQuestion)
          Returns the code to be stored in the SBR file so that the html code can be recreated.
 java.lang.String getHTML(java.lang.String[][] code)
          Returns the html code that has to be added to the survey webpage.
 java.lang.String getName()
          Returns the name of the plugin to be used in the menu.
 java.lang.String[][] parseSBRFile(java.lang.String code)
          Takes the code stored in an SBR File and restores the internal data structure
 java.lang.String toSBRFile(java.lang.String[][] code)
          Converts the internal data structure code into a line for the SurveyBuildR file (.sbr)
 

Method Detail

getName

java.lang.String getName()
Returns the name of the plugin to be used in the menu.

Returns:
String name. The display name of the plugin

getCode

java.lang.String[][] getCode(int lastQuestion)
Returns the code to be stored in the SBR file so that the html code can be recreated. It is this method that is expected to run the plugin.

Parameters:
lastQuestion - the number of the last previous quesiton.
Returns:
String [][]. This the the code to be stored in the SBR file.

getHTML

java.lang.String getHTML(java.lang.String[][] code)
Returns the html code that has to be added to the survey webpage.

Parameters:
code - the internal data structure with the information about the item.
Returns:
String. This is the webpage code

toSBRFile

java.lang.String toSBRFile(java.lang.String[][] code)
Converts the internal data structure code into a line for the SurveyBuildR file (.sbr)

Parameters:
code - the internal data structure code
Returns:
String a line for the SurveyBuildR (.sbr) file

parseSBRFile

java.lang.String[][] parseSBRFile(java.lang.String code)
Takes the code stored in an SBR File and restores the internal data structure

Parameters:
code - the line in the SBR file
Returns:
String [][] the internal data structure