summaryrefslogtreecommitdiffstats
blob: ab14a4e8dd0106ee56550ac403bbb1ba8d0ab3eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
/*
 * Copyright (c) 2012-2014 Isode Limited, London, England.
 * All rights reserved.
 */
/*
 * Copyright (c) 2010 Remko Tronçon
 * All rights reserved.
 */

package com.isode.stroke.parser.payloadparsers;

import java.util.ArrayList;
import java.util.List;

import com.isode.stroke.elements.Form;
import com.isode.stroke.elements.Form.Type;
import com.isode.stroke.elements.FormField;
import com.isode.stroke.elements.FormField.Option;
import com.isode.stroke.elements.FormItem;
import com.isode.stroke.elements.FormText;
import com.isode.stroke.elements.FormReportedRef;
import com.isode.stroke.elements.FormPage;
import com.isode.stroke.elements.FormSection;
import com.isode.stroke.parser.AttributeMap;
import com.isode.stroke.parser.GenericPayloadParser;

/**
 * Parser for {@link Form} element.
 */
public class FormParser extends GenericPayloadParser<Form> {
	
	private List<FormField> currentFields_ = new ArrayList<FormField>();
	private FormField currentField_ = null;
	private FormItem currentItem_ = null;
	private boolean parsingReported_ = false;
    private boolean parsingOption_ = false;
    private String currentOptionValue_ = "";
    private String currentText_ = "";
    private String currentFieldRef_ = "";
    private boolean parsingItem_ = false;
    private boolean parseStarted_ = false;
    private boolean hasReportedRef_ = false;
    private FormText currentTextElement_;
    private FormReportedRef currentReportedRef_;
    private FormPage currentPage_;
    private FormSection currentSection_;
    private List<FormPage> currentPages_ = new ArrayList<FormPage>();
    private List<FormSection> sectionStack_ = new ArrayList<FormSection>();
    private List<FormSection> currentSections_ = new ArrayList<FormSection>();
    private static final int TopLevel = 0; 
    private static final int PayloadLevel = 1;
    private static final int FieldLevel = 2;

    private int level_;
    private String currentOptionLabel_ = "";

    /**
     * Constructor
     */
    public FormParser() {
        super(new Form());
        level_ = TopLevel;
    }

    @Override
    public void handleStartElement(String element, String ns,
            final AttributeMap attributes) {
        if (element == null) {
            throw new NullPointerException("'element' must not be null");
        }
        if (ns == null) {
            throw new NullPointerException("'ns' must not be null");
        }
        if (attributes == null) {
            throw new NullPointerException("'attributes' must not be null");
        }
        Form form = getPayloadInternal();

        if (level_ == TopLevel) {
            String type = attributes.getAttribute(Form.FORM_ATTRIBUTE_TYPE);
            form.setType(Type.getType(type));
        } 
        
        else if (level_ == PayloadLevel) {
            if (element.equals(Form.FORM_ELEMENT_TITLE)) {
                currentText_ = "";
            } 
            
            else if (element.equals(Form.FORM_ELEMENT_INSTRUCTIONS)) {
            	currentText_ = "";
            } 
            
            else if (element.equals(Form.FORM_ELEMENT_REPORTED)) {
            	parsingReported_ = true;
            }
            
            else if (element.equals(Form.FORM_ELEMENT_ITEM)) {
                parsingItem_ = true;
            	currentItem_ = new FormItem();
            }
            else if (element == "page") {
                currentPage_ = new FormPage();
                currentPage_.setLabel(attributes.getAttribute("label"));
            }
        } 
        
        else if (level_ == FieldLevel && currentField_ != null) {
    		currentText_ = "";
            if (element.equals(FormField.FORM_FIELD_ELEMENT_OPTION)) {
                currentOptionLabel_ = attributes
                        .getAttribute(FormField.FORM_FIELD_ATTRIBUTE_OPTION_LABEL);
                currentOptionValue_ = "";
                parsingOption_ = true;
            }
        }
        
        if (level_ >= PayloadLevel) {
        	if (element.equals(Form.FORM_ELEMENT_FIELD)) {
            	currentField_ = new FormField(FormField.Type.UNKNOWN_TYPE);
                String type = attributes.getAttribute(FormField.FORM_FIELD_ATTRIBUTE_TYPE);
                if (type == null) {
                    type = "";
                }
                FormField.Type fieldType = FormField.Type.getTypeFromString(type);
                String name = attributes.getAttribute(FormField.FORM_FIELD_ATTRIBUTE_VAR);
                String label = attributes.getAttribute(FormField.FORM_FIELD_ATTRIBUTE_LABEL);
                currentField_.setType(fieldType);
                currentField_.setName(name);
                currentField_.setLabel(label);
            }
        	
            else if (element.equals(FormField.FORM_FIELD_ELEMENT_VALUE)) {
            	currentText_ = "";
            }
        }
        if (level_ > PayloadLevel) {
            if (element.equals("section")) {
                currentSection_ = new FormSection();
                currentSection_.setLabel(attributes.getAttribute("label"));
                sectionStack_.add(currentSection_);
                currentSections_.add(currentSection_);
            }
            if (element.equals("reportedref")) {
                currentReportedRef_ = new FormReportedRef();
            }
            if (element.equals("fieldref")) {
                currentText_ = "";
                currentFieldRef_ = attributes.getAttribute("var");
                if (sectionStack_.size() > 0) {
                    sectionStack_.get(sectionStack_.size()-1).addFieldRef(currentFieldRef_);
                } else if (currentPage_ != null) {
                    currentPage_.addFieldRef(currentFieldRef_);
                }
            }
            if (element.equals("text")) {
                currentText_ = "";
                currentTextElement_ = new FormText();
            }
        }
        ++level_;
    }
    
    @Override
    public void handleEndElement(String element, String ns) {
        if (element == null) {
            throw new NullPointerException("'element' must not be null");
        }
        if (ns == null) {
            throw new NullPointerException("'ns' must not be null");
        }

        --level_;
        Form form = getPayloadInternal();

        if (level_ == PayloadLevel) {
            if (element.equals(Form.FORM_ELEMENT_TITLE)) {
                String currentTitle = form.getTitle();
                if (currentTitle.isEmpty()) {
                    form.setTitle(currentText_);
                } else {
                    form.setTitle(currentTitle + "\n" + currentText_);
                }
            } 
            
            else if (element.equals(Form.FORM_ELEMENT_INSTRUCTIONS)) {
                String currentInstructions = form.getInstructions();
                if (currentInstructions.isEmpty()) {
                    form.setInstructions(currentText_);
                } else {
                    form.setInstructions(currentInstructions + "\n"
                            + currentText_);
                }
            } 
            
            else if (element.equals(Form.FORM_ELEMENT_REPORTED)) {
            	parsingReported_ = false;
            }
            
            else if (element.equals(Form.FORM_ELEMENT_ITEM)) {
                parsingItem_ = false;                
            	currentItem_.addItemFields(currentFields_);
            	form.addItem(currentItem_);
            	currentFields_.clear();
            	currentItem_ = null;
            }
            else if (element.equals("page")) {
                getPayloadInternal().addPage(currentPage_);
                currentPages_.add(currentPage_);
            }
        }

        else if (currentField_ != null) {
            if (element.equals(FormField.FORM_FIELD_ELEMENT_REQUIRED)) {
            	currentField_.setRequired(true);
            } 
            else if (element.equals(FormField.FORM_FIELD_ELEMENT_DESC)) {
            	currentField_.setDescription(currentText_);
            } 
            else if (element.equals(FormField.FORM_FIELD_ELEMENT_OPTION)) {
            	currentField_.addOption(
                        new Option(currentOptionLabel_, currentOptionValue_));
            	parsingOption_ = false;
            }
            else if (element.equals(FormField.FORM_FIELD_ELEMENT_VALUE)) {
            	if (parsingOption_) {
            		currentOptionValue_ = currentText_;
            	}
            	else {
            		currentField_.addValue(currentText_);
            	}
            }
        }
        
        if (level_ >= PayloadLevel && currentField_ != null) {
            if (element.equals("field")) {
                if (parsingReported_) {
                    getPayloadInternal().addReportedField(currentField_);
                } 
                else if (parsingItem_) {
                    currentFields_.add(currentField_);
                } 
                else {
                    if (currentPages_.size() > 0) {
                        for (FormPage page : currentPages_) {
                            for (String pRef : page.getFieldRefs()) {
                                if (pRef.equals(currentField_.getName())) {
                                    page.addField(currentField_);
                                }
                            }
                        }
                        for (FormSection section : currentSections_) {
                            for (String sRef : section.getFieldRefs()) {
                                if (sRef.equals(currentField_.getName())) {
                                    section.addField(currentField_);
                                }
                            }
                        }
                    } else {
                        form.addField(currentField_);
                    }
                }
                currentField_ = null;
            }
        }
        if (level_ > PayloadLevel) {
            if (element.equals("section")) {
                if (sectionStack_.size() > 1) {
                    // Add the section at the top of the stack to the level below
                    sectionStack_.get(sectionStack_.size()-2).addChildSection(sectionStack_.get(sectionStack_.size()-1));
                    sectionStack_.remove(sectionStack_.size()-1);
                }
                else if (sectionStack_.size() == 1) {
                    // Add the remaining section on the stack to it's parent page
                    currentPage_.addChildSection(sectionStack_.get(sectionStack_.size()-1));
                    sectionStack_.remove(sectionStack_.size()-1);
                }
            }
            if (currentReportedRef_ != null && !hasReportedRef_) {
                if (sectionStack_.size() > 0) {
                    sectionStack_.get(sectionStack_.size()-1).addReportedRef(currentReportedRef_);
                } else if (currentPage_ != null) {
                    currentPage_.addReportedRef(currentReportedRef_);
                }
                hasReportedRef_ = true;
                currentReportedRef_ = null;
            }
            if (currentTextElement_ != null) {
                if (element.equals("text")) {
                    currentTextElement_.setTextString(currentText_);
                }
                if (sectionStack_.size() > 0) {
                    sectionStack_.get(sectionStack_.size()-1).addTextElement(currentTextElement_);
                } else if (currentPage_ != null) {
                    currentPage_.addTextElement(currentTextElement_);
                }
                currentTextElement_ = null;
            }
        }
    }
    
    @Override
    public void handleCharacterData(String text) {
        if (text == null) {
            throw new NullPointerException("'text' must not be null");
        }
        currentText_ += text;
    }

    @Override
    public String toString() {
        return FormParser.class.getSimpleName() + "\nlevel: " + level_
                + "\ncurrent text: " + currentText_
                + "\ncurrent option label: " + currentOptionLabel_;
    }
}