1 | package eu.clarin.cmdi.vlo.config; |
---|
2 | |
---|
3 | import java.net.URI; |
---|
4 | import java.util.ArrayList; |
---|
5 | import java.util.Collection; |
---|
6 | import java.util.List; |
---|
7 | import java.util.Set; |
---|
8 | import javax.xml.bind.annotation.XmlElement; |
---|
9 | import javax.xml.bind.annotation.XmlElementWrapper; |
---|
10 | import javax.xml.bind.annotation.XmlRootElement; |
---|
11 | |
---|
12 | /** |
---|
13 | * VLO configuration |
---|
14 | * |
---|
15 | * @author keeloo, twagoo |
---|
16 | */ |
---|
17 | @XmlRootElement(name = "VloConfig") |
---|
18 | public class VloConfig { |
---|
19 | |
---|
20 | public static final String LANGUAGE_LINK_TEMPLATE_LANGUAGE_CODE_PLACEHOLDER = "{}"; |
---|
21 | public static final String DEFAULT_FACET_CONCEPTS_RESOURCE_FILE = "/facetConcepts.xml"; |
---|
22 | |
---|
23 | /* |
---|
24 | * VLO application parameter members<br><br> |
---|
25 | * |
---|
26 | * Please Initialise the annotated members in a proper way. This will allow |
---|
27 | * them to be linearised to corresponding elements in an XML file. |
---|
28 | * |
---|
29 | * Please refer to the general VLO documentation for a description of the |
---|
30 | * member parameters. |
---|
31 | */ |
---|
32 | // page cache related parameters |
---|
33 | private int pagesInApplicationCache = 0; |
---|
34 | |
---|
35 | private int sessionCacheSize = 0; |
---|
36 | |
---|
37 | // data base related parameters |
---|
38 | private String solrUrl = ""; |
---|
39 | |
---|
40 | // directive for Simple |
---|
41 | private boolean deleteAllFirst = false; |
---|
42 | |
---|
43 | private int maxDocsInList = 0; |
---|
44 | |
---|
45 | private int minDocsInSolrQueue = 0; |
---|
46 | |
---|
47 | //(required = false) |
---|
48 | private int solrTimeOut = 0; |
---|
49 | |
---|
50 | @XmlElementWrapper(name = "dataRoots") |
---|
51 | @XmlElement(name = "DataRoot") |
---|
52 | private List<DataRoot> dataRoot; |
---|
53 | |
---|
54 | private int maxFileSize = 0; |
---|
55 | |
---|
56 | private int maxDaysInSolr = 0; |
---|
57 | |
---|
58 | // mapping |
---|
59 | //(required = false) |
---|
60 | private String facetConceptsFile = ""; |
---|
61 | |
---|
62 | private String[] languageFilters = {"", "", ""}; |
---|
63 | |
---|
64 | private boolean printMapping = false; |
---|
65 | |
---|
66 | //(required = false) |
---|
67 | private String nationalProjectMapping = ""; |
---|
68 | |
---|
69 | private String organisationNamesUrl; |
---|
70 | |
---|
71 | private String languageNameVariantsUrl; |
---|
72 | |
---|
73 | private String licenseAvailabilityMapUrl; |
---|
74 | |
---|
75 | private String resourceClassMapUrl; |
---|
76 | |
---|
77 | private String countryComponentUrl = ""; |
---|
78 | |
---|
79 | private String language2LetterCodeComponentUrl = ""; |
---|
80 | |
---|
81 | private String language3LetterCodeComponentUrl = ""; |
---|
82 | |
---|
83 | private String silToISO639CodesUrl = ""; |
---|
84 | |
---|
85 | // services |
---|
86 | private String federatedContentSearchUrl = ""; |
---|
87 | |
---|
88 | private boolean useHandleResolver = false; |
---|
89 | |
---|
90 | @XmlElement |
---|
91 | private String profileSchemaUrl = ""; |
---|
92 | |
---|
93 | private String componentRegistryRESTURL = ""; |
---|
94 | |
---|
95 | private String handleServerUrl = ""; |
---|
96 | |
---|
97 | @XmlElement |
---|
98 | private String imdiBrowserUrl = ""; |
---|
99 | |
---|
100 | private String languageLinkTemplate = ""; |
---|
101 | |
---|
102 | // web application user interface |
---|
103 | private int facetOverviewLength = 0; |
---|
104 | |
---|
105 | private String homeUrl = ""; |
---|
106 | |
---|
107 | private String helpUrl = ""; |
---|
108 | |
---|
109 | private String feedbackFromUrl = ""; |
---|
110 | |
---|
111 | private boolean showResultScores = false; |
---|
112 | |
---|
113 | private boolean processHierarchies = true; |
---|
114 | |
---|
115 | /** |
---|
116 | * A set of fields to be excluded from display<br><br> |
---|
117 | * |
---|
118 | * To let JAXB know it has to interpret the element as an array, use the |
---|
119 | * XmlElementWrapper directive. Use the directive to let JAXB know that the |
---|
120 | * elements inside 'facetFields' are named 'facetField'. |
---|
121 | */ |
---|
122 | @XmlElementWrapper(name = "ignoredFields") |
---|
123 | private Set<String> ignoredField; |
---|
124 | /** |
---|
125 | * An array of fields to be included as technical properties<br><br> |
---|
126 | * |
---|
127 | * To let JAXB know it has to interpret the element as an array, use the |
---|
128 | * XmlElementWrapper directive. Use the directive to let JAXB know that the |
---|
129 | * elements inside 'facetFields' are named 'facetField'. |
---|
130 | */ |
---|
131 | |
---|
132 | @XmlElementWrapper(name = "technicalFields") |
---|
133 | private Set<String> technicalField; |
---|
134 | |
---|
135 | @XmlElementWrapper(name = "searchResultFields") |
---|
136 | private Set<String> searchResultField; |
---|
137 | |
---|
138 | /** |
---|
139 | * An array of facetFields<br><br> |
---|
140 | * |
---|
141 | * To let JAXB know it has to interpret the facetFields element as an array, |
---|
142 | * use the XmlElementWrapper directive. Use the directive to let JAXB know |
---|
143 | * that the elements inside 'facetFields' are named 'facetField'. |
---|
144 | */ |
---|
145 | @XmlElementWrapper(name = "facetFields") |
---|
146 | private List<String> facetField = new ArrayList<String>(); |
---|
147 | |
---|
148 | @XmlElementWrapper(name = "simpleSearchFacetFields") |
---|
149 | private List<String> simpleSearchFacetField; |
---|
150 | |
---|
151 | private String collectionFacet; |
---|
152 | |
---|
153 | // test related parameters |
---|
154 | //(required = false) |
---|
155 | private String reverseProxyPrefix = ""; |
---|
156 | |
---|
157 | //(required = false) |
---|
158 | private String cqlEndpointFilter = ""; |
---|
159 | |
---|
160 | //(required = false) |
---|
161 | private String cqlEndpointAlternative = ""; |
---|
162 | |
---|
163 | private URI configLocation; |
---|
164 | |
---|
165 | /** |
---|
166 | * Get and set methods for web application parameter members<br><br> |
---|
167 | * |
---|
168 | * By using a get or set method, you can apply an operation to a parameter |
---|
169 | * here without the need to make changes in different parts of the |
---|
170 | * application. |
---|
171 | */ |
---|
172 | /** |
---|
173 | * Get the value of the pagesInApplicationCache parameter<br><br> |
---|
174 | * |
---|
175 | * The parameter represents the number of pages that Wicket will allow to be |
---|
176 | * stored in the application's cache. |
---|
177 | * |
---|
178 | * @return the value |
---|
179 | */ |
---|
180 | public int getPagesInApplicationCache() { |
---|
181 | return pagesInApplicationCache; |
---|
182 | } |
---|
183 | |
---|
184 | /** |
---|
185 | * Set the value of the pagesInApplicationCache parameter<br><br> |
---|
186 | * |
---|
187 | * The parameter represents the number of pages that Wicket will allow to be |
---|
188 | * stored in the application's cache. |
---|
189 | * |
---|
190 | * @param param the value |
---|
191 | */ |
---|
192 | public void setPagesInApplicationCache(int param) { |
---|
193 | pagesInApplicationCache = param; |
---|
194 | } |
---|
195 | |
---|
196 | /** |
---|
197 | * Get the value of the sessionCacheSize parameter<br><br> |
---|
198 | * |
---|
199 | * The parameter represents the size in kilobytes of the session page cache. |
---|
200 | * |
---|
201 | * @return the value |
---|
202 | */ |
---|
203 | public int getSessionCacheSize() { |
---|
204 | return sessionCacheSize; |
---|
205 | } |
---|
206 | |
---|
207 | /** |
---|
208 | * Set the value of the sessionCacheSize parameter<br><br> |
---|
209 | * |
---|
210 | * The parameter represents the size in megabytes of the session page cache. |
---|
211 | * |
---|
212 | * @param param the value |
---|
213 | */ |
---|
214 | public void setSessionCacheSize(int param) { |
---|
215 | sessionCacheSize = param; |
---|
216 | } |
---|
217 | |
---|
218 | /** |
---|
219 | * Get the value of the deleteAllFirst parameter<br><br> |
---|
220 | * |
---|
221 | * For a description of the parameter, refer to the general VLO |
---|
222 | * documentation. |
---|
223 | * |
---|
224 | * @return the value |
---|
225 | */ |
---|
226 | public boolean getDeleteAllFirst() { |
---|
227 | return deleteAllFirst; |
---|
228 | } |
---|
229 | |
---|
230 | /** |
---|
231 | * Set the value of the deleteAllFirst parameter<br><br> |
---|
232 | * |
---|
233 | * For a description of the parameter, refer to the general VLO |
---|
234 | * documentation. |
---|
235 | * |
---|
236 | * @param param the value |
---|
237 | */ |
---|
238 | public void setDeleteAllFirst(boolean param) { |
---|
239 | deleteAllFirst = param; |
---|
240 | } |
---|
241 | |
---|
242 | /** |
---|
243 | * Get the value of the maxDocsInList parameter<br><br> |
---|
244 | * |
---|
245 | * For a description of the parameter, refer to the general VLO |
---|
246 | * documentation. |
---|
247 | * |
---|
248 | * @return the value |
---|
249 | */ |
---|
250 | public int getMaxDocsInList() { |
---|
251 | return maxDocsInList; |
---|
252 | } |
---|
253 | |
---|
254 | /** |
---|
255 | * Set the value of the maxDocsInList parameter<br><br> |
---|
256 | * |
---|
257 | * For a description of the parameter, refer to the general VLO |
---|
258 | * documentation. |
---|
259 | * |
---|
260 | * @param param the value |
---|
261 | */ |
---|
262 | public void setMaxDocsInList(int param) { |
---|
263 | maxDocsInList = param; |
---|
264 | } |
---|
265 | |
---|
266 | /** |
---|
267 | * Get the value of the minDocsInSolrQueue parameter<br><br> |
---|
268 | * |
---|
269 | * For a description of the parameter, refer to the general VLO |
---|
270 | * documentation. |
---|
271 | * |
---|
272 | * @return the value |
---|
273 | */ |
---|
274 | public int getMinDocsInSolrQueue() { |
---|
275 | return minDocsInSolrQueue; |
---|
276 | } |
---|
277 | |
---|
278 | /** |
---|
279 | * Set the value of the minDocsInSolrQueue parameter<br><br> |
---|
280 | * |
---|
281 | * For a description of the parameter, refer to the general VLO |
---|
282 | * documentation. |
---|
283 | * |
---|
284 | * @param param the value |
---|
285 | */ |
---|
286 | public void setMinDocsInSolrQueue(int param) { |
---|
287 | minDocsInSolrQueue = param; |
---|
288 | } |
---|
289 | |
---|
290 | /** |
---|
291 | * Get the value of the solrTimeOut parameter<br><br> |
---|
292 | * |
---|
293 | * For a description of the parameter, refer to the general VLO |
---|
294 | * documentation. |
---|
295 | * |
---|
296 | * @return the value |
---|
297 | */ |
---|
298 | public int getSolrTimeOut() { |
---|
299 | return solrTimeOut; |
---|
300 | } |
---|
301 | |
---|
302 | /** |
---|
303 | * Set the value of the solrTimeOut parameter<br><br> |
---|
304 | * |
---|
305 | * For a description of the parameter, refer to the general VLO |
---|
306 | * documentation. |
---|
307 | * |
---|
308 | * @param param the value |
---|
309 | */ |
---|
310 | public void setSolrTimeOut(int param) { |
---|
311 | solrTimeOut = param; |
---|
312 | } |
---|
313 | |
---|
314 | /** |
---|
315 | * Get the value of the maxFileSize parameter<br><br> |
---|
316 | * |
---|
317 | * For a description of the parameter, refer to the general VLO |
---|
318 | * documentation. |
---|
319 | * |
---|
320 | * @return the value |
---|
321 | */ |
---|
322 | public int getMaxFileSize() { |
---|
323 | return maxFileSize; |
---|
324 | } |
---|
325 | |
---|
326 | /** |
---|
327 | * Set the value of the maxFileSize parameter<br><br> |
---|
328 | * |
---|
329 | * For a description of the parameter, refer to the general VLO |
---|
330 | * documentation. |
---|
331 | * |
---|
332 | * @param param the value |
---|
333 | */ |
---|
334 | public void setMaxFileSize(int param) { |
---|
335 | maxFileSize = param; |
---|
336 | } |
---|
337 | |
---|
338 | /** |
---|
339 | * Get the value of the maxDaysInSolr parameter<br><br> |
---|
340 | * |
---|
341 | * If the parameter is larger than 0, it denotes the maximal number of days |
---|
342 | * that a document can remain in the database. |
---|
343 | * |
---|
344 | * @return the value |
---|
345 | */ |
---|
346 | public int getMaxDaysInSolr() { |
---|
347 | return maxDaysInSolr; |
---|
348 | } |
---|
349 | |
---|
350 | /** |
---|
351 | * Set the value of the maxDaysInSolr parameter<br><br> |
---|
352 | * |
---|
353 | * If the parameter is larger than 0, it denotes the maximal number of days |
---|
354 | * that a document can remain in the database. |
---|
355 | * |
---|
356 | * @param param the value |
---|
357 | */ |
---|
358 | public void setMaxDaysInSolr(int param) { |
---|
359 | maxDaysInSolr = param; |
---|
360 | } |
---|
361 | |
---|
362 | /** |
---|
363 | * Get the value of the useHandleResolver parameter<br><br> |
---|
364 | * |
---|
365 | * The parameter can be used to reject meta data files that exceed some |
---|
366 | * maximum size. |
---|
367 | * |
---|
368 | * @return the value |
---|
369 | */ |
---|
370 | public boolean getUseHandleResolver() { |
---|
371 | return useHandleResolver; |
---|
372 | } |
---|
373 | |
---|
374 | /** |
---|
375 | * Set the value of the useHandleResolver parameter<br><br> |
---|
376 | * |
---|
377 | * For a description of the parameter, refer to the general VLO |
---|
378 | * documentation. |
---|
379 | * |
---|
380 | * @param param the value |
---|
381 | */ |
---|
382 | public void setUseHandleResolver(boolean param) { |
---|
383 | useHandleResolver = param; |
---|
384 | } |
---|
385 | |
---|
386 | /** |
---|
387 | * Get the list of dataRoots parameters<br><br> |
---|
388 | * |
---|
389 | * For a description of the parameter, refer to the general VLO |
---|
390 | * documentation. |
---|
391 | * |
---|
392 | * @return the value |
---|
393 | */ |
---|
394 | public List<DataRoot> getDataRoots() { |
---|
395 | return dataRoot; |
---|
396 | } |
---|
397 | |
---|
398 | /** |
---|
399 | * Set the value of a list of dataRoots parameters<br><br> |
---|
400 | * |
---|
401 | * For a description of the parameter, refer to the general VLO |
---|
402 | * documentation. |
---|
403 | * |
---|
404 | * @param param the value |
---|
405 | */ |
---|
406 | public void setDataRoots(List<DataRoot> param) { |
---|
407 | dataRoot = param; |
---|
408 | } |
---|
409 | |
---|
410 | /** |
---|
411 | * Get the value of the printMapping parameter<br><br> |
---|
412 | * |
---|
413 | * For a description of the parameter, refer to the general VLO |
---|
414 | * documentation. |
---|
415 | * |
---|
416 | * @return the value |
---|
417 | */ |
---|
418 | public boolean printMapping() { |
---|
419 | return printMapping; |
---|
420 | } |
---|
421 | |
---|
422 | /** |
---|
423 | * Set the value of the printMapping parameter<br><br> |
---|
424 | * |
---|
425 | * For a description of the parameter, refer to the general VLO |
---|
426 | * documentation. |
---|
427 | * |
---|
428 | * @param param the value |
---|
429 | */ |
---|
430 | public void setPrintMapping(boolean param) { |
---|
431 | printMapping = param; |
---|
432 | } |
---|
433 | |
---|
434 | /** |
---|
435 | * Get the value of the VloHomeLink parameter<br><br> |
---|
436 | * |
---|
437 | * For a description of the parameter, refer to the general VLO |
---|
438 | * documentation. |
---|
439 | * |
---|
440 | * @return the value |
---|
441 | */ |
---|
442 | public String getHomeUrl() { |
---|
443 | return homeUrl; |
---|
444 | } |
---|
445 | |
---|
446 | /** |
---|
447 | * Set the value of the VloHomeLink parameter<br><br> |
---|
448 | * |
---|
449 | * For a description of the parameter, refer to the general VLO |
---|
450 | * documentation. |
---|
451 | * |
---|
452 | * @param param the value |
---|
453 | */ |
---|
454 | public void setHomeUrl(String param) { |
---|
455 | homeUrl = param; |
---|
456 | } |
---|
457 | |
---|
458 | /** |
---|
459 | * Get the value of the helpUrl parameter<br><br> |
---|
460 | * |
---|
461 | * For a description of the parameter, refer to the general VLO |
---|
462 | * documentation. |
---|
463 | * |
---|
464 | * @return the value |
---|
465 | */ |
---|
466 | public String getHelpUrl() { |
---|
467 | return helpUrl; |
---|
468 | } |
---|
469 | |
---|
470 | /** |
---|
471 | * Set the value of the helpUrl parameter<br><br> |
---|
472 | * |
---|
473 | * For a description of the parameter, refer to the general VLO |
---|
474 | * documentation. |
---|
475 | * |
---|
476 | * @param param the value |
---|
477 | */ |
---|
478 | public void setHelpUrl(String param) { |
---|
479 | helpUrl = param; |
---|
480 | } |
---|
481 | |
---|
482 | /** |
---|
483 | * Get the value of the SolrUrl parameter<br><br> |
---|
484 | * |
---|
485 | * For a description of the parameter, refer to the general VLO |
---|
486 | * documentation. |
---|
487 | * |
---|
488 | * @return the value |
---|
489 | */ |
---|
490 | public String getSolrUrl() { |
---|
491 | return solrUrl; |
---|
492 | } |
---|
493 | |
---|
494 | /** |
---|
495 | * Set the value of the SolrUrl parameter<br><br> |
---|
496 | * |
---|
497 | * For a description of the parameter, refer to the general VLO |
---|
498 | * documentation. |
---|
499 | * |
---|
500 | * @param param the value |
---|
501 | */ |
---|
502 | public void setSolrUrl(String param) { |
---|
503 | solrUrl = param; |
---|
504 | } |
---|
505 | |
---|
506 | /** |
---|
507 | * Get the value of the facetConceptsFile parameter<br><br> |
---|
508 | * |
---|
509 | * For a description of the parameter, refer to the general VLO |
---|
510 | * documentation. |
---|
511 | * |
---|
512 | * @return the value |
---|
513 | */ |
---|
514 | public String getFacetConceptsFile() { |
---|
515 | return facetConceptsFile; |
---|
516 | } |
---|
517 | |
---|
518 | /** |
---|
519 | * Set the value of the facetConceptsFile parameter<br><br> |
---|
520 | * |
---|
521 | * For a description of the parameter, refer to the general VLO |
---|
522 | * documentation. |
---|
523 | * |
---|
524 | * @param param the value |
---|
525 | */ |
---|
526 | public void setFacetConceptsFile(String param) { |
---|
527 | facetConceptsFile = param; |
---|
528 | } |
---|
529 | |
---|
530 | /** |
---|
531 | * Get the value of the ProfileSchemaUrl by profileId parameter<br><br> |
---|
532 | * |
---|
533 | * For a description of the schema, refer to the general VLO documentation. |
---|
534 | * Note: the profileId needs to be expanded. |
---|
535 | * |
---|
536 | * @return the value |
---|
537 | */ |
---|
538 | public String getComponentRegistryProfileSchema(String id) { |
---|
539 | return profileSchemaUrl.replace("{PROFILE_ID}", id); |
---|
540 | } |
---|
541 | |
---|
542 | /** |
---|
543 | * Set the value of the ProfileSchemaUrl parameter<br><br> |
---|
544 | * |
---|
545 | * For a description of the schema, refer to the general VLO documentation. |
---|
546 | * Note: the profileId needs to be expanded. |
---|
547 | * |
---|
548 | * @param param the value |
---|
549 | */ |
---|
550 | public void setComponentRegistryProfileSchema(String param) { |
---|
551 | profileSchemaUrl = param; |
---|
552 | } |
---|
553 | |
---|
554 | /** |
---|
555 | * Get the value of the ComponentRegisteryRESTURL parameter<br><br> |
---|
556 | * |
---|
557 | * For a description of the parameter, refer to the general VLO |
---|
558 | * documentation. |
---|
559 | * |
---|
560 | * @return the value |
---|
561 | */ |
---|
562 | public String getComponentRegistryRESTURL() { |
---|
563 | return componentRegistryRESTURL; |
---|
564 | } |
---|
565 | |
---|
566 | /** |
---|
567 | * Set the value of the ComponentRegisteryRESTURL parameter<br><br> |
---|
568 | * |
---|
569 | * For a description of the parameter, refer to the general VLO |
---|
570 | * documentation. |
---|
571 | * |
---|
572 | * @param param the value |
---|
573 | */ |
---|
574 | public void setComponentRegistryRESTURL(String param) { |
---|
575 | componentRegistryRESTURL = param; |
---|
576 | } |
---|
577 | |
---|
578 | /** |
---|
579 | * Get the value of the HandleServerUrl parameter<br><br> |
---|
580 | * |
---|
581 | * For a description of the parameter, refer to the general VLO |
---|
582 | * documentation. |
---|
583 | * |
---|
584 | * @return the value |
---|
585 | */ |
---|
586 | public String getHandleServerUrl() { |
---|
587 | return handleServerUrl; |
---|
588 | } |
---|
589 | |
---|
590 | /** |
---|
591 | * Set the value of the HandleServerUrl parameter<br><br> |
---|
592 | * |
---|
593 | * For a description of the parameter, refer to the general VLO |
---|
594 | * documentation. |
---|
595 | * |
---|
596 | * @param param the value |
---|
597 | */ |
---|
598 | public void setHandleServerUrl(String param) { |
---|
599 | handleServerUrl = param; |
---|
600 | } |
---|
601 | |
---|
602 | /** |
---|
603 | * Get the value of the languageLinkPrefix parameter<br><br> |
---|
604 | * |
---|
605 | * For a description of the parameter, refer to the general VLO |
---|
606 | * documentation. |
---|
607 | * |
---|
608 | * @return the value |
---|
609 | * @see #LANGUAGE_LINK_TEMPLATE_LANGUAGE_CODE_PLACEHOLDER |
---|
610 | */ |
---|
611 | public String getLanguageLinkTemplate() { |
---|
612 | return languageLinkTemplate; |
---|
613 | } |
---|
614 | |
---|
615 | /** |
---|
616 | * Set the value of the languageLinkPrefix parameter<br><br> |
---|
617 | * |
---|
618 | * For a description of the parameter, refer to the general VLO |
---|
619 | * documentation. |
---|
620 | * |
---|
621 | * @param param the value |
---|
622 | * @see #LANGUAGE_LINK_TEMPLATE_LANGUAGE_CODE_PLACEHOLDER |
---|
623 | */ |
---|
624 | public void setLanguageLinkTemplate(String param) { |
---|
625 | languageLinkTemplate = param; |
---|
626 | } |
---|
627 | |
---|
628 | /** |
---|
629 | * Get the value of the feedbackFromUrl parameter<br><br> |
---|
630 | * |
---|
631 | * For a description of the parameter, refer to the general VLO |
---|
632 | * documentation. |
---|
633 | * |
---|
634 | * @return the value |
---|
635 | */ |
---|
636 | public String getFeedbackFromUrl() { |
---|
637 | return feedbackFromUrl; |
---|
638 | } |
---|
639 | |
---|
640 | /** |
---|
641 | * Set the value of the feedbackFromUrl parameter<br><br> |
---|
642 | * |
---|
643 | * For a description of the parameter, refer to the general VLO |
---|
644 | * documentation. |
---|
645 | * |
---|
646 | * @param param the value |
---|
647 | */ |
---|
648 | public void setFeedbackFromUrl(String param) { |
---|
649 | feedbackFromUrl = param; |
---|
650 | } |
---|
651 | |
---|
652 | /** |
---|
653 | * Get the value of the FederatedContentSearchUrl parameter<br><br> |
---|
654 | * |
---|
655 | * For a description of the parameter, refer to the general VLO |
---|
656 | * documentation. |
---|
657 | * |
---|
658 | * @return the value |
---|
659 | */ |
---|
660 | @XmlElement(name = "FederatedContentSearchUrl") |
---|
661 | public String getFederatedContentSearchUrl() { |
---|
662 | return federatedContentSearchUrl; |
---|
663 | } |
---|
664 | |
---|
665 | /** |
---|
666 | * Set the value of the FederatedContentSearchUrl parameter<br><br> |
---|
667 | * |
---|
668 | * For a description of the parameter, refer to the general VLO |
---|
669 | * documentation. |
---|
670 | * |
---|
671 | * @param param the value |
---|
672 | */ |
---|
673 | public void setFederatedContentSearchUrl(String param) { |
---|
674 | federatedContentSearchUrl = param; |
---|
675 | } |
---|
676 | |
---|
677 | /** |
---|
678 | * Get the value of the NationalProjectMapping parameter<br><br> |
---|
679 | * |
---|
680 | * For a description of the parameter, refer to the general VLO |
---|
681 | * documentation. |
---|
682 | * |
---|
683 | * @return the value |
---|
684 | */ |
---|
685 | public String getNationalProjectMapping() { |
---|
686 | return nationalProjectMapping; |
---|
687 | } |
---|
688 | |
---|
689 | /** |
---|
690 | * Set the value of the NationalProjectMapping parameter<br><br> |
---|
691 | * |
---|
692 | * For a description of the parameter, refer to the general VLO |
---|
693 | * documentation. |
---|
694 | * |
---|
695 | * @param nationalProjectMapping the value |
---|
696 | */ |
---|
697 | public void setNationalProjectMapping(String param) { |
---|
698 | nationalProjectMapping = param; |
---|
699 | } |
---|
700 | |
---|
701 | /** |
---|
702 | * Get the value of the FacetFields parameter<br><br> |
---|
703 | * |
---|
704 | * For a description of the parameter, refer to the general VLO |
---|
705 | * documentation. |
---|
706 | * |
---|
707 | * @return the value |
---|
708 | */ |
---|
709 | public List<String> getFacetFields() { |
---|
710 | return facetField; |
---|
711 | } |
---|
712 | |
---|
713 | public List<String> getSimpleSearchFacetFields() { |
---|
714 | return simpleSearchFacetField; |
---|
715 | } |
---|
716 | |
---|
717 | public void setSimpleSearchFacetFields(List<String> simpleSearchFacetField) { |
---|
718 | this.simpleSearchFacetField = simpleSearchFacetField; |
---|
719 | } |
---|
720 | |
---|
721 | /** |
---|
722 | * |
---|
723 | * @return all facet fields, including collection facet (arbitrary order |
---|
724 | * unspecified) |
---|
725 | * @see #getFacetFields() |
---|
726 | * @see #getCollectionFacet() |
---|
727 | */ |
---|
728 | public List<String> getAllFacetFields() { |
---|
729 | final ArrayList<String> allFacets = new ArrayList<String>(facetField); |
---|
730 | final String collection = getCollectionFacet(); |
---|
731 | if (collection != null) { |
---|
732 | allFacets.add(collection); |
---|
733 | } |
---|
734 | return allFacets; |
---|
735 | } |
---|
736 | |
---|
737 | /** |
---|
738 | * Set the value of the FacetFields parameter<br><br> |
---|
739 | * |
---|
740 | * For a description of the parameter, refer to the general VLO |
---|
741 | * documentation. |
---|
742 | * |
---|
743 | * @param param the value, a list of facet fields |
---|
744 | */ |
---|
745 | public void setFacetFields(List<String> param) { |
---|
746 | facetField = param; |
---|
747 | } |
---|
748 | |
---|
749 | public Collection<String> getSearchResultFields() { |
---|
750 | return searchResultField; |
---|
751 | } |
---|
752 | |
---|
753 | public void setSearchResultFields(Set<String> searchResultField) { |
---|
754 | this.searchResultField = searchResultField; |
---|
755 | } |
---|
756 | |
---|
757 | /** |
---|
758 | * |
---|
759 | * @return the name of the facet that represents the collection a resource |
---|
760 | * belongs to |
---|
761 | */ |
---|
762 | public String getCollectionFacet() { |
---|
763 | return collectionFacet; |
---|
764 | } |
---|
765 | |
---|
766 | /** |
---|
767 | * |
---|
768 | * @param collectionFacet the name of the facet that represents the |
---|
769 | * collection a resource belongs to |
---|
770 | */ |
---|
771 | public void setCollectionFacet(String collectionFacet) { |
---|
772 | this.collectionFacet = collectionFacet; |
---|
773 | } |
---|
774 | |
---|
775 | public Set<String> getIgnoredFields() { |
---|
776 | return ignoredField; |
---|
777 | } |
---|
778 | |
---|
779 | public void setIgnoredFields(Set<String> ignoredFields) { |
---|
780 | this.ignoredField = ignoredFields; |
---|
781 | } |
---|
782 | |
---|
783 | public Set<String> getTechnicalFields() { |
---|
784 | return technicalField; |
---|
785 | } |
---|
786 | |
---|
787 | public void setTechnicalFields(Set<String> technicalFields) { |
---|
788 | this.technicalField = technicalFields; |
---|
789 | } |
---|
790 | |
---|
791 | /** |
---|
792 | * Get the value of the languageFields parameter<br><br> |
---|
793 | * |
---|
794 | * For a description of the parameter, refer to the general VLO |
---|
795 | * documentation. |
---|
796 | * |
---|
797 | * @return the value |
---|
798 | */ |
---|
799 | public String[] getLanguageFilters() { |
---|
800 | return languageFilters; |
---|
801 | } |
---|
802 | |
---|
803 | /** |
---|
804 | * Set the value of the languageFilters parameter<br><br> |
---|
805 | * |
---|
806 | * For a description of the parameter, refer to the general VLO |
---|
807 | * documentation. |
---|
808 | * |
---|
809 | * @param param the value, a list of language filters |
---|
810 | */ |
---|
811 | public void setLanguageFilters(String[] param) { |
---|
812 | languageFilters = param; |
---|
813 | } |
---|
814 | |
---|
815 | /** |
---|
816 | * Get the value of the getFacetOverviewLength parameter<br><br> |
---|
817 | * |
---|
818 | * For a description of the parameter, refer to the general VLO |
---|
819 | * documentation. |
---|
820 | * |
---|
821 | * @return the value |
---|
822 | */ |
---|
823 | public int getFacetOverviewLength() { |
---|
824 | return facetOverviewLength; |
---|
825 | } |
---|
826 | |
---|
827 | /** |
---|
828 | * Set the value of the setFacetOverviewLength parameter<br><br> |
---|
829 | * |
---|
830 | * For a description of the parameter, refer to the general VLO |
---|
831 | * documentation. |
---|
832 | * |
---|
833 | * @param param the value |
---|
834 | */ |
---|
835 | public void setFacetOverviewLength(Integer param) { |
---|
836 | facetOverviewLength = param; |
---|
837 | } |
---|
838 | |
---|
839 | /** |
---|
840 | * Get the value of the CountryComponentUrl parameter<br><br> |
---|
841 | * |
---|
842 | * For a description of the parameter, refer to the general VLO |
---|
843 | * documentation. |
---|
844 | * |
---|
845 | * @return the value |
---|
846 | */ |
---|
847 | public String getCountryComponentUrl() { |
---|
848 | return countryComponentUrl; |
---|
849 | } |
---|
850 | |
---|
851 | /** |
---|
852 | * Set the value of the CountryComponentUrl parameter<br><br> |
---|
853 | * |
---|
854 | * For a description of the parameter, refer to the general VLO |
---|
855 | * documentation. |
---|
856 | * |
---|
857 | * @param param the value |
---|
858 | */ |
---|
859 | public void setCountryComponentUrl(String param) { |
---|
860 | countryComponentUrl = param; |
---|
861 | } |
---|
862 | |
---|
863 | /** |
---|
864 | * Get the value of the Language2LetterCodeComponentUrl parameter<br><br> |
---|
865 | * |
---|
866 | * For a description of the parameter, refer to the general VLO |
---|
867 | * documentation. |
---|
868 | * |
---|
869 | * @return the value |
---|
870 | */ |
---|
871 | public String getLanguage2LetterCodeComponentUrl() { |
---|
872 | return language2LetterCodeComponentUrl; |
---|
873 | } |
---|
874 | |
---|
875 | /** |
---|
876 | * Set the value of the Language2LetterCodeComponentUrl parameter<br><br> |
---|
877 | * |
---|
878 | * For a description of the parameter, refer to the general VLO |
---|
879 | * documentation. |
---|
880 | * |
---|
881 | * @param param the value |
---|
882 | */ |
---|
883 | public void setLanguage2LetterCodeComponentUrl(String param) { |
---|
884 | language2LetterCodeComponentUrl = param; |
---|
885 | } |
---|
886 | |
---|
887 | /** |
---|
888 | * Get the value of the Language3LetterCodeComponentUrl parameter<br><br> |
---|
889 | * |
---|
890 | * For a description of the parameter, refer to the general VLO |
---|
891 | * documentation. |
---|
892 | * |
---|
893 | * @return the value |
---|
894 | */ |
---|
895 | public String getLanguage3LetterCodeComponentUrl() { |
---|
896 | return language3LetterCodeComponentUrl; |
---|
897 | } |
---|
898 | |
---|
899 | /** |
---|
900 | * Set the value of the Language3LetterCodeComponentUrl parameter<br><br> |
---|
901 | * |
---|
902 | * For a description of the parameter, refer to the general VLO |
---|
903 | * documentation. |
---|
904 | * |
---|
905 | * @param param the value |
---|
906 | */ |
---|
907 | public void setLanguage3LetterCodeComponentUrl(String param) { |
---|
908 | language3LetterCodeComponentUrl = param; |
---|
909 | } |
---|
910 | |
---|
911 | /** |
---|
912 | * Get the value of the SilToISO639CodesUrl parameter<br><br> |
---|
913 | * |
---|
914 | * For a description of the parameter, refer to the general VLO |
---|
915 | * documentation. |
---|
916 | * |
---|
917 | * @return the value |
---|
918 | */ |
---|
919 | public String getSilToISO639CodesUrl() { |
---|
920 | return silToISO639CodesUrl; |
---|
921 | } |
---|
922 | |
---|
923 | /** |
---|
924 | * Set the value of the SilToISO639CodesUrl parameter<br><br> |
---|
925 | * |
---|
926 | * For a description of the parameter, refer to the general VLO |
---|
927 | * documentation. |
---|
928 | * |
---|
929 | * @param param the value |
---|
930 | */ |
---|
931 | public void setSilToISO639CodesUrl(String param) { |
---|
932 | silToISO639CodesUrl = param; |
---|
933 | } |
---|
934 | |
---|
935 | /** |
---|
936 | * Get the value of the reverseProxyPath parameter<br><br> |
---|
937 | * |
---|
938 | * For a description of the parameter, refer to the general VLO |
---|
939 | * documentation. |
---|
940 | * |
---|
941 | * @return the value |
---|
942 | */ |
---|
943 | public String getReverseProxyPrefix() { |
---|
944 | return reverseProxyPrefix; |
---|
945 | } |
---|
946 | |
---|
947 | /** |
---|
948 | * Set the value of the reverseProxyPrefix parameter<br><br> |
---|
949 | * |
---|
950 | * For a description of the parameter, refer to the general VLO |
---|
951 | * documentation. |
---|
952 | * |
---|
953 | * @param param the value |
---|
954 | */ |
---|
955 | public void setReverseProxyPrefix(String param) { |
---|
956 | reverseProxyPrefix = param; |
---|
957 | } |
---|
958 | |
---|
959 | /** |
---|
960 | * Get the value of the organisationNamesUrl parameter<br><br> |
---|
961 | * |
---|
962 | * For a description of the parameter, refer to the general VLO |
---|
963 | * documentation. |
---|
964 | * |
---|
965 | * @return the value |
---|
966 | */ |
---|
967 | public String getOrganisationNamesUrl() { |
---|
968 | return organisationNamesUrl; |
---|
969 | } |
---|
970 | |
---|
971 | /** |
---|
972 | * Set the value of the organisationNamesUrl parameter<br><br> |
---|
973 | * |
---|
974 | * For a description of the parameter, refer to the general VLO |
---|
975 | * documentation. |
---|
976 | * |
---|
977 | * @param param the value |
---|
978 | */ |
---|
979 | public void setOrganisationNamesUrl(String param) { |
---|
980 | organisationNamesUrl = param; |
---|
981 | } |
---|
982 | |
---|
983 | /** |
---|
984 | * Get the value of the languageNameVariantsUrl parameter<br><br> |
---|
985 | * |
---|
986 | * For a description of the parameter, refer to the general VLO |
---|
987 | * documentation. |
---|
988 | * |
---|
989 | * @return the value |
---|
990 | */ |
---|
991 | public String getLanguageNameVariantsUrl() { |
---|
992 | return languageNameVariantsUrl; |
---|
993 | } |
---|
994 | |
---|
995 | /** |
---|
996 | * Set the value of the languageNameVariantsUrl parameter<br><br> |
---|
997 | * |
---|
998 | * For a description of the parameter, refer to the general VLO |
---|
999 | * documentation. |
---|
1000 | * |
---|
1001 | * @param param the value |
---|
1002 | */ |
---|
1003 | public void setLanguageNameVariantsUrl(String param) { |
---|
1004 | languageNameVariantsUrl = param; |
---|
1005 | } |
---|
1006 | |
---|
1007 | /** |
---|
1008 | * Get the value of the licenseAvailabilityMapUrl parameter<br><br> |
---|
1009 | * |
---|
1010 | * For a description of the parameter, refer to the general VLO |
---|
1011 | * documentation. |
---|
1012 | * |
---|
1013 | * @return the value |
---|
1014 | */ |
---|
1015 | public String getLicenseAvailabilityMapUrl() { |
---|
1016 | return licenseAvailabilityMapUrl; |
---|
1017 | } |
---|
1018 | |
---|
1019 | /** |
---|
1020 | * Set the value of the licenseAvailabilityMapUrl parameter<br><br> |
---|
1021 | * |
---|
1022 | * For a description of the parameter, refer to the general VLO |
---|
1023 | * documentation. |
---|
1024 | * |
---|
1025 | * @param param the value |
---|
1026 | */ |
---|
1027 | public void setLicenseAvailabilityMapUrl(String param) { |
---|
1028 | licenseAvailabilityMapUrl = param; |
---|
1029 | } |
---|
1030 | |
---|
1031 | public String getResourceClassMapUrl() { |
---|
1032 | return resourceClassMapUrl; |
---|
1033 | } |
---|
1034 | |
---|
1035 | public void setResourceClassMapUrl(String resourceClassMapUrl) { |
---|
1036 | this.resourceClassMapUrl = resourceClassMapUrl; |
---|
1037 | } |
---|
1038 | |
---|
1039 | /** |
---|
1040 | * Get the value of the cqlEndpointFilter parameter<br><br> |
---|
1041 | * |
---|
1042 | * For a description of the parameter, refer to the general VLO |
---|
1043 | * documentation. |
---|
1044 | * |
---|
1045 | * @return the value |
---|
1046 | */ |
---|
1047 | public String getCqlEndpointFilter() { |
---|
1048 | return cqlEndpointFilter; |
---|
1049 | } |
---|
1050 | |
---|
1051 | /** |
---|
1052 | * Set the value of the cqlEndpointFilter parameter<br><br> |
---|
1053 | * |
---|
1054 | * For a description of the parameter, refer to the general VLO |
---|
1055 | * documentation. |
---|
1056 | * |
---|
1057 | * @param param the value |
---|
1058 | */ |
---|
1059 | public void setCqlEndpointFilter(String param) { |
---|
1060 | cqlEndpointFilter = param; |
---|
1061 | } |
---|
1062 | |
---|
1063 | /** |
---|
1064 | * Get the value of the cqlEndpointAlternative parameter<br><br> |
---|
1065 | * |
---|
1066 | * For a description of the parameter, refer to the general VLO |
---|
1067 | * documentation. |
---|
1068 | * |
---|
1069 | * @return the value |
---|
1070 | */ |
---|
1071 | public String getCqlEndpointAlternative() { |
---|
1072 | return cqlEndpointAlternative; |
---|
1073 | } |
---|
1074 | |
---|
1075 | /** |
---|
1076 | * Set the value of the cqlEndpointAlternative parameter<br><br> |
---|
1077 | * |
---|
1078 | * For a description of the parameter, refer to the general VLO |
---|
1079 | * documentation. |
---|
1080 | * |
---|
1081 | * @param param the value |
---|
1082 | */ |
---|
1083 | public void setCqlEndpointAlternative(String param) { |
---|
1084 | cqlEndpointAlternative = param; |
---|
1085 | } |
---|
1086 | |
---|
1087 | /** |
---|
1088 | * Sets the originating file for the current configuration |
---|
1089 | * |
---|
1090 | * @param configFile the file this config was read from |
---|
1091 | */ |
---|
1092 | public void setConfigLocation(URI configFile) { |
---|
1093 | this.configLocation = configFile; |
---|
1094 | } |
---|
1095 | |
---|
1096 | /** |
---|
1097 | * |
---|
1098 | * @return the file this config was read from. may be null! |
---|
1099 | */ |
---|
1100 | public URI getConfigLocation() { |
---|
1101 | return configLocation; |
---|
1102 | } |
---|
1103 | |
---|
1104 | public void setShowResultScores(boolean showResultScores) { |
---|
1105 | this.showResultScores = showResultScores; |
---|
1106 | } |
---|
1107 | |
---|
1108 | public boolean isShowResultScores() { |
---|
1109 | return showResultScores; |
---|
1110 | } |
---|
1111 | |
---|
1112 | /** |
---|
1113 | * Get the value of processHierarchies |
---|
1114 | * |
---|
1115 | * @return the value of processHierarchies |
---|
1116 | */ |
---|
1117 | public boolean isProcessHierarchies() { |
---|
1118 | return processHierarchies; |
---|
1119 | } |
---|
1120 | |
---|
1121 | /** |
---|
1122 | * Set the value of processHierarchies |
---|
1123 | * |
---|
1124 | * @param processHierarchies new value of processHierarchies |
---|
1125 | */ |
---|
1126 | public void setProcessHierarchies(boolean processHierarchies) { |
---|
1127 | this.processHierarchies = processHierarchies; |
---|
1128 | } |
---|
1129 | } |
---|