/**
* This file is part of JSurveyLib.
*
* JSurveyLib is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JSurveyLib is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JSurveyLib. If not, see <http://www.gnu.org/licenses/>.
**/
package org.jsurveylib.io;
import org.jsurveylib.model.Label;
import org.jsurveylib.model.Menu;
import org.jsurveylib.model.Page;
import org.jsurveylib.model.i18n.Strings;
import org.jsurveylib.model.question.Choice;
import org.jsurveylib.model.question.FileFilter;
import org.jsurveylib.model.question.Question;
import org.jsurveylib.model.question.QuestionBuilder;
import org.jsurveylib.model.question.Template;
import org.jsurveylib.utils.XMLUtil;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Vector;
/**
* <u><b><font color="red">FOR INTERNAL USE ONLY.</font></b></u>
* <p/>
* <p/>
* Copyright (c)2007, Daniel Kaplan
*
* @author Daniel Kaplan
* @since 7.10.4
*/
public class XMLSurveyReader implements SurveyReader {
public static final String XSD_LOCATION = "http://jsurveylib.sourceforge.net/survey-8.01.29.xsd";
/**
* Remember the xml definition of the survey
*/
private Element xmlRoot;
private List<Page> pages = new ArrayList<Page>();
private HashMap<String, Template> templateMap = new HashMap<String, Template>();
public XMLSurveyReader(File configFile) throws Exception {
this(new FileReader(configFile));
}
public XMLSurveyReader(Reader configReader) throws Exception {
parseFromXML(configReader);
}
public String getTitle() {
if (!xmlRoot.hasAttribute("title")) {
return "Unnamed";
}
return xmlRoot.getAttribute("title");
}
public String i18nString(String attributeName, String defaultValue) {
if (xmlRoot.hasAttribute(attributeName)) {
System.err.println("WARNING: surveyConfig's " + attributeName + " attribute is deprecated and will be removed. Use the <strings> tag instead.");
return xmlRoot.getAttribute(attributeName);
}
if (xmlRoot.getElementsByTagName("strings").getLength() == 1) {
Element i18n = (Element) xmlRoot.getElementsByTagName("strings").item(0);
if (i18n.hasAttribute(attributeName)) {
return i18n.getAttribute(attributeName);
}
}
return defaultValue;
}
public Strings getStrings() {
return new Strings() {
public String getNextString() {
return i18nString("nextString", "Next");
}
public String getPreviousString() {
return i18nString("previousString", "Previous");
}
public String getFinishString() {
return i18nString("finishString", "Finish");
}
public String getPageString() {
return i18nString("pageString", "Page");
}
public String getOfString() {
return i18nString("ofString", "of");
}
public String getBrowseString() {
return i18nString("browseString", "Browse");
}
public String getFileString() {
return i18nString("fileString", "File");
}
public String getViewString() {
return i18nString("viewString", "View");
}
public String getFirstPageString() {
return i18nString("firstPageString", "First Page");
}
public String getPreviousPageString() {
return i18nString("previousPageString", "Previous Page");
}
public String getNextPageString() {
return i18nString("nextPageString", "Next Page");
}
public String getLastPageString() {
return i18nString("lastPageString", "Last Page");
}
public String getOpenString() {
return i18nString("openString", "Open...");
}
public String getSaveString() {
return i18nString("saveString", "Save");
}
public String getSaveAsString() {
return i18nString("saveAsString", "Save As...");
}
public String getUnsavedChangesString() {
return i18nString("unsavedChangesString", "Unsaved Changes");
}
public String getSaveToWorkingFileNotificationString() {
return i18nString("saveToWorkingFileNotificationString", "This survey has unsaved changes. Choose OK to save these changes to\n");
}
public String getSaveToNewFileNotificationString() {
return i18nString("saveToNewFileNotificationString", "This survey has unsaved changes. Choose OK to save these changes.");
}
};
}
public String getInitScript() {
if (xmlRoot.getElementsByTagName("initScript").getLength() > 0) {
return xmlRoot.getElementsByTagName("initScript").item(0).getTextContent();
} else {
return "";
}
}
public String getOnAnswerChanged() {
//search if an onAnswerChanged element exists
if (xmlRoot.getElementsByTagName("onAnswerChanged").getLength() > 0) {
NodeList childNodes = xmlRoot.getChildNodes();
//only use the onAnswerChanged element that is a child of the root.
for (int i = 0; i < childNodes.getLength(); ++i) {
if (childNodes.item(i).getNodeName().equals("onAnswerChanged")) {
return childNodes.item(i).getTextContent();
}
}
}
return "";
}
public List<Page> getPages() {
List<Page> pages = new ArrayList<Page>();
//read all pages
NodeList pageNodes = xmlRoot.getElementsByTagName("page");
for (int p = 0; p < pageNodes.getLength(); p++) {
Page page = new Page();
pages.add(page);
Element pageNode = (Element) pageNodes.item(p);
if (pageNode.hasAttribute("label")) {
page.setLabel(pageNode.getAttribute("label"));
}
if (pageNode.hasAttribute("isSkipped")) {
page.setSkipped(pageNode.getAttribute("isSkipped").trim().equals("true"));
}
try {
parseSurveyElements(pageNode, page);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
return pages;
}
/**
* Read the configuration file. If it has an XSD, validate against it.
* @param config The reader that gives us access to the survey configuration file
* @throws Exception If there is an error reading from the config
*/
private void parseFromXML(Reader config) throws Exception {
String configString = configToString(config); //we must convert this into a string so that we can read from it more than once
//most readers passed in don't support the reset() method, otherwise I would use that.
//prepare input stream
xmlRoot = XMLUtil.getXMLRoot(new StringReader(configString));
if (!usingXSD(xmlRoot)) {
printNoXSDWarning();
} else {
XMLUtil.validateXML(new StringReader(configString), null);
}
parseTemplates();
}
private void printNoXSDWarning() {
System.err.println("WARNING: This survey configuration file is not using the proper xsd and it will not be validated. Unexpected behavior may occur as a result.\n" +
"Please add these attributes to its <surveyConfig> element: xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" " +
"xsi:noNamespaceSchemaLocation=\"" + XSD_LOCATION + "\"");
}
private boolean usingXSD(Element xmlRoot) {
return xmlRoot.hasAttribute("xsi:noNamespaceSchemaLocation");
}
private String configToString(Reader config) throws IOException {
StringBuilder buf = new StringBuilder();
BufferedReader reader = new BufferedReader(config);
String s;
while ((s = reader.readLine()) != null) {
buf.append(s).append(System.getProperty("line.separator"));
}
return buf.toString();
}
private void parseSurveyElements(Element pageNode, Page page) throws Exception {
NodeList elementNodes = pageNode.getChildNodes();
for (int i = 0; i < elementNodes.getLength(); i++) {
if (elementNodes.item(i) instanceof Element) {
Element elementNode = (Element) elementNodes.item(i);
if (elementNode.getTagName().equals("question")) {
Question question = buildQuestion(elementNode);
page.addQuestion(question);
} else {
Label label = new Label(elementNode.getTextContent());
page.addLabel(label);
}
}
}
}
private Question buildQuestion(Element questionRoot) throws Exception {
QuestionBuilder qb = new QuestionBuilder();
qb.setId(questionRoot.getAttribute("id"));
if (questionRoot.hasAttribute("mandatory")) {
qb.setMandatory(questionRoot.getAttribute("mandatory").equalsIgnoreCase("true"));
}
//try to find a label node
NodeList labelNodes = questionRoot.getElementsByTagName("label");
if (labelNodes.getLength() != 0) {
Element labelNode = (Element) labelNodes.item(0);
qb.setLabel(labelNode.getTextContent());
}
if (questionRoot.hasAttribute("default")) {
qb.setDefault(questionRoot.getAttribute("default"));
}
if (questionRoot.getElementsByTagName("onAnswerChanged").getLength() == 1) {
qb.setOnAnswerChangedScript(questionRoot.getElementsByTagName("onAnswerChanged").item(0).getTextContent());
}
//replace with template if the type is set to a template
if (questionRoot.getElementsByTagName("template").getLength() == 1) {
Template template = templateMap.get(((Element) questionRoot.getElementsByTagName("template").item(0)).getAttribute("name"));
return qb.buildTemplate(template);
} else {
return buildConcreteQuestion(qb, questionRoot);
}
}
private Question buildConcreteQuestion(QuestionBuilder qb, Element questionTypeElement) {
//instantiate other known types
if (questionTypeElement.getElementsByTagName("radioButtons").getLength() == 1) {
Element multiConfigElement = (Element) questionTypeElement.getElementsByTagName("radioButtons").item(0);
Boolean vertical = null;
if (multiConfigElement.hasAttribute("alignment")) {
vertical = multiConfigElement.getAttribute("alignment").equals("vertical");
}
String leftLabel = null;
if (multiConfigElement.hasAttribute("leftlabel")) {
leftLabel = multiConfigElement.getAttribute("leftlabel");
}
String rightLabel = null;
if (multiConfigElement.hasAttribute("rightlabel")) {
rightLabel = multiConfigElement.getAttribute("rightlabel");
}
List<Choice> choices = new Vector<Choice>();
NodeList choiceNodes = multiConfigElement.getElementsByTagName("choice");
for (int i = 0; i < choiceNodes.getLength(); i++) {
Element choiceNode = (Element) choiceNodes.item(i);
String id = choiceNode.getAttribute("id");
String label = choiceNode.getAttribute("label");
Choice choice = qb.buildChoice(id, label);
choices.add(choice);
}
return qb.buildRadioButtons(vertical, leftLabel, rightLabel, choices);
} else if (questionTypeElement.getElementsByTagName("dropdown").getLength() == 1) {
Element dropdownConfigElement = (Element) questionTypeElement.getElementsByTagName("dropdown").item(0);
List<Choice> choices = new Vector<Choice>();
NodeList choiceNodes = dropdownConfigElement.getElementsByTagName("choice");
for (int i = 0; i < choiceNodes.getLength(); i++) {
Element choiceNode = (Element) choiceNodes.item(i);
String id = choiceNode.getAttribute("id");
String label = choiceNode.getAttribute("label");
Choice choice = qb.buildChoice(id, label);
choices.add(choice);
}
return qb.buildDropdown(choices);
} else if (questionTypeElement.getElementsByTagName("textField").getLength() == 1) {
return qb.buildTextField();
} else if (questionTypeElement.getElementsByTagName("textArea").getLength() == 1) {
Element configElement = (Element) questionTypeElement.getElementsByTagName("textArea").item(0);
Integer rows = null;
if (configElement.hasAttribute("rows")) {
rows = Integer.valueOf(configElement.getAttribute("rows"));
}
return qb.buildTextArea(rows);
} else if (questionTypeElement.getElementsByTagName("yesNo").getLength() == 1) {
return qb.buildYesNo();
} else if (questionTypeElement.getElementsByTagName("checkbox").getLength() == 1) {
Element configElement = (Element) questionTypeElement.getElementsByTagName("checkbox").item(0);
if (configElement == null) {
return qb.buildCheckbox(null);
}
if (configElement.hasAttribute("boxOnRight")) {
boolean boxOnRight = configElement.getAttribute("boxOnRight").equals("true");
return qb.buildCheckbox(boxOnRight);
} else {
return qb.buildCheckbox(null);
}
} else if (questionTypeElement.getElementsByTagName("fileChooser").getLength() == 1) {
Element configElement = (Element) questionTypeElement.getElementsByTagName("fileChooser").item(0);
Boolean openDialog = null;
if (configElement.hasAttribute("chooserMode")) {
openDialog = configElement.getAttribute("chooserMode").trim().equals("open");
}
if (configElement == null) {
return qb.buildFileChooser(null, openDialog, null, null);
}
Boolean allFilesFilterEnabled = null;
if (configElement.hasAttribute("enableAllFilesFilter")) {
allFilesFilterEnabled = Boolean.valueOf(configElement.getAttribute("enableAllFilesFilter"));
}
String openTo = null;
if (configElement.hasAttribute("openTo")) {
openTo = configElement.getAttribute("openTo");
}
List<FileFilter> fileFilters = new Vector<FileFilter>();
NodeList fileFilterNodes = configElement.getElementsByTagName("fileFilter");
for (int i = 0; i < fileFilterNodes.getLength(); i++) {
Element fileFilterElement = (Element) fileFilterNodes.item(i);
String extension = fileFilterElement.getAttribute("extension");
String description = fileFilterElement.getAttribute("description");
FileFilter fileFilter = qb.buildFileFilter(extension, description);
fileFilters.add(fileFilter);
}
return qb.buildFileChooser(allFilesFilterEnabled, openDialog, openTo, fileFilters);
}
try {
throw new IllegalArgumentException("A suitable question could not be found that matches this type:\n" + XMLUtil.elementToString(questionTypeElement));
} catch (IOException e) {
throw new IllegalArgumentException("A suitable question could not be found that matches this type");
}
}
private void parseTemplates() {
//read all type templates
NodeList templatesList = xmlRoot.getElementsByTagName("templates");
for (int i = 0; i < templatesList.getLength(); i++) {
Element templatesElement = (Element) templatesList.item(i);
NodeList templates = templatesElement.getElementsByTagName("template");
for (int j = 0; j < templates.getLength(); j++) {
Element templateElement = (Element) templates.item(j);
QuestionBuilder builder = new QuestionBuilder();
builder.setId("TEMPLATE").setMandatory(false);
Question template = buildConcreteQuestion(builder, templateElement);
String name = templateElement.getAttribute("name");
templateMap.put(name, template);
}
}
}
public Map<String, Template> getTemplateMap() {
return templateMap;
}
public Menu getMenu() {
Menu menu = new Menu();
if (xmlRoot.getElementsByTagName("menu").getLength() == 0) {
menu.setExists(false);
return menu;
} else {
menu.setExists(true);
Element menuElement = (Element) xmlRoot.getElementsByTagName("menu").item(0);
menu.setFirstPage(menuElement.getElementsByTagName("firstPage").getLength() == 1);
menu.setLastPage(menuElement.getElementsByTagName("lastPage").getLength() == 1);
menu.setNextPage(menuElement.getElementsByTagName("nextPage").getLength() == 1);
menu.setOpen(menuElement.getElementsByTagName("open").getLength() == 1);
menu.setPreviousPage(menuElement.getElementsByTagName("previousPage").getLength() == 1);
menu.setSave(menuElement.getElementsByTagName("save").getLength() == 1);
menu.setSaveAs(menuElement.getElementsByTagName("saveAs").getLength() == 1);
return menu;
}
}
public boolean saveToFileOnFinish() {
if (!xmlRoot.hasAttribute("saveToFileOnFinish")) {
return false;
}
return xmlRoot.getAttribute("saveToFileOnFinish").equals("true");
}
}