*
* (WebLearn modification (method added): 02/12/2003 Colin Tatham)
* @param original_resource The resource with content to copy.
* @param new_resource The resource to copy content to.
* @exception BuildingServerException Thrown if there is any problem copying the resource content.
* @exception RemoteException Thrown if there is any problem copying the resource content.
*
*/
private void copyAuthoredContent( Resource original_resource, Resource new_resource )
throws BuildingServerException, RemoteException
{
QuestionnaireSession session;
QuestionnaireQuestion orig_question, new_question;
session = (QuestionnaireSession)BuildingSessionManagerImpl.getSession( original_resource );
List questions = ((QuestionnaireSession)session).getQuestionnaireQuestionsInOrder();
for (int i=0; i
* NOTE: This method is intended to be called from templates.
* @param request the request object.
* @return the ID of the newly created question, or an error message.
* @see QuestionnaireQuestion#getQuestionnaireQuestionId()
* @see #isNumber(String)
*/
public String addQuestion(Request request)
{
// TODO: this clearly needs better factoring out!
try
{
QuestionnaireSession session
= (QuestionnaireSession)BuildingSessionManagerImpl.getSession(
request.getResource() );
String ordinalText = request.getParameter( "ordinal");
QuestionnaireQuestion q = ( ordinalText != null)
? session.createQuestion( Integer.parseInt( ordinalText) )
: session.createQuestion();
return q.getQuestionnaireQuestionId().toString();
}
catch ( BuildingServerException e )
{
return e.getMessage();
}
catch ( RemoteException e )
{
return e.getMessage();
}
}
/**
* Edit a question. Upon success, this method returns a number which is the
* string form of the ID of the question that has just been edited (see
* {@link QuestionnaireQuestion#getQuestionnaireQuestionId()}). Upon
* failure, the string returned is in fact an error message.
*
* NOTE: This method is intended to be called from templates.
* @param request the request object.
* @return the ID of the newly created question, or an error message.
* @see QuestionnaireQuestion#getQuestionnaireQuestionId()
* @see #isNumber(String)
*/
public String editQuestion( Request request )
{
String id, param;
PrimaryKey questionID;
Map questions;
QuestionnaireQuestion q;
QuestionnaireSession session;
try
{
session
= (QuestionnaireSession)BuildingSessionManagerImpl.getSession(
request.getResource() );
}
catch ( BuildingServerException e )
{
return e.getMessage();
}
if ( !BuildingContext.getContext().checkPermission( Permission.EDIT ) )
return "You do not have permission to edit questions in this "
+ "location of the building.";
// must have an id in the parameter part of the URL
if ( request.getTemplateParameterCount() < 1 )
return "Can not display edit field";
id = (String)request.getTemplateParameter( 0 );
questionID = new PrimaryKey( Integer.parseInt( id ) );
try
{
questions = session.getQuestionnaireQuestions();
q = (QuestionnaireQuestion)questions.get( questionID );
if ( q == null )
return "Can not display edit field";
param = request.getParameter( "ordinal" );
try
{
q.setOrdinal( Integer.parseInt( param ) );
}
catch ( NumberFormatException ex )
{
return "Invalid number in ordinal field.";
}
param = request.getParameter( "introduction" );
if ( param == null ) param = "";
session.changeQuestionText( q.getQuestionnaireQuestionId(),
q.getIntroductionBigStringId(), param );
for ( int i = 0; i < 10; i++ )
{
param = request.getParameter( "statement_" + (char)('a' + i) );
if ( param == null ) param = "";
session.changeQuestionText( q.getQuestionnaireQuestionId(),
q.getStatementBigStringId( i ), param );
}
param = request.getParameter( "is_standard" );
q.setStandardQuestion( param != null && param.length() > 0 );
param = request.getParameter( "can_comment" );
q.setCanComment( param != null && param.length() > 0 );
session.changeQuestion( q.getQuestionnaireQuestionId(), q );
}
catch ( RemoteException e )
{
return "There was a problem with saving the edited question.";
}
catch ( BuildingServerException e )
{
return "There was a problem with saving the edited question.";
}
return q.getQuestionnaireQuestionId().toString();
}
/**
* Delete a question. Upon success, this method always returns a string that
* can be parsed as an integer. Typically, this is the ID of a question that
* is adjacent to the one that has just been deleted (see
* {@link QuestionnaireQuestion#getQuestionnaireQuestionId()}). If there is
* a previous question, that is returned. If there is no previous question,
* but there is a following question, that is the one returned. If no other
* question is found, i.e. the deleted question was the only one left, the
* value
* NOTE: This method is intended to be called from templates.
* @param request the request object.
* @return the ID of a suitable adjacent question, or an error message.
* @see QuestionnaireQuestion#getQuestionnaireQuestionId()
* @see #isNumber(String)
*/
public String deleteQuestion( Request request )
{
String id, param, notparam;
PrimaryKey qid;
QuestionnaireSession session;
if ( !BuildingContext.getContext().checkPermission( Permission.EDIT ) )
return "You do not have permission to delete (edit) questions in "
+ "this location of the building.";
try
{
session
= (QuestionnaireSession)BuildingSessionManagerImpl.getSession(
request.getResource() );
}
catch ( BuildingServerException e )
{
return e.getMessage();
}
// must have an id in the parameter part of the URL
if ( request.getTemplateParameterCount() < 1 )
return "Can not delete question.";
id = (String)request.getTemplateParameter( 0 );
qid = new PrimaryKey( Integer.parseInt( id ) );
param = request.getParameter( "confirm" );
if ( param == null ) param = "";
notparam = request.getParameter( "notconfirm" );
if ( notparam == null ) notparam = "";
if ( param.length() < 1 || notparam.length() > 0 )
return "Deleting was not confirmed - question not deleted.";
// Try and find the ID of an adjacent question to the deletee:
String questionID = String.valueOf( 0 );
try
{
// NOTE: this is a UI convenience and *not* mission-critical!
List questions = session.getQuestionnaireQuestionIds();
int index = questions.indexOf( qid );
if ( (index - 1) > 0 ) // does 'previous' exist?
questionID =
((PrimaryKey)questions.get( index - 1 )).toString();
else if ( (index + 1) < questions.size() ) // does 'next' exist?
questionID =
((PrimaryKey)questions.get( index + 1 )).toString();
}
catch ( RemoteException e )
{
}
catch ( BuildingServerException e )
{
}
// Actually remove the intended deletee:
try
{
session.removeQuestion( qid );
}
catch ( RemoteException e )
{
return e.getMessage();
}
catch ( BuildingServerException e )
{
return e.getMessage();
}
return questionID;
}
/**
* Indicates whether the string is a number. Specifically, this method
* indicates whether the string is parsable as a Your responses have been recorded . The XML file has been created and is available "
+ "for download with the name " + fileName + ""
+ " here. (Left click to view in browser, right click to "
+ "save to disk.) " );
}
catch ( BuildingServerException bsex )
{
out.println( " Import failed: no file was supplied.
*
* NOTE: this method is intended to be called from templates.
* @param request the current request.
* @param value a constant corresponding to a value in
* {@link QuestionnaireWizard}.
* @param enabled indicates whether or not this control should be enabled.
* @return an HTML control for the implicit questionnaire.
* @see QuestionnaireWizard
*/
public String wizardControl( Request request, String value,
boolean enabled )
{
String wizardValue = null;
try
{
QuestionnaireSession session
= (QuestionnaireSession) BuildingSessionManagerImpl.getSession(
request.getResource() );
Map map = requestParameters( session.getQuestionnaire() );
wizardValue = QuestionnaireWizard.wizardValue( map );
}
catch ( BuildingServerException e )
{
return "";
}
catch ( RemoteException e )
{
return "";
}
StringBuffer sb = new StringBuffer( "");
return sb.toString();
}
}
Technical problem: unable to access appropriate tool session.
" );
return;
}
q_session = (QuestionnaireSession)session;
if ( command.equalsIgnoreCase( "qpaper" ) ||
command.equalsIgnoreCase( "qrecord" ) ||
command.equalsIgnoreCase( "qitemedit" ) ||
command.equalsIgnoreCase( "qeditqconfirm" ) ||
command.equalsIgnoreCase( "qdeleteq" ) ||
command.equalsIgnoreCase( "qnewq" ) ||
command.equalsIgnoreCase( "exportimsqti" ) ||
command.equalsIgnoreCase( "importimsqti" ) ||
command.equalsIgnoreCase( "exportcsv" ))
{
if ( out==null )
return;
if ( command.equalsIgnoreCase( "qpaper" ) )
qprintpaper( req, out, q_session, insertname );
if ( command.equalsIgnoreCase( "qrecord" ) )
qrecord( req, out, q_session, insertname );
if ( command.equalsIgnoreCase( "qitemedit" ) )
qitemedit( req, out, q_session, insertname );
if ( command.equalsIgnoreCase( "exportimsqti" ) )
exportimsqti( req, out, q_session );
if ( command.equalsIgnoreCase( "importimsqti" ) )
importimsqti( req, out, q_session );
return;
}
}
catch ( BuildingServerException bsex )
{
logException( out, "QuestionnaireFacility", "insert",
"Technical error processing page.",
bsex );
return;
}
super.insert( req, out, command, insertname );
}
/**
* Print out the questionnaire paper. This ouputs the contents of the
* questionnaire to the out parameter. The rendering can be
* altered via the style parameter, which corresponds to the
* activity that the user is currently doing. The style
* parameter understands the following values:
*
*
* @param req the request object.
* @param out the writer object.
* @param session the questionnaire session object.
* @param style the style of the presentation required (see above).
* @throws IOException
* @throws BuildingServerException
*/
private void qprintpaper( Request req, PrintWriter out,
QuestionnaireSession session, String style ) throws IOException,
BuildingServerException
{
/*
* NOTES:
* - the relationship between this method and it's renderers is in a
* state of evolutionary flux! It's possible that the ...
* [*] this method may instantiate oft-used variables on behalf of the
* renders and pass them in the constructor.
* [*] the renderer interface may turn into an abstract class (in order
* to capture more commonality explicitly).
*/
/*
* Instantiate some common variables.
*/
Questionnaire questionnaire = session.getQuestionnaire();
QuestionnaireResult result = session.getQuestionnaireResult();
/*
* Switch "state" if required.
*
* (Essentially what we are doing here is effectively switching the
* access control on an individual, depending on whether they have
* submitted a paper or not. The reason we do not change the setting
* in the acl table itself is because that works on groups. One
* alternative might be to make each individual a single member of an
* adhoc group. For example, if a questionnaire is 'one attempt only' we
* could remove their RECORD permission once they had submitted an
* answer).
*/
// 1 attempt / 1 result allowed / 1 result recorded:
if ( "run".equalsIgnoreCase( style )
&& !questionnaire.isMultipleAttempts()
&& !questionnaire.isMultipleResults()
&& result != null )
{
style = "view";
}
/*
* Hand off to appropriate renderer.
*/
QuestionnaireRenderer renderer = null;
if ( "run".equalsIgnoreCase( style ) )
{
renderer = new RunQuestionnaireRenderer();
}
else if ( "view".equalsIgnoreCase( style ) )
{
renderer = new ViewQuestionnaireRenderer();
}
else if ( "edit".equalsIgnoreCase( style ) )
{
renderer = new EditQuestionnaireRenderer();
}
else if ( "analysis".equalsIgnoreCase( style ) )
{
renderer = new AnalysisQuestionnaireRenderer();
}
renderer.paperToHTML(req, out, session);
}
private void qitemedit( Request req, PrintWriter out, QuestionnaireSession q_session, String insertname )
throws IOException, BuildingServerException
{
String id, field, statement;
PrimaryKey qid;
Map questions;
QuestionnaireQuestion q;
if ( !BuildingContext.getContext().checkPermission( Permission.EDIT ) )
{
out.println( "run - a user is recording his or her responses.
* view - a user is viewing the questions.
* edit - a user is editing quesions within the
* questionnaire.
* analysis - a user is analysing recorded responses to
* the questionnaire.
* You don't have permission to edit questions in this location of the building.
\n" );
return;
}
//must have an id in the parameter part of the URL
if ( req.getTemplateParameterCount() < 1 )
{
out.println( "Can't display edit field." );
return;
}
id=(String)req.getTemplateParameter( 0 );
qid= new PrimaryKey( Integer.parseInt( id ) );
questions = q_session.getQuestionnaireQuestions();
q=(QuestionnaireQuestion)questions.get( qid );
if ( q==null )
{
out.println( "Can't display edit field." );
return;
}
if ( insertname.equalsIgnoreCase( "ordinal" ) )
{
out.println( "" );
return;
}
if ( insertname.equalsIgnoreCase( "statements" ) )
{
out.println( "" );
return;
}
if ( insertname.equalsIgnoreCase( "introduction" ) )
{
out.print( "" );
return;
}
for ( int i=0; i<10; i++ )
{
field = "statement_" + (char)('a' + i );
statement = q.getStatement( i );
if ( insertname.equalsIgnoreCase( field ) )
{
out.print( "" );
return;
}
}
if ( insertname.equalsIgnoreCase( "is_standard" ) )
{
out.print( "":">" );
return;
}
if ( insertname.equalsIgnoreCase( "can_comment" ) )
{
out.print( "":">" );
return;
}
}
/**
* Add a new question. Upon success, this method returns a number which is
* the string form of the ID of the question that has just been added (see
* {@link QuestionnaireQuestion#getQuestionnaireQuestionId()}). Upon
* failure, the string returned is in fact an error message.
* 0 is returned. Upon failure, the string returned is
* in fact an error message.
* double.
* @param s the string to be parsed.
* @return true if the string is a parsable number, otherwise
* false.
*/
public boolean isNumber( String s )
{
try
{
Double.parseDouble( s );
return true;
}
catch ( NumberFormatException e )
{
return false;
}
}
private void qrecord( Request req, PrintWriter out, QuestionnaireSession q_session, String insertname )
throws IOException, BuildingServerException
{
char letter;
int i, j;
String param;
List questions_in_order;
PrimaryKey[] list;
QuestionnaireQuestion qq;
int items[];
String comments[];
User user = (User)BuildingContext.getContext().getUser();
questions_in_order = q_session.getQuestionnaireQuestionsInOrder();
items = new int[questions_in_order.size()];
comments = new String[questions_in_order.size()];
list = new PrimaryKey[questions_in_order.size()];
for ( i=0; i" );
out.println( bsex.getMessage() );
out.println( "" );
}
return;
}
private void importimsqti( Request req, PrintWriter out, QuestionnaireSession q_session )
throws IOException
{
String file = req.getParameter( "file" );
if ( file == null || file.length() == 0 )
{
out.println( "" );
out.println( bsex.getMessage() );
out.println( "" );
}
return;
}
private void exportcsv(Request req, HttpServletResponse resp,
QuestionnaireSession q_session) throws IOException
{
resp.setContentType("text/comma-separated-values");
resp.setHeader("Content-Disposition","attachment; filename=\"results.csv\"");
PrintWriter out = resp.getWriter();
try
{
Questionnaire paper = q_session.getQuestionnaire();
List list = q_session.getQuestionnaireQuestionsInOrder();
QuestionnaireQuestion[] questions = new QuestionnaireQuestion[list
.size()];
questions = (QuestionnaireQuestion[]) list.toArray(questions);
CSVWriter csv = new CSVWriter(out);
if (paper == null || questions.length == 0)
{
csv.write("The questionnaire contains no questions.");
csv.writeln();
return;
}
// 1st line: the questions themselves.
for (int i = 0; i < questions.length; i++)
{
csv.write(questions[i].getIntroduction());
if (questions[i].isCanComment())
csv.write("");
}
csv.writeln();
// Subsequent line(s): one user response per line.
Enumeration results = QuestionnaireResult
.findQuestionnaireResults(q_session.getQuestionnaire()
.getQuestionnaireId());
while (results.hasMoreElements())
{
QuestionnaireResult result = (QuestionnaireResult) results
.nextElement();
Map responses = result.getQuestionnaireResponses();
for (int i = 0; i < questions.length; i++)
{
QuestionnaireResponse response = (QuestionnaireResponse) responses
.get(questions[i].getQuestionnaireQuestionId());
// MCQ section?
if (questions[i].isMultipleChoice())
csv.write(response != null ? response.itemToString()
: "");
// Comment section?
if (questions[i].isCanComment())
csv.write(response != null ? response.commentToString()
: "");
}
csv.writeln();
}
}
catch (IOException e)
{
log.error(e.getMessage(), e);
}
catch (BuildingServerException bse)
{
log.error(bse);
}
}
/**
* Check the specified parameters. These parameters are consistent with the
* form understood by {@link javax.servlet.ServletRequest}. This method
* expects to find parameters which pertain to a proposed set of property
* settings on a questionnaire instance. This method looks for incompatible
* combinations of properties and is intended to be called prior to actually
* setting these values. Success is indicated by the return of an empty
* array. Otherwise, the element at each index represents a separate error
* message.
* @param params a map of key-value pairs.
* @return an array of error messages.
* @see #requestParameters(Questionnaire)
* @see javax.servlet.ServletRequest
*/
private String[] checkParameters( Map params )
throws IOException, BuildingServerException
{
// TODO: capture these semantics in questionnaire itself.
Vector messages = new Vector();
Set keys = params.keySet();
boolean multipleAttemptsAllowed = !keys.contains( SINGLE_SUBMIT );
boolean hideAnswersOnSubmit = keys.contains( HIDE_SUBMITTED );
boolean multipleResults = keys.contains( MULTIPLE_RESULTS );
if (multipleAttemptsAllowed && hideAnswersOnSubmit)
{
messages.add("A questionnaire that allows for multiple attempts, "
+ "but where the answers are hidden from the user after "
+ "submission, are incompatible options.");
}
if (multipleAttemptsAllowed && multipleResults)
{
messages.add("A questionnaire that allows for multiple attempts and "
+ "multiple results is not supported at the current time.");
}
return (String[]) messages.toArray(new String[messages.size()]);
}
/**
* Get the request parameters for the specified questionnaire. These
* parameters are consistent with the form understood by
* {@link javax.servlet.ServletRequest}. Each parameter has a 1-1
* relationship to a property of the questionnaire. The mapping for request
* parameters to questionnaire properties can be seen in the table below.
*
*
* @param questionnaire the questionnaire.
* @return the request parameters for the specified questionnaire.
* @see Questionnaire
* @see javax.servlet.ServletRequest
*/
private Map requestParameters( Questionnaire questionnaire )
{
HashMap map = new HashMap();
if ( !questionnaire.isMultipleAttempts() )
map.put( SINGLE_SUBMIT, EMPTY_AS_ARRAY );
if ( questionnaire.isHideAnswersOnSubmit() )
map.put( HIDE_SUBMITTED, EMPTY_AS_ARRAY );
if ( questionnaire.isMultipleResults() )
map.put( MULTIPLE_RESULTS, EMPTY_AS_ARRAY );
return map;
}
/**
* Create an HTML control for the implicit questionnaire. This method will
* return a radio button with the name
*
*
* Parameter
* Type
* Questionnaire Property
*
*
* one_attemptboolean{@link Questionnaire#isMultipleAttempts()}
* == false
*
* hide_submittedboolean{@link Questionnaire#isHideAnswersOnSubmit()}
* == true
*
* one_attemptboolean{@link Questionnaire#isMultipleResults()}
* == truewizardValue. If the
* wizard-oriented value of the implicit questionnaire corresponds with the
* value parameter then this control will be selected (i.e.
* checked).
*