/
AbstractDocumentMapModel.java
500 lines (458 loc) · 13.5 KB
/
AbstractDocumentMapModel.java
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
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
344
345
346
347
348
349
350
351
352
353
354
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
package com.timtripcony;
import java.util.ArrayList;
import java.util.Map;
import java.util.Vector;
import java.util.Map.Entry;
import javax.faces.context.FacesContext;
import org.apache.commons.lang.StringUtils;
import org.openntf.domino.Document;
import org.openntf.domino.Item;
import org.openntf.domino.Item.Type;
import uk.co.intec.utils.AppUtils;
import com.ibm.commons.util.StringUtil;
import com.ibm.jscript.debug.ArrayListUtil;
import com.ibm.xsp.extlib.util.ExtLibUtil;
import com.ibm.xsp.model.domino.wrapped.DominoDocument;
/*
Copyright 2015 Tim Tripcony, Paul Withers
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License
*/
/**
* @author Tim Tripcony, Paul Withers
*
* Extension of AbstractMapModel to add Document-related / XPages-related properties. Amended by PW to rely on
* OpenNTF Domino API (this allowed me to remove a lot of code Tim had repeated from ODA)
*
*/
public abstract class AbstractDocumentMapModel extends AbstractMapModel {
private static final long serialVersionUID = 1L;
private String unid;
private String parentUnid;
private String documentId;
private boolean ignoreRequestParams;
private String requestParamPrefix;
private DominoDocument wrappedDoc;
private boolean newNote;
private boolean deleted;
private boolean readOnly;
private Map<String, Item.Type> fieldTypeMap;
/**
* Constructor, calling overloaded constructor and simulating DominoDocument datasource, to get default Document
* based on URL
*/
public AbstractDocumentMapModel() {
this(false, "", "");
}
/**
* Overloaded constructor, added by PW, allowing loading based on ignoreRequestParams, requestParamPrefix and
* documentId URL parameter
*
* @param ignoreRequestParams
* boolean whether or not to load UNID, action etc from URL parameters
* @param requestParamPrefix
* String alternative requestParamPrefix for UNID, action etc URL parameters
* @param documentId
* String alternative UNID / Note ID from which to load Document
*/
public AbstractDocumentMapModel(boolean ignoreRequestParams, String requestParamPrefix, String documentId) {
// This doesn't get called immediately, so we can set properties elsewhere
try {
setIgnoreRequestParams(ignoreRequestParams);
setRequestParamPrefix(requestParamPrefix);
setDocumentId(documentId);
if (StringUtils.isEmpty(getRequestParamPrefix())) {
setRequestParamPrefix("documentId");
}
if (!isIgnoreRequestParams()) {
setDocumentId(ExtLibUtil.readParameter(FacesContext.getCurrentInstance(), getRequestParamPrefix()));
}
if (StringUtil.isNotEmpty(getDocumentId())) {
load(getDocumentId());
} else {
initNew();
}
} catch (Throwable t) {
AppUtils.handleException(t);
}
}
/**
* Getter for unid property
*
* @return String UNID of the Document being interacted with
*/
public String getUnid() {
return unid;
}
/**
* Setter for unid property
*
* @param unid
* String of the Document to interact with
*/
public void setUnid(String unid) {
this.unid = unid;
}
/**
* A Map of Item names and the specific Item type (e.g. READERS, AUTHORS etc). Added by PW
*
* @return Map<String, Item.Type> specific Item types, where Key = Item name, Value = Item type
*/
public Map<String, Item.Type> getFieldTypeMap() {
return fieldTypeMap;
}
/**
* Load a Map of Item names and specific Item types (e.g. READERS, AUTHORS etc). Added by PW
*
* @param fieldTypeMap
* Map<String, Item.Type> specific Item types, where Key = Item name, Value = Item type
*/
public void setFieldTypeMap(Map<String, Item.Type> fieldTypeMap) {
this.fieldTypeMap = fieldTypeMap;
}
/**
* Returns Form name to use for this Document
*
* @return String Form property of this Document
*/
public abstract String getFormName();
/**
* Returns a description for the Form used for this Document, useful for displaying in Form Tables
*
* @return String Form description
*/
public abstract String getFormDescription();
/**
* Sets the Document as a new note
*/
public void initNew() {
setNewNote(true);
}
/**
* Loads the object with settings based on the passed UNID:
* <ul>
* <ol>
* Whether or not it is a new Document
* </ol>
* <ol>
* Whether or not the Document is deleted
* </ol>
* <ol>
* Whether or not the Document is read only
* </ol>
* <ol>
* Sets wrappedDoc as a DominoDocument object
* </ol>
* <ol>
* Loads all fields into the object, omitting named fields, anything prefixed with "$", or with type "Error"
* </ol>
* </ul>
*
* Extended by PW to allow specific fields to be ignored and to ensure empty fields are loaded as "" (empty String),
* not "[]" (String version of empty Vector)
*
* @param unid
* String UNID or Note ID relating to this Document (empty = new Document)
*/
public void load(final String unid) {
setUnid(unid);
Document doc = null;
setNewNote(true); // Default to true
setDeleted(false); // Default to false
setReadOnly(false); // Default to false
try {
if (StringUtil.isNotEmpty(unid)) {
try {
doc = AppUtils.getDocumentByNoteID_Or_UNID(unid);
setWrappedDoc(DominoDocument.wrap(AppUtils.getDataDbPath(), // database name
doc, // Document
null, // computeWithForm
null, // concurrency Mode
false, // allowDeletedDocs
null, // saveLinksAs
null)); // webQuerySaveAgent
for (Object eachItem : doc.getItems()) {
if (eachItem instanceof Item) {
Item item = (Item) eachItem;
String itemName = item.getName();
// Certainly not a comprehensive list of items to skip
ArrayList<String> ignoreList = ArrayListUtil.stringToArrayList("MIME_Version");
String firstChar = StringUtils.left(itemName, 1);
if (!ignoreList.contains(itemName) && !StringUtils.equals(firstChar, "$")) {
// Item may be of type "Error"
if (item.getType() != Type.ERRORITEM.getValue()) {
Object itemValue = wrappedDoc.getValue(itemName);
setValue(itemName, itemValue);
if (itemValue instanceof Vector) {
if ("[]".equals(itemValue.toString())) {
setValue(itemName, new String(""));
}
}
}
}
}
}
if (doc.isDeleted() || !doc.isValid()) {
setDeleted(true);
}
setNewNote(false);
} catch (Throwable t) {
AppUtils.handleException(t);
}
}
} catch (Throwable t) {
AppUtils.handleException(t);
}
}
/**
* PostSave event code to run
*
* @return boolean Success / Failure in running postSave code, required to handle onward routing
*/
public boolean postSave() {
return true;
}
/**
* QuerySave event code to run
*
* @return boolean success / Failure in running querySave code, required to handle onward routing
*/
public boolean querySave() {
return true;
}
/**
* Sets Item types based on fieldTypeMap. Currently only handles READERS, AUTHORS or NAMES
*
* @param doc
* Document being saved
* @return boolean success / failure of setting Item types
*/
public boolean setSpecialFieldTypes(Document doc) {
boolean result = false;
try {
if (getFieldTypeMap() != null) {
for (String itemName : getFieldTypeMap().keySet()) {
if (doc.hasItem(itemName)) {
Item item = doc.getFirstItem(itemName);
Item.Type fieldType = getFieldTypeMap().get(itemName);
if (fieldType.equals(Type.AUTHORS)) {
item.setAuthors(true);
} else if (fieldType.equals(Type.READERS)) {
item.setReaders(true);
} else if (fieldType.equals(Type.NAMES)) {
item.setNames(true);
}
}
}
}
return true;
} catch (Throwable t) {
AppUtils.handleException(t);
}
return result;
}
/**
* Save of the Document, calling querySave at the start and postSave at the end
*
* @return boolean success / failure of the save
*/
public boolean save() {
boolean result = false;
if (querySave()) {
Document doc = null;
try {
if (StringUtil.isEmpty(getUnid())) {
doc = AppUtils.getDataDb().createDocument();
setUnid(doc.getUniversalID());
doc.replaceItemValue("Form", getFormName());
} else {
doc = AppUtils.getDocumentByNoteID_Or_UNID(getUnid());
}
for (Entry entry : getValues().entrySet()) {
String itemName = entry.getKey().toString();
doc.replaceItemValue(itemName, entry.getValue());
}
if (setSpecialFieldTypes(doc)) {
if (doc.save()) {
if (StringUtils.isNotEmpty(parentUnid)) {
Document parentDoc = AppUtils.getDocumentByNoteID_Or_UNID(parentUnid);
doc.makeResponse(parentDoc);
}
result = postSave();
setNewNote(false);
}
}
} catch (Throwable t) {
AppUtils.handleException(t);
}
}
return result;
}
/**
* Overloaded save method, allowing navigation handling to force return to a view, if required
*
* @param goToView
* boolean whether or not to go to the view
* @return String navigationRule name (defaults are xsp-success for going to next page, xsp-current to stay on
* current page)
*/
public String save(boolean goToView) {
String retVal_ = "";
try {
if (save()) {
if (goToView) {
retVal_ = "xsp-success";
} else {
retVal_ = "xsp-current";
}
} else {
AppUtils.addFacesMessage("Save failed");
}
} catch (Throwable t) {
AppUtils.handleException(t);
}
return retVal_;
}
/**
* Setter for newNote
*
* @param newNote
* boolean whether or not this is a new Document
*/
public void setNewNote(boolean newNote) {
this.newNote = newNote;
}
/**
* Getter for newNote
*
* @return boolean whether or not this is a new Document
*/
public boolean isNewNote() {
return newNote;
}
/**
* Setter for deleted. <b>NB</b> Not intended to actually delete the document
*
* @param deleted
* boolean whether or not the Document should be considered deleted
*/
public void setDeleted(boolean deleted) {
this.deleted = deleted;
}
/**
* Getter for deleted
*
* @return boolean whether or not the document is deleted
*/
public boolean isDeleted() {
return deleted;
}
/**
* Setter for readOnly
*
* @param readOnly
* boolean whether or not the Document should be considered read only
*/
public void setReadOnly(boolean readOnly) {
this.readOnly = readOnly;
}
/**
* Getter for readOnly
*
* @return boolean whether or not the Document is read only
*/
public boolean isReadOnly() {
return readOnly;
}
/**
* Setter for wrappedDoc
*
* @param wrappedDoc
* DominoDocument XPages wrapper for the Document
*/
public void setWrappedDoc(DominoDocument wrappedDoc) {
this.wrappedDoc = wrappedDoc;
}
/**
* Getter for wrappedDoc
*
* @return DominoDocument XPages wrapper for the Document
*/
public DominoDocument getWrappedDoc() {
return wrappedDoc;
}
/**
* Setter for parentUnid
*
* @param parentUnid
* String UNID or NoteID of the Document's parent
*/
public void setParentUnid(String parentUnid) {
this.parentUnid = parentUnid;
}
/**
* Getter for parentUnid
*
* @return String UNID or NoteID of the Document's parent
*/
public String getParentUnid() {
return parentUnid;
}
/**
* Setter for ignoreRequestParams
*
* @param ignoreRequestParams
* boolean whether or not to ignore request parameters when initialising the Document
*/
public void setIgnoreRequestParams(boolean ignoreRequestParams) {
this.ignoreRequestParams = ignoreRequestParams;
}
/**
* Getter for ignoreRequestParams
*
* @return boolean whether or not to ignore request parameters when initialising the Document
*/
public boolean isIgnoreRequestParams() {
return ignoreRequestParams;
}
/**
* Setter for documentId
*
* @param documentId
* String UNID or NoteID for the Document
*/
public void setDocumentId(String documentId) {
this.documentId = documentId;
}
/**
* Getter for documentId
*
* @return String UNID or NoteID for the Document
*/
public String getDocumentId() {
return documentId;
}
/**
* Setter for requestParamPrefix
*
* @param requestParamPrefix
* String URL parameter to use to locate the Document's URL parameters
*/
public void setRequestParamPrefix(String requestParamPrefix) {
this.requestParamPrefix = requestParamPrefix;
}
/**
* String getter for requestParamPrefix
*
* @return String URL parameter to use to locate the Document's URL parameters
*/
public String getRequestParamPrefix() {
return requestParamPrefix;
}
}