Newer
Older
package org.etsi.mts.tdl.tools.to.docx;
import org.docx4j.XmlUtils;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.docx4j.openpackaging.parts.WordprocessingML.StyleDefinitionsPart;
import org.docx4j.wml.*;
import org.docx4j.jaxb.*;
import org.docx4j.openpackaging.exceptions.Docx4JException;
import org.docx4j.openpackaging.exceptions.InvalidFormatException;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
//import javax.xml.bind.JAXBElement;
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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
public class WordTemplateTestObjective {
String NAME = "<TESTOBJECTIVENAMELABEL_PLACEHOLDER>";
String DESCRIPTION = "<DESCRIPTIONLABEL_PLACEHOLDER>";
String URI = "<URIOFOBJECTIVELABEL_PLACEHOLDER>";
String CONFIGURATION = "<CONFIGURATIONLABEL_PLACEHOLDER>";
String PICS = "<PICSSELECTIONLABEL_PLACEHOLDER>";
String INITIAL = "<INITIALCONDITIONSLABEL_PLACEHOLDER>";
String EXPECTED = "<EXPECTEDBEHAVIOURLABEL_PLACEHOLDER>";
String FINAL = "<FINALCONDITIONSLABEL_PLACEHOLDER>";
String WHEN = "<EXPECTEDBEHAVIOURLABEL_WHENPART_PLACEHOLDER>";
String THEN = "<EXPECTEDBEHAVIOURLABEL_THENPART_PLACEHOLDER>";
String THEN_DIRECTION = "<THEN_DIRECTION>";
String WHEN_DIRECTION = "<WHEN_DIRECTION>";
private String templateFileName = "TO_TableTemplates.docx";
private String inputFileName = "empty.docx";
// private final String optFieldPrefix = "<OPT_"; // The prefix of place-holders that if replace string is empty cause the table row to be deleted.
/**
* Constructor for class WordTemplateTestObjective
*/
public WordTemplateTestObjective () {
}
public void init() {
try {
this.wordMLPackageTemplates = WordprocessingMLPackage.createPackage();
} catch (InvalidFormatException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
try {
this.wordMLPackageTO = WordprocessingMLPackage.load(new java.io.File(getInputFileName()));
} catch (Docx4JException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
// Open template file
try {
this.wordMLPackageTemplates = openTemplatesDocument(getTemplateFileName());
} catch (FileNotFoundException | Docx4JException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
this.wordTemplateStylePart = wordMLPackageTemplates.getMainDocumentPart().getStyleDefinitionsPart();
try {
this.templateStyles = wordTemplateStylePart.getContents();
} catch (Docx4JException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
// Extract the list of template tables from the template file
this.templateTableList = getAllElementFromObject(wordMLPackageTemplates.getMainDocumentPart(), Tbl.class);
// Insert the styles definition part from the templates word file.
wordMLPackageTO.getMainDocumentPart().getStyleDefinitionsPart().setContents(templateStyles);
}
/**
* Search for the specified table template. If found it sets the cloned table to the
* the table template and deletes the table template key row from the cloned table.
* @param templateKey
* @return true if the template table with the specified templateKey is found
*/
public boolean selectTemplateTable( String templateKey )
{
boolean searchResult = false;
List<Object> rows;
Tr templateRow;
for (Iterator<Object> iterator = templateTableList.iterator(); iterator.hasNext();) {
Object tbl = iterator.next();
List<?> textElements = getAllElementFromObject(tbl, Text.class);
for (Object text : textElements) {
Text textElement = (Text) text;
if (textElement.getValue() != null && textElement.getValue().equals(templateKey)) {
selectedTemplateTable = (Tbl) XmlUtils.deepCopy(tbl); // Clone the selected table
rows = getAllElementFromObject(selectedTemplateTable, Tr.class);
templateRow = (Tr) rows.get(0); // Get the first table row where the table key is defined
selectedTemplateTable.getContent().remove(templateRow);
searchResult = true;
return searchResult;
}
}
}
return searchResult;
}
/**
* Retrieve the list of place holder identifiers of the selected table template.
* @return The list of place holder identifiers
*/
public List<String> getAllPlaceholders() {
List<String> placeHolderStrs = new ArrayList<>();
List<Object> paragraphs = getAllElementFromObject(selectedTemplateTable, P.class);
for (Object p : paragraphs)
{
List<Object> texts = getAllElementFromObject(p, Text.class);
for (Object t : texts)
{
Text content = (Text) t;
if (content.getValue().matches("<[a-zA-Z_0-9]+>") ) // Any sequence of word characters enclosed by '<' and '>' characters
{
placeHolderStrs.add(content.getValue());
} else {
//System.out.println("::"+content.getValue());
}
}
}
return placeHolderStrs;
}
/**
* Get the list of table template identifiers
* @return the list of table template identifiers
*/
public List<String> getTemplateIdentifiers() {
List<String> tableIds = new ArrayList<>();
for (Iterator<Object> iterator = templateTableList.iterator(); iterator.hasNext();)
{
Object tbl = iterator.next();
List<Object> rows = getAllElementFromObject(tbl, Tr.class);
if ( !rows.isEmpty() )
{
Tr templateRow = (Tr) rows.get(0); // Get the first table row where the table key is defined
List<?> textElements = getAllElementFromObject(templateRow, Text.class);
for (Object text : textElements)
{
Text textElement = (Text) text;
if (textElement.getValue() != null )
{
tableIds.add(textElement.getValue());
}
}
}
}
return tableIds;
}
public boolean createNewTableFromSelectedTemplate() {
boolean result = false;
Tbl newTable = new Tbl();
if ( selectedTemplateTable != null )
{
newTable = (Tbl) XmlUtils.deepCopy(selectedTemplateTable);
workingTable = newTable;
result = true;
}
return result;
}
public void writeDocumentToFile( String fname )
{
try {
writeDocxToStream( wordMLPackageTO, fname );
} catch (IOException | Docx4JException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/**
* Replace the specified placeholder string with the specified text (list of strings).
* @param newText
* @param placeholder
*/
public void substitutePlaceholder( List<String> newText, String placeholder ) {
List<Object> trows = getAllElementFromObject(workingTable, Tr.class);
P toReplace = null;
List<Object> replaceparagraphs = getAllElementFromObject(workingTable, P.class);
for (Object p : replaceparagraphs) {
List<Object> texts = getAllElementFromObject(p, Text.class);
for (Object t : texts) {
Text content = (Text) t;
if (content.getValue().equals(placeholder)) {
toReplace = (P) p;
break;
}
}
}
if (toReplace == null) {
//System.out.println(":: Could not match placeholder " +placeholder);
}
for (Object tr : trows)
{
Tr tblrow = (Tr) tr;
List<Object> tcells = getAllElementFromObject(tr, Tc.class);
for (Object tc : tcells)
{
Tc tblcell = (Tc) tc;
List<Object> paragraphs = getAllElementFromObject(tc, P.class);
for (Object p : paragraphs)
{
List<Object> texts = getAllElementFromObject(p, Text.class);
for (Object t : texts)
{
Text content = (Text) t;
if (content.getValue().equals(placeholder))
{
boolean isNewTextEmpty = false;
if ( newText == null || newText.isEmpty())
{
newText = Arrays.asList("");
//isNewTextEmpty = true;
}
if (!( isNewTextEmpty //&& (placeholder.startsWith(optFieldPrefix))
) ) // Placeholder to be replaced with text
{
Iterator<String> iterator = newText.iterator();
while ( iterator.hasNext() )
{
P copy = new P();
copy = (P) XmlUtils.deepCopy(toReplace);
// replace the text elements from the copy
List<?> copytexts = getAllElementFromObject(copy, Text.class);
if (copytexts.size() > 0) {
Text textToReplace = (Text) copytexts.get(0);
textToReplace.setValue( (String) iterator.next());
textToReplace.setSpace("preserve");
}
tblcell.getContent().add(copy);
}
tblcell.getContent().remove(0); // Delete original placeholder paragraph
}
else // The replacement text list is empty and the placeholder is an optional field so the table row is deleted.)
{
//workingTable.getContent().remove(tblrow);
}
}
}
}
}
}
}
public void addWorkingTableToDocument() {
wordMLPackageTO.getMainDocumentPart().addObject(workingTable);
}
public void addParagraphToDocument( String s ) {
org.docx4j.wml.ObjectFactory locfactory = Context.getWmlObjectFactory();
org.docx4j.wml.P para = locfactory.createP();
org.docx4j.wml.Text t = locfactory.createText();
org.docx4j.wml.R run = locfactory.createR();
t.setValue( s );
run.getContent().add(t);
para.getContent().add(run);
this.wordMLPackageTO.getMainDocumentPart().addObject(para);
}
/**
* retrieve a list elements of specified type contained in specified object
* @param obj the object from which to retrieve the type of elements
* @param toSearch
* @return
*/
private static List<Object> getAllElementFromObject(Object obj, Class<?> toSearch) {
List<Object> result = new ArrayList<Object>();
// if (obj instanceof JAXBElement) obj = ((JAXBElement<?>) obj).getValue();
//
// if (obj.getClass().equals(toSearch))
// result.add(obj);
// else if (obj instanceof ContentAccessor) {
// List<?> children = ((ContentAccessor) obj).getContent();
// for (Object child : children) {
// result.addAll(getAllElementFromObject(child, toSearch));
// }
//
// }
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
return result;
}
/**
* Open the specified template file
*/
private static WordprocessingMLPackage openTemplatesDocument(String name) throws Docx4JException, FileNotFoundException
{
WordprocessingMLPackage template = WordprocessingMLPackage.load(new FileInputStream(new File(name)));
return template;
}
/**
* Save the modified template to the specified output Word file.
*/
private static void writeDocxToStream(WordprocessingMLPackage template, String target) throws IOException, Docx4JException
{
File f = new File(target);
template.save(f);
}
// Private variables
public String getTemplateFileName() {
return templateFileName;
}
public void setTemplateFileName(String templateFileName) {
this.templateFileName = templateFileName;
}
public String getInputFileName() {
return inputFileName;
}
public void setInputFileName(String inputFileName) {
this.inputFileName = inputFileName;
}
private Tbl selectedTemplateTable; // The orignal selected table template
private Tbl workingTable = null; // The table being modified before added to the output file
private List<Object> templateTableList;
private WordprocessingMLPackage wordMLPackageTemplates; // Word document with Table templates
private StyleDefinitionsPart wordTemplateStylePart; // Style part in the template document
private Styles templateStyles;
private WordprocessingMLPackage wordMLPackageTO = null; // New Word document to be with filled Test Objective tables
}