Project

General

Profile

1
package eu.dnetlib.enabling.datasources;
2

    
3
import java.io.IOException;
4
import java.sql.Array;
5
import java.sql.Date;
6
import java.sql.SQLException;
7
import java.util.Arrays;
8
import java.util.HashMap;
9
import java.util.List;
10
import java.util.Map;
11
import java.util.stream.Collectors;
12

    
13
import org.apache.commons.lang.StringUtils;
14
import org.apache.commons.logging.Log;
15
import org.apache.commons.logging.LogFactory;
16
import org.dom4j.Document;
17
import org.dom4j.DocumentException;
18
import org.dom4j.Element;
19
import org.dom4j.io.SAXReader;
20
import org.springframework.core.io.ClassPathResource;
21
import org.springframework.core.io.Resource;
22

    
23
import eu.dnetlib.enabling.datasources.common.Api;
24
import eu.dnetlib.enabling.datasources.common.ApiParam;
25
import eu.dnetlib.enabling.datasources.common.ApiParamImpl;
26
import eu.dnetlib.enabling.datasources.common.Datasource;
27
import eu.dnetlib.enabling.datasources.common.Identity;
28
import eu.dnetlib.enabling.datasources.common.Organization;
29
import eu.dnetlib.enabling.datasources.common.SearchApisEntry;
30
import eu.dnetlib.enabling.datasources.common.SimpleDatasource;
31
import eu.dnetlib.miscutils.datetime.DateUtils;
32

    
33
public class DatasourceFunctions {
34

    
35
	private static final Log log = LogFactory.getLog(DatasourceFunctions.class);
36

    
37
	private static final Resource baseDsProfile = new ClassPathResource("/eu/dnetlib/enabling/datasources/templates/datasource_base.xml");
38

    
39
	public static SimpleDatasource mapToSimpleDs(final Map<String, Object> map) {
40
		final SimpleDatasource ds = new SimpleDatasource();
41
		ds.setId(castObject(map.get("id"), String.class));
42
		ds.setName(castObject(map.get("name"), String.class));
43
		ds.setOrigId(castObject(map.get("id"), String.class));
44
		ds.setTypology(castObject(map.get("typology"), String.class));
45
		ds.setValid(true);
46
		try {
47
			ds.setApis(Arrays.stream((Object[]) castObject(map.get("apis"), Array.class).getArray())
48
					.map(Object::toString)
49
					.collect(Collectors.toSet()));
50
		} catch (final SQLException e) {
51
			log.error("Error parsing array (apis)", e);
52
			throw new RuntimeException("Error parsing array (apis)", e);
53
		}
54

    
55
		return ds;
56
	}
57

    
58
	public static Datasource<Organization<?>, Identity> mapToDatasource(final Map<String, Object> map) {
59
		final Datasource<Organization<?>, Identity> ds = new Datasource<>();
60
		ds.setId(castObject(map.get("id"), String.class));
61
		ds.setOfficialname(castObject(map.get("officialname"), String.class));
62
		ds.setEnglishname(castObject(map.get("englishname"), String.class));
63
		ds.setWebsiteurl(castObject(map.get("websiteurl"), String.class));
64
		ds.setLogourl(castObject(map.get("logourl"), String.class));
65
		ds.setContactemail(castObject(map.get("contactemail"), String.class));
66
		ds.setLatitude(castObject(map.get("latitude"), Double.class));
67
		ds.setLongitude(castObject(map.get("longitude"), Double.class));
68
		ds.setTimezone(castObject(map.get("timezone"), String.class));
69
		ds.setNamespaceprefix(castObject(map.get("namespaceprefix"), String.class));
70
		ds.setLanguages(castObject(map.get("languages"), String.class));
71
		ds.setOd_contenttypes(castObject(map.get("od_contenttypes"), String.class));
72
		ds.setCollectedfrom(castObject(map.get("collectedfrom"), String.class));
73
		ds.setDateofvalidation(castObject(map.get("dateofvalidation"), Date.class));
74
		ds.setTypology(castObject(map.get("typology"), String.class));
75
		ds.setProvenanceaction(castObject(map.get("provenanceaction"), String.class));
76
		ds.setDateofcollection(castObject(map.get("dateofcollection"), Date.class));
77
		ds.setPlatform(castObject(map.get("platform"), String.class));
78
		ds.setActivationId(castObject(map.get("activationId"), String.class));
79
		ds.setDescription(castObject(map.get("description"), String.class));
80
		ds.setReleasestartdate(castObject(map.get("releasestartdate"), Date.class));
81
		ds.setReleaseenddate(castObject(map.get("releaseenddate"), Date.class));
82
		ds.setMissionstatementurl(castObject(map.get("missionstatementurl"), String.class));
83
		ds.setDataprovider(castObject(map.get("dataprovider"), Boolean.class));
84
		ds.setServiceprovider(castObject(map.get("serviceprovider"), Boolean.class));
85
		ds.setDatabaseaccesstype(castObject(map.get("databaseaccesstype"), String.class));
86
		ds.setDatauploadtype(castObject(map.get("datauploadtype"), String.class));
87
		ds.setDatabaseaccessrestriction(castObject(map.get("databaseaccessrestriction"), String.class));
88
		ds.setDatauploadrestriction(castObject(map.get("datauploadrestriction"), String.class));
89
		ds.setVersioning(castObject(map.get("versioning"), Boolean.class));
90
		ds.setCitationguidelineurl(castObject(map.get("citationguidelineurl"), String.class));
91
		ds.setQualitymanagementkind(castObject(map.get("qualitymanagementkind"), String.class));
92
		ds.setPidsystems(castObject(map.get("pidsystems"), String.class));
93
		ds.setCertificates(castObject(map.get("certificates"), String.class));
94
		ds.setAggregator(castObject(map.get("aggregator"), String.class));
95
		ds.setIssn(castObject(map.get("issn"), String.class));
96
		ds.setEissn(castObject(map.get("eissn"), String.class));
97
		ds.setLissn(castObject(map.get("lissn"), String.class));
98
		ds.setRegisteredby(castObject(map.get("registeredby"), String.class));
99
		ds.setSubjects(castObject(map.get("subjects"), String.class));
100
		ds.setManaged(castObject(map.get("managed"), Boolean.class));
101
		return ds;
102
	}
103

    
104
	public static Identity mapToDsIdentity(final Map<String, Object> map) {
105
		final Identity id = new Identity();
106
		id.setPid(castObject(map.get("pid"), String.class));
107
		id.setIssuertype(castObject(map.get("issuertype"), String.class));
108
		return id;
109
	}
110

    
111
	public static Organization<Datasource<?, ?>> mapToDsOrganization(final Map<String, Object> map) {
112
		final Organization<Datasource<?, ?>> org = new Organization<>();
113
		org.setId(castObject(map.get("id"), String.class));
114
		org.setLegalshortname(castObject(map.get("legalshortname"), String.class));
115
		org.setLegalname(castObject(map.get("legalname"), String.class));
116
		org.setWebsiteurl(castObject(map.get("websiteurl"), String.class));
117
		org.setLogourl(castObject(map.get("logourl"), String.class));
118
		org.setCountry(castObject(map.get("country"), String.class));
119
		org.setCollectedfrom(castObject(map.get("collectedfrom"), String.class));
120
		org.setDateofcollection(castObject(map.get("dateofcollection"), Date.class));
121
		org.setProvenanceaction(castObject(map.get("provenanceaction"), String.class));
122
		return org;
123
	}
124

    
125
	public static SearchApisEntry mapToSearchApisEntry(final Map<String, Object> map) {
126
		final SearchApisEntry a = new SearchApisEntry();
127
		a.setId(castObject(map.get("id"), String.class));
128
		a.setCompliance(castObject(map.get("compliance"), String.class));
129
		a.setActive(castObject(map.get("active"), Boolean.class));
130
		a.setRepoId(castObject(map.get("dsId"), String.class));
131
		a.setRepoName(castObject(map.get("name"), String.class));
132
		a.setRepoCountry(castObject(map.get("country"), String.class));
133
		a.setRepoPrefix(castObject(map.get("prefix"), String.class));
134
		a.setAggrDate(castObject(map.get("aggrDate"), String.class));
135
		a.setAggrTotal(castObject(map.get("aggrTotal"), Integer.class));
136
		a.setProtocol(castObject(map.get("protocol"), String.class));
137
		a.setAlternativeName(castObject(map.get("alternativeName"), String.class));
138
		a.setRepoOrganization(castObject(map.get("organization"), String.class));
139
		return a;
140
	}
141

    
142
	public static Api<ApiParam> mapToApi(final Map<String, Object> map) {
143
		final Api<ApiParam> a = new Api<>();
144
		a.setId(castObject(map.get("id"), String.class));
145
		a.setProtocol(castObject(map.get("protocol"), String.class));
146
		a.setDatasource(castObject(map.get("datasource"), String.class));
147
		a.setContentdescription(castObject(map.get("contentdescription"), String.class));
148
		a.setActive(castObject(map.get("active"), Boolean.class));
149
		a.setRemovable(castObject(map.get("removable"), Boolean.class));
150
		a.setTypology(castObject(map.get("typology"), String.class));
151
		a.setCompatibility(castObject(map.get("compatibility"), String.class));
152
		a.setCompatibilityOverrided(castObject(map.get("isCompatibilityOverrided"), Boolean.class));
153
		a.setMetadataIdentifierPath(castObject(map.get("metadataIdentifierPath"), String.class));
154
		a.setLastCollectionTotal(castObject(map.get("lastCollectionTotal"), Integer.class));
155
		a.setLastCollectionDate(castObject(map.get("lastCollectionDate"), Date.class));
156
		a.setLastCollectionMdid(castObject(map.get("lastCollectionMdid"), String.class));
157
		a.setLastAggregationTotal(castObject(map.get("lastAggregationTotal"), Integer.class));
158
		a.setLastAggregationDate(castObject(map.get("lastAggregationDate"), Date.class));
159
		a.setLastAggregationMdid(castObject(map.get("lastAggregationMdid"), String.class));
160
		a.setLastDownloadTotal(castObject(map.get("lastDownloadTotal"), Integer.class));
161
		a.setLastDownloadDate(castObject(map.get("lastDownloadDate"), Date.class));
162
		a.setLastDownloadObjid(castObject(map.get("lastDownloadObjid"), String.class));
163
		a.setLastValidationJob(castObject(map.get("lastValidationJob"), String.class));
164
		a.setBaseurl(castObject(map.get("baseUrl"), String.class));
165
		try {
166
			a.setApiParams(Arrays.stream((Object[]) castObject(map.get("params"), Array.class).getArray())
167
					.map(Object::toString)
168
					.map(s -> {
169
						final ApiParam p = new ApiParamImpl();
170
						p.setParam(StringUtils.substringBefore(s, "="));
171
						p.setValue(StringUtils.substringAfter(s, "="));
172
						return p;
173
					})
174
					.collect(Collectors.toSet()));
175
		} catch (final SQLException e) {
176
			log.error("Error parsing array params", e);
177
			throw new RuntimeException("Error parsing array params", e);
178
		}
179

    
180
		return a;
181
	}
182

    
183
	public static String dsToProfile(final Datasource<Organization<?>, Identity> ds, final List<Api<ApiParam>> apis, final String profId)
184
			throws DocumentException, IOException {
185
		final Document doc = new SAXReader().read(baseDsProfile.getInputStream());
186

    
187
		doc.selectSingleNode("//DATASOURCE_TYPE").setText(ds.getPlatform());
188
		doc.selectSingleNode("//DATASOURCE_ORIGINAL_ID").setText(ds.getId());
189
		doc.selectSingleNode("//TYPOLOGY").setText(ds.getTypology());
190
		doc.selectSingleNode("//OFFICIAL_NAME").setText(ds.getOfficialname());
191
		doc.selectSingleNode("//ENGLISH_NAME").setText(ds.getEnglishname());
192
		doc.selectSingleNode("//ICON_URI").setText(ds.getLogourl());
193
		doc.selectSingleNode("//COUNTRY").setText(ds.getOrganizations().stream().map(Organization::getCountry).findFirst().orElse(""));
194
		doc.selectSingleNode("//LONGITUDE").setText("" + ds.getLongitude());
195
		doc.selectSingleNode("//LATITUDE").setText("" + ds.getLatitude());
196
		doc.selectSingleNode("//TIMEZONE").setText("" + ds.getTimezone());
197
		doc.selectSingleNode("//REPOSITORY_WEBPAGE").setText(ds.getWebsiteurl());
198
		doc.selectSingleNode("//REPOSITORY_INSTITUTION").setText(ds.getOrganizations().stream().map(Organization::getLegalname).findFirst().orElse(""));
199
		doc.selectSingleNode("//ADMIN_INFO").setText(ds.getContactemail());
200
		doc.selectSingleNode("//REGISTERED_BY").setText(ds.getRegisteredby());
201
		doc.selectSingleNode("//LAST_UPDATE/@value").setText(DateUtils.now_ISO8601());
202

    
203
		final Element ef = (Element) doc.selectSingleNode("//EXTRA_FIELDS");
204
		addExtraField(ef, "OpenAireDataSourceId", ds.getId());
205
		addExtraField(ef, "NamespacePrefix", ds.getNamespaceprefix());
206
		addExtraField(ef, "VERIFIED", "NO");
207
		addExtraField(ef, "aggregatorName", ds.getAggregator());
208
		addExtraField(ef, "dateOfValidation", ds.getDateofvalidation());
209
		addExtraField(ef, "dateOfCollection", ds.getDateofcollection());
210
		addExtraField(ef, "mergeHomonyms", "NO");
211
		addExtraField(ef, "ACTID", ds.getActivationId());
212

    
213
		if (apis != null) {
214
			final Element ifaces = (Element) doc.selectSingleNode("//INTERFACES");
215
			apis.forEach(api -> addInterface(ifaces, api));
216
		}
217
		return doc.asXML();
218
	}
219

    
220
	private static void addInterface(final Element ifaces, final Api<?> api) {
221
		final Element ifc = ifaces.addElement("INTERFACE");
222
		ifc.addAttribute("id", api.getId());
223
		ifc.addAttribute("label", String.format("%s (%s)", api.getTypology(), api.getCompatibility()));
224
		ifc.addAttribute("typology", api.getTypology());
225
		ifc.addAttribute("active", "" + api.getActive());
226
		ifc.addAttribute("compliance", api.getCompatibility());
227
		ifc.addAttribute("contentDescription", api.getContentdescription());
228
		ifc.addAttribute("removable", "" + api.getRemovable());
229

    
230
		final Element ap = ifc.addElement("ACCESS_PROTOCOL");
231
		api.getApiParams().forEach(p -> ap.addAttribute(p.getParam(), p.getValue()));
232
		ap.setText(api.getProtocol());
233

    
234
		ifc.addElement("BASE_URL").setText(api.getBaseurl());
235

    
236
		if (api.isCompatibilityOverrided()) {
237
			addInterfaceExtraField(ifc, "overriding_compliance", true);
238
		}
239

    
240
		addInterfaceExtraField(ifc, "metadata_identifier_path", api.getMetadataIdentifierPath());
241
		addInterfaceExtraField(ifc, "last_collection_date", api.getLastCollectionDate());
242
		addInterfaceExtraField(ifc, "last_collection_mdId", api.getLastCollectionMdid());
243
		addInterfaceExtraField(ifc, "last_collection_total", api.getLastCollectionTotal());
244
		addInterfaceExtraField(ifc, "last_aggregation_date", api.getLastAggregationDate());
245
		addInterfaceExtraField(ifc, "last_aggregation_mdId", api.getLastAggregationMdid());
246
		addInterfaceExtraField(ifc, "last_aggregation_total", api.getLastAggregationTotal());
247
		addInterfaceExtraField(ifc, "last_download_date", api.getLastDownloadDate());
248
		addInterfaceExtraField(ifc, "last_download_objId", api.getLastDownloadObjid());
249
		addInterfaceExtraField(ifc, "last_download_total", api.getLastDownloadTotal());
250
	}
251

    
252
	private static void addExtraField(final Element parent, final String field, final Object value) {
253
		if (value != null && StringUtils.isNotBlank(value.toString())) {
254
			final Element f = parent.addElement("FIELD");
255
			f.addElement("key").setText(field);
256
			f.addElement("value").setText(value.toString());
257
		}
258
	}
259

    
260
	private static void addInterfaceExtraField(final Element parent, final String field, final Object value) {
261
		if (value != null && StringUtils.isNotBlank(value.toString())) {
262
			final Element f = parent.addElement("INTERFACE_EXTRA_FIELD");
263
			f.addAttribute("name", field);
264
			f.setText(value.toString());
265
		}
266
	}
267

    
268
	public static Map<String, Object> dsToMap(final Datasource<Organization<?>, Identity> ds) {
269
		final Map<String, Object> map = new HashMap<>();
270

    
271
		map.put("id", ds.getId());
272
		map.put("officialname", ds.getOfficialname());
273
		map.put("englishname", ds.getEnglishname());
274
		map.put("websiteurl", ds.getWebsiteurl());
275
		map.put("logourl", ds.getLogourl());
276
		map.put("contactemail", ds.getContactemail());
277
		map.put("latitude", ds.getLatitude());
278
		map.put("longitude", ds.getLongitude());
279
		map.put("timezone", ds.getTimezone());
280
		map.put("namespaceprefix", ds.getNamespaceprefix());
281
		map.put("languages", ds.getLanguages());
282
		map.put("od_contenttypes", ds.getOd_contenttypes());
283
		map.put("collectedfrom", ds.getCollectedfrom());
284
		map.put("dateofvalidation", ds.getDateofvalidation());
285
		map.put("typology", ds.getTypology());
286
		map.put("provenanceaction", ds.getProvenanceaction());
287
		map.put("platform", ds.getPlatform());
288
		map.put("activationid", ds.getActivationId());
289
		map.put("description", ds.getDescription());
290
		map.put("releasestartdate", ds.getReleasestartdate());
291
		map.put("releaseenddate", ds.getReleaseenddate());
292
		map.put("missionstatementurl", ds.getMissionstatementurl());
293
		map.put("dataprovider", ds.isDataprovider());
294
		map.put("serviceprovider", ds.isServiceprovider());
295
		map.put("databaseaccesstype", ds.getDatabaseaccesstype());
296
		map.put("datauploadtype", ds.getDatauploadtype());
297
		map.put("databaseaccessrestriction", ds.getDatabaseaccessrestriction());
298
		map.put("datauploadrestriction", ds.getDatauploadrestriction());
299
		map.put("versioning", ds.isVersioning());
300
		map.put("citationguidelineurl", ds.getCitationguidelineurl());
301
		map.put("qualitymanagementkind", ds.getQualitymanagementkind());
302
		map.put("pidsystems", ds.getPidsystems());
303
		map.put("certificates", ds.getCertificates());
304
		map.put("aggregator", ds.getAggregator());
305
		map.put("issn", ds.getIssn());
306
		map.put("eissn", ds.getEissn());
307
		map.put("lissn", ds.getLissn());
308
		map.put("registeredby", ds.getRegisteredby());
309
		map.put("subjects", ds.getSubjects());
310
		map.put("managed", ds.isManaged());
311

    
312
		return map;
313
	}
314

    
315
	public static Map<String, Object> orgToMap(final String dsId, final Organization<?> org) {
316
		final Map<String, Object> map = new HashMap<>();
317
		map.put("dsId", dsId);
318
		map.put("orgId", org.getId());
319
		map.put("legalname", org.getLegalname());
320
		map.put("legalshortname", org.getLegalshortname());
321
		map.put("websiteurl", org.getWebsiteurl());
322
		map.put("logourl", org.getLogourl());
323
		map.put("country", org.getCountry());
324
		return map;
325
	}
326

    
327
	public static Map<String, Object> apiToMap(final Api<?> api) {
328
		final Map<String, Object> map = new HashMap<>();
329
		map.put("apiId", api.getId());
330
		map.put("protocol", api.getProtocol());
331
		map.put("baseUrl", api.getBaseurl());
332
		map.put("dsId", api.getDatasource());
333
		map.put("contentDescription", api.getContentdescription());
334
		map.put("typology", api.getTypology());
335
		map.put("compatibility", api.getCompatibility());
336
		map.put("metadataIdentifierPath", api.getMetadataIdentifierPath());
337
		// The other fields are not required in the INSERT operation
338
		return map;
339
	}
340

    
341
	@SuppressWarnings("unchecked")
342
	private static <T> T castObject(final Object o, final Class<T> clazz) {
343
		if (o == null) { return null; }
344
		if (clazz.isInstance(o)) { return (T) o; }
345
		throw new IllegalArgumentException("Type not managed: " + clazz.getSimpleName());
346
	}
347

    
348
}
(1-1/4)