View source for Project VN2664QNR : Export to QSL from Questionnaire Editor

<accesscontrol>Main:MyGroup</accesscontrol>
== What's purpose of this project ? ==
The main goal of this project is to allow user to export the structure of a questionnaire template into a QSL script .
== Feature design == 
The feature design could be found here : 
\\catproc\Share\CatGlobe Teams\Questionnaire\Projects\Version 5.8\VN2644QNR - Export to QSL from Questionnaire Editor 
== Implement GUI == 
In this project , we need to write a new collapse-able container and a container that can hold a collection of collapse-able container because the editor only use Swing ( standard Java's API library for providing a graphical user interface ) and this library does not have an explicit collapse-able container . 
=== Class diagram ===
[[Image:Container.JPG‎]]
=== How to use an instance of collapse-able container === 
All sub panels of the container initialized once on constructor . The parameter of constructor contains an Array of sub panel's caption and an Array of sub panel . 
In order get the collapse-able container itself , use method getComponent()
TO add a collapse-able container to another 
== Making an customize save file dialog ==
Currently we have an class for customize save file dialog but this one has not been supported our customize file filter yet so i modified it a little bit so that it supports 
=== Making the a file filter ===
The default "All file(*.*)" filter is in inconvenient when using so it will be overwrite . Another useful of it is that we can have text resource fully supported .
==== Make QSL file filter ====
<source lang="java" line="1">
public class QSLFilter extends FileFilter {

    /* (non-Javadoc)
     * @see javax.swing.filechooser.FileFilter#accept(java.io.File)
     */
    @Override
    public boolean accept(File arg0) {
        // TODO Auto-generated method stub
        if(arg0.isDirectory())
            return true;
        else 
            return (getExtension(arg0).equals("qsl"));
    }

    /* (non-Javadoc)
     * @see javax.swing.filechooser.FileFilter#getDescription()
     */
    @Override
    public String getDescription() {
        
        // TODO Auto-generated method stub
        return "QSL file(*.qsl)";
    }
    public static String getExtension(File f) {
        String ext = null;
        String s = f.getName();
        int i = s.lastIndexOf('.');

        if (i > 0 &&  i < s.length() - 1) {
            ext = s.substring(i+1).toLowerCase();
        }
        return ext;
    }
</source>

== Export questionnaire template to QSL script == 
To implement export task , we need to go through the structure of the questionnaire template ( questionnaire , question , property , answer option , sub-question) and export to a text file . "Visitor Pattern" has been chosen because this pattern allows us add new operations to existing object structures without modifying those structures . Thus, using the visitor pattern helps conformance with the open/closed principle
=== Visitor pattern ===
[[Image:Visitor.PNG]]

=== QSL keyword using in exporting ===
The QSL keywords are defined in file questionnaire.g and we can't get keywords directly from it . In order to keep the synchronization with import QSL module , we will get the keyword from public variables of QuestionnaireLexer.java and QuestionnaireParser.java . Those 2 file were generated directly and automiccally from Questionnaire.g using ANTLR library .
=== Processing properties === 
In the questionnaire template , properties are only defined for questionnaire and question but QSL script has properties for sub question and answer option . We need to generate these properties from the properties of the related question . To solve this problem , we use 2 map ( Map in java used like a dictionary in .NET) to store properties relate to answer option and sub question . 
<br>Algorithm : 
<br>-Visit question element . If this question type has properties use for answer option ( or sub question ) , process them and put to the map 
<br>-When visit answer option ( or sub question ) , if the map is not empty then get the value from it and generate properties for answer option ( or sub question )
  
 [[category:Technical guidelines]]

=== Data structure use for export task ===
[[Image:DataStructure.PNG]]
==== General ====
The structure of questionnaire template is not completely fit the structure of QSL Script . We do not have an explicit property for answer option so we need to parse the to get the property for answer option from the range contains in question property's value . Another addition is that the properties for sub question is contained in question's properties . 
We have made 4 new class in this project : 
<br>   - ExportQSLVisitor : This class implements Visitor pattern . We also store internal information that is needed for export task ( export mode , visited question list ...) and information about the exported questionnaire ( properties set ) .
<br>   - ExportQSLVisitor : This class stores all information related to a question ( question properties , answer option , sub question , question text ) . It also include saperatedly the properties we use for answer option and sub question .
<br>   - AnswerOptionQSLExportData : Information of an answer option . 
<br>   - SubQuestionQSLExportData : Information of an sub question

==== Visit Questionnaire Element ====
If the export mode include questionnaire properties or using HTML , we initialize _questionnaireProperties

==== Visit Question Element ====
- If this question is not selected to export , ignore it and stop visiting
<br>- Create new instance of QuestionQSLExportData . Information of question will be created in constructor of QuestionQSLExportData
<br>- Storing the new QuestionQSLExportData

==== Visit Property Elemnt ====
- If this property belongs to questionnaire , check "Visit Questionnaire Property Element"
<br>- If this property belongs to question , check "Question Question property Element"
===== Visit Questionnaire Property Element =====
- Create a new QSLProperty for the property 
<br>- If the QSLProperty's output is valid , then store the output to Questionnaire Property

===== Visit Question Question property Element =====
- If this property belongs to a question which is not selected to export , than ignore it and stop visiting ( If the export task does not include question properties , also ignore)
<br> - If the property related to Answer Option and Range value call function handleAnswerOptionPropertyForRange of _currentQuestionData . Return
<br> - If the property related to Answer Option and single value call function handleAnswerOptionPropertyForSingle of _currentQuestionData . Return
<br> - If the property related to sub question of scale grid call function handleSubquestionForScaleGrid of _currentQuestionData . Return
<br> - Other wise , create a new QSLProperty instance for the property . If the QSLOutput is valid , call function insertQSLPropertyToQuestion of _currentQuestionData

==== Visit sub question Element ====
- If this sub question does not belong to a selected question , return . 
<br>- Other wise , create a SubQuestionQSLExportData for it . Use hasSubQuestionProperties to check if this sub question has property . If yes , get them from the parent question 
<br>- Add the new SubQuestionQSLExportData instance to _currentQuestionData

==== Visit answer option element ====
- If this answer option does not belong to a selected question , return .
<br>- Other wise , create a AnswerOptionQSLExportData for it . Use hasAnswerOptionProperties to check if this sub question has property . If yes , get them from the parent question
<br>- Add this new AnswerOptionQSLExportData instance to _currentQuestionData