Project

General

Profile

Download (8.76 KB) Statistics
| Branch: | Tag: | Revision:
1
/**
2
* Copyright (C) 2007 EDIT
3
* European Distributed Institute of Taxonomy
4
* http://www.e-taxonomy.eu
5
*
6
* The contents of this file are subject to the Mozilla Public License Version 1.1
7
* See LICENSE.TXT at the top of this package for the full license terms.
8
*/
9

    
10
package eu.etaxonomy.cdm.io.dwca.out;
11

    
12
import java.io.File;
13
import java.util.ArrayList;
14
import java.util.List;
15
import java.util.UUID;
16

    
17
import org.apache.log4j.Logger;
18

    
19
import eu.etaxonomy.cdm.database.ICdmDataSource;
20
import eu.etaxonomy.cdm.io.common.ExportResultType;
21
import eu.etaxonomy.cdm.io.common.XmlExportConfiguratorBase;
22

    
23

    
24
/**
25
 * @author a.mueller
26
 * @since 18.04.2011
27
 */
28
public class DwcaTaxExportConfigurator extends XmlExportConfiguratorBase<DwcaTaxExportState> {
29

    
30
    private static final long serialVersionUID = -464609596078614735L;
31

    
32
    @SuppressWarnings("unused")
33
	private static final Logger logger = Logger.getLogger(DwcaTaxExportConfigurator.class);
34

    
35
	private String encoding = "UTF-8";
36
	private String linesTerminatedBy = "\r\n";
37
	private String fieldsEnclosedBy = "\"";
38
	private boolean hasHeaderLines = true;
39
	private String fieldsTerminatedBy=",";
40

    
41

    
42
	private boolean doTaxa = true;
43
	private boolean doResourceRelation = true;
44
	private boolean doTypesAndSpecimen = true;
45
	private boolean doVernacularNames = true;
46
	private boolean doReferences = true;
47
	private boolean doDescriptions = true;
48
	private boolean doDistributions = true;
49
	private boolean doImages = true;
50
	private boolean doMetaData = true;
51
	private boolean doEml = true;
52

    
53
	private boolean doSynonyms = true;
54
	private boolean doMisappliedNames = true;
55

    
56
	private boolean isUseIdWherePossible = false;
57

    
58
	private boolean includeBasionymsInResourceRelations;
59
	private boolean includeMisappliedNamesInResourceRelations;
60

    
61
	private String defaultBibliographicCitation = null;
62

    
63
	private DwcaEmlRecord emlRecord;
64

    
65
	private List<UUID> featureExclusions = new ArrayList<>();
66

    
67

    
68

    
69
	private String defaultTaxonSource;
70

    
71
	private boolean withHigherClassification = false;
72

    
73
	private String setSeparator = ";";
74

    
75
	//TODO
76
	private static DwcaTaxExportTransformer defaultTransformer = null;
77

    
78

    
79
	public static DwcaTaxExportConfigurator NewInstance(ICdmDataSource source, File destinationFolder, DwcaEmlRecord emlRecord) {
80
		return new DwcaTaxExportConfigurator(source, destinationFolder, emlRecord);
81
	}
82

    
83

    
84
	@Override
85
	@SuppressWarnings("unchecked")
86
	protected void makeIoClassList() {
87
		ioClassList = new Class[] {
88
				DwcaTaxExport.class
89
				,DwcaMetaDataExport.class
90
				,DwcaEmlExport.class
91
				,DwcaResultWriter.class
92
		};
93
	}
94

    
95

    
96
	/**
97
	 * @param url
98
	 * @param destination
99
	 */
100
	private DwcaTaxExportConfigurator(ICdmDataSource source, File destination, DwcaEmlRecord emlRecord) {
101
	    super(destination, source, defaultTransformer);
102
		this.resultType = ExportResultType.MAP_BYTE_ARRAY;
103
	    this.emlRecord = emlRecord;
104
	    this.setDestination(destination);
105
	    this.setSource(source);
106
	}
107

    
108
	@Override
109
	public File getDestination() {
110
		return super.getDestination();
111
	}
112

    
113
	@Override
114
	public void setDestination(File fileName) {
115
		super.setDestination(fileName);
116
	}
117

    
118
	@Override
119
	public String getDestinationNameString() {
120
		if (this.getDestination() == null) {
121
			return null;
122
		} else {
123
			return this.getDestination().toString();
124
		}
125
	}
126

    
127
	@Override
128
    public DwcaTaxExportState getNewState() {
129
		return new DwcaTaxExportState(this);
130
	}
131

    
132
	public boolean isDoTaxa() {
133
		return doTaxa;
134
	}
135
	public void setDoTaxa(boolean doTaxa) {
136
		this.doTaxa = doTaxa;
137
	}
138

    
139
	public boolean isDoResourceRelation() {
140
		return doResourceRelation;
141
	}
142
	public void setDoResourceRelations(boolean doResourceRelation) {
143
		this.doResourceRelation = doResourceRelation;
144
	}
145

    
146
	public boolean isDoTypesAndSpecimen() {
147
		return doTypesAndSpecimen;
148
	}
149
	public void setDoTypesAndSpecimen(boolean doTypesAndSpecimen) {
150
		this.doTypesAndSpecimen = doTypesAndSpecimen;
151
	}
152

    
153
	public boolean isDoVernacularNames() {
154
		return doVernacularNames;
155
	}
156
	public void setDoVernacularNames(boolean doVernacularNames) {
157
		this.doVernacularNames = doVernacularNames;
158
	}
159

    
160
	public boolean isDoReferences() {
161
		return doReferences;
162
	}
163
	public void setDoReferences(boolean doReferences) {
164
		this.doReferences = doReferences;
165
	}
166

    
167
	public boolean isDoDescriptions() {
168
		return doDescriptions;
169
	}
170
	public void setDoDescriptions(boolean doDescriptions) {
171
		this.doDescriptions = doDescriptions;
172
	}
173

    
174
	public boolean isDoDistributions() {
175
		return doDistributions;
176
	}
177
	public void setDoDistributions(boolean doDistributions) {
178
		this.doDistributions = doDistributions;
179
	}
180

    
181
	public boolean isDoImages() {
182
		return doImages;
183
	}
184
	public void setDoImages(boolean doImages) {
185
		this.doImages = doImages;
186
	}
187

    
188
	public void setFeatureExclusions(List<UUID> featureExclusions) {
189
		this.featureExclusions = featureExclusions;
190
	}
191
	public List<UUID> getFeatureExclusions() {
192
		return featureExclusions;
193
	}
194

    
195
	public String getEncoding() {
196
		return encoding;
197
	}
198
	public void setEncoding(String encoding) {
199
		this.encoding = encoding;
200
	}
201

    
202
	public String getLinesTerminatedBy() {
203
		return linesTerminatedBy;
204
	}
205
	public void setLinesTerminatedBy(String linesTerminatedBy) {
206
		this.linesTerminatedBy = linesTerminatedBy;
207
	}
208

    
209
	public String getFieldsEnclosedBy() {
210
		return fieldsEnclosedBy;
211
	}
212
	public void setFieldsEnclosedBy(String fieldsEnclosedBy) {
213
		this.fieldsEnclosedBy = fieldsEnclosedBy;
214
	}
215

    
216
	/**
217
	 * Equals darwin core archive ignoreHeaderLines attribute.
218
	 * <code>true</code> by default.
219
	 * @return
220
	 */
221
	public boolean isHasHeaderLines() {
222
		return hasHeaderLines;
223
	}
224
	public void setHasHeaderLines(boolean hasHeaderLines) {
225
		this.hasHeaderLines = hasHeaderLines;
226
	}
227

    
228
	public boolean isIncludeBasionymsInResourceRelations() {
229
		return includeBasionymsInResourceRelations;
230
	}
231
	public void setIncludeBasionymsInResourceRelations(boolean includeBasionymsInResourceRelations) {
232
		this.includeBasionymsInResourceRelations = includeBasionymsInResourceRelations;
233
	}
234

    
235
	public boolean isIncludeMisappliedNamesInResourceRelations() {
236
		return includeMisappliedNamesInResourceRelations;
237
	}
238
	public void setIncludeMisappliedNamesInResourceRelations(boolean includeMisappliedNamesInResourceRelations) {
239
		this.includeMisappliedNamesInResourceRelations = includeMisappliedNamesInResourceRelations;
240
	}
241

    
242
	public void setDoMetaData(boolean doMetaData) {
243
		this.doMetaData = doMetaData;
244
	}
245
	public boolean isDoMetaData() {
246
		return doMetaData;
247
	}
248

    
249
	public boolean isUseIdWherePossible() {
250
		return this.isUseIdWherePossible;
251
	}
252
	public void setUseIdWherePossible(boolean isUseIdWherePossible) {
253
		this.isUseIdWherePossible = isUseIdWherePossible;
254
	}
255

    
256
	public void setEmlRecord(DwcaEmlRecord emlRecord) {
257
		this.emlRecord = emlRecord;
258
	}
259
	public DwcaEmlRecord getEmlRecord() {
260
		return emlRecord;
261
	}
262

    
263
	public void setDoEml(boolean doEml) {
264
		this.doEml = doEml;
265
	}
266
	public boolean isDoEml() {
267
		return doEml;
268
	}
269

    
270

    
271
	public void setDefaultBibliographicCitation(String defaultBibliographicCitation) {
272
		this.defaultBibliographicCitation = defaultBibliographicCitation;
273
	}
274
	public String getDefaultBibliographicCitation() {
275
		return defaultBibliographicCitation;
276
	}
277

    
278

    
279
	/**
280
	 * The default value for the taxon.source column. This may be a column linking to a url that provides
281
	 * data about the given taxon. The id is replaced by a placeholder,
282
	 * e.g. http://wp6-cichorieae.e-taxonomy.eu/portal/?q=cdm_dataportal/taxon/{id}.
283
	 * NOTE: This may be replaced in future versions by concrete CDM server implementations.
284
	 *
285
	 * @return the taxonSourceDefault
286
	 */
287
	public String getDefaultTaxonSource() {
288
		return defaultTaxonSource;
289
	}
290
	public void setDefaultTaxonSource(String taxonSourceDefault) {
291
		this.defaultTaxonSource = taxonSourceDefault;
292
	}
293

    
294

    
295
	public boolean isWithHigherClassification() {
296
		return withHigherClassification;
297
	}
298
	public void setWithHigherClassification(boolean withHigherClassification) {
299
		this.withHigherClassification = withHigherClassification;
300
	}
301

    
302
	public String getSetSeparator() {
303
		return setSeparator;
304
	}
305
	public void setSetSeparator(String setSeparator) {
306
		this.setSeparator = setSeparator;
307
	}
308

    
309
	public void setFieldsTerminatedBy(String fieldsTerminatedBy) {
310
		this.fieldsTerminatedBy = fieldsTerminatedBy;
311
	}
312
	public String getFieldsTerminatedBy() {
313
		return fieldsTerminatedBy;
314
	}
315

    
316

    
317
    public boolean isDoSynonyms() {
318
        return doSynonyms;
319
    }
320
    public void setDoSynonyms(boolean doSynonyms) {
321
        this.doSynonyms = doSynonyms;
322
    }
323

    
324
    public boolean isDoMisappliedNames() {
325
        return doMisappliedNames;
326
    }
327
    public void setDoMisappliedNames(boolean doMisappliedNames) {
328
        this.doMisappliedNames = doMisappliedNames;
329
    }
330

    
331
}
(22-22/33)