DataTypeConverter.js
22.9 KB
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
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
/*
** This file is part of JSDataChecker.
**
** JSDataChecker is free software: you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation, either version 3 of the License, or
** (at your option) any later version.
**
** JSDataChecker is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with JSDataChecker. If not, see <http://www.gnu.org/licenses/>.
**
** Copyright (C) 2016 JSDataChecker - Donato Pirozzi (donatopirozzi@gmail.com)
** Distributed under the GNU GPL v3. For full terms see the file LICENSE.
** License: http://www.gnu.org/licenses/gpl.html GPL version 3 or higher
**/
function DataTypeConverter() {
this._fields = [];
this._numOfRows = 0;
};//EndConstructor.
DataTypeConverter.TYPES = {
TEXT : { value: 0, name: "TEXT" },
CODE : { value: 1, name: "CODE"},
NUMBER : { value: 2, name: "NUMBER" },
OBJECT : { value: 3, name: "OBJECT" },
BOOL : { value: 5, name: "BOOL"},
CONST : { value: 6, name: "CONST" },
CATEGORY : { value: 7, name: "CATEGORY" },
DATETIME : { value: 8, name: "DATETIME" },
EMPTY : { value: 101, name: "NULL" }
};
DataTypeConverter.SUBTYPES = {
GEOCOORDINATE : { value: 1000, name: "GEOCOORDINATE" },
PERCENTAGE : { value: 1000, name: "PERCENTAGE" },
LATITUDE : { value: 1001, name: "LATITUDE" },
LONGITUDE : { value: 1002, name: "LONGITUDE" }
};
DataTypeConverter.prototype = (function () {
/***
* Make an asynchronous call to load the content.
* @param theUrl
* @param callback
* @deprecated
*/
var httpGetAsync = function(theUrl, callbackOnFinish) {
console.warn("Calling deprecated function.");
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
if (xhttp.readyState == 4 && xhttp.status == 200)
_processDataset(xhttp.responseText, callbackOnFinish);
}
xhttp.open("GET", theUrl, true); // true for asynchronous
xhttp.send(null);
};//EndFunction.
/*var _processDataset = function (jsonRows) {
//Check if the jsonRow is an array.
if (Array.isArray(jsonRows) == false) return;
for (var i=0; i<jsonRows.length; i++) {
var jsonRow = jsonRows[i];
_processRow(jsonRow);
}//EndFor.
_analyseDataTypes(this._fields);
return this._fields;
};//EndFunction.*/
/*var _processRow = function(row) {
//Avoid empty rows
if (typeof row === 'undefined') return;
//Get the object keys.
for (var property in row) {
if (row.hasOwnProperty(property)) {
var cellValue = row[property];
//if (property == 'votantspourcentages') debugger;
//if (property == 'va_no_voie') debugger;
var inferredType = _processInferType(cellValue);
if (typeof this._fields[property] === 'undefined')
this._fields[property] = { name: property, _inferredTypes: [], _inferredValues: [] };
_arrUtil.testAndIncrement(this._fields[property]._inferredTypes, inferredType.name);
if (inferredType === DataTypeConverter.TYPES.TEXT)
_arrUtil.testAndIncrement(this._fields[property]._inferredValues, cellValue);
if (inferredType === DataTypeConverter.TYPES.LATITUDE || inferredType === DataTypeConverter.TYPES.LONGITUDE)
_arrUtil.testAndIncrement(this._fields[property]._inferredTypes, DataTypeConverter.TYPES.NUMBER);
}
}
this._numOfRows++;
};//EndFunction.*/
var _analyseDataTypes = function(fields) {
ArrayUtils.IteratorOverKeys(fields, function(field) {
if (field._inferredTypes[DataTypeConverter.TYPES.CODE.name]) {
var confidence = field._inferredTypes[DataTypeConverter.TYPES.CODE.name] / field.numOfItems;
var _numericalInferredType = field._inferredTypes[DataTypeConverter.TYPES.NUMBER.name];
if (typeof _numericalInferredType != 'undefined') confidence += _numericalInferredType / field.numOfItems;
field.type = DataTypeConverter.TYPES.CODE.name;
field.typeConfidence = confidence;
return;
}
//Infers the field TYPE.
var max = ArrayUtils.FindMinMax(field._inferredTypes, function (curval, lastval) {
return curval > lastval;
});
//When the first key is null, it uses the second one.
var tkey = max.first.key;
if (tkey === DataTypeConverter.TYPES.EMPTY.name &&
max.second != null && typeof max.second !== 'undefined')
tkey = max.second.key;
field.type = tkey;
field.typeConfidence = field._inferredTypes[max.first.key] / field.numOfItems;
//##########
//Infers the field SUBTYPE.
var max = ArrayUtils.FindMinMax(field._inferredSubTypes, function (curval, lastval) {
return curval > lastval;
});
field.subtype = null;
if (max != null && max.first != null) {
field.subtype = max.first.key;
field.subtypeConfidence = field._inferredSubTypes[field.subtype] / field.numOfItems;
//TODO: improve this piece of code.
//LAT/LNG.
var fieldName = field.name.toLowerCase();
var isLatType = (field.subtype === DataTypeConverter.SUBTYPES.LATITUDE.name);
var fieldNameContainsLat = fieldName.indexOf('lat') >= 0;
var fieldNameContainsLon = fieldName.indexOf('ng') >= 0; //It could be 'lng'.
if (isLatType == true && fieldNameContainsLat == false && fieldNameContainsLon == true) {
field.subtype = DataTypeConverter.SUBTYPES.LONGITUDE.name;
}
}
///
/// SUBTYPES.
//BOOLEAN.
/*var numOfValues = Object.keys(field._inferredValues).length;
if (field.type === DataTypeConverter.TYPES.TEXT.name) {
//if (numOfValues == 1) field.type = DataTypeConverter.TYPES.CONST.name;
//else if (numOfValues == 2) field.type = DataTypeConverter.TYPES.BOOL.name;
//else
if (numOfValues < field.numOfItems * 0.20) field.type = DataTypeConverter.TYPES.CATEGORY.name;
}*/
});
};//EndFunction.
/**
* Given a dataset value, it tries to recognise the data types.
* This is the central function within the library.
* @param value
* @returns {*}
* @private
*/
var _processInferType = function(value) {
//value = value.toLocaleString();
if (value === null || typeof value === 'undefined')
return DataTypeConverter.TYPES.EMPTY;
if (typeof value === 'object')
return DataTypeConverter.TYPES.OBJECT;
//If the value starts with a zero and contains all numbers, it is
//inferred as textual content.
if (/^0[0-9]+$/.test(value))
return DataTypeConverter.TYPES.CODE;
//Try to parse the float.
var isnumber = DataTypesUtils.FilterFloat(value);
if (isNaN(isnumber) !== true) {//It is a number.
//If the number ranges from -90.0 to 90.0, the value is marked as Latitude.
//if (-90.0 <= isnumber && isnumber <= 90.0 && _dataTypesUtils.decimalPlaces(isnumber) >= 5)
// return DataTypeConverter.TYPES.LATITUDE;
//It the number ranges from -180.0 to 180.0, the value is marked as Longitude.
//if (-180.0 <= isnumber && isnumber <= 180.0 && _dataTypesUtils.decimalPlaces(isnumber) >= 5)
// return DataTypeConverter.TYPES.LONGITUDE;
/*if (0.0 <= isnumber && isnumber <= 100.0)
if(/^(\+)?((0|([1-9][0-9]*))\.([0-9]+))$/ .test(value))
return DataTypeConverter.TYPES.PERCENTAGE;*/
return DataTypeConverter.TYPES.NUMBER;
}
var _date = DataTypesUtils.FilterDateTime(value);
if (isNaN(_date) == false && _date != null)
return DataTypeConverter.TYPES.DATETIME;
return DataTypeConverter.TYPES.TEXT;
};//EndFunction.
var _processInferSubType = function (value) {
if (value === null || typeof value === 'undefined') return null;
//Try to parse the float.
var isnumber = DataTypesUtils.FilterFloat(value);
if (isNaN(isnumber) !== true) {//It is a number.
//If the number ranges from -90.0 to 90.0, the value is marked as Latitude.
if (-90.0 <= isnumber && isnumber <= 90.0 && DataTypesUtils.DecimalPlaces(isnumber) >= 5)
return DataTypeConverter.SUBTYPES.GEOCOORDINATE;
//It the number ranges from -180.0 to 180.0, the value is marked as Longitude.
if (-180.0 <= isnumber && isnumber <= 180.0 && DataTypesUtils.DecimalPlaces(isnumber) >= 5)
return DataTypeConverter.SUBTYPES.GEOCOORDINATE;
/*if (0.0 <= isnumber && isnumber <= 100.0)
if(/^(\+)?((0|([1-9][0-9]*))\.([0-9]+))$/ .test(value))
return DataTypeConverter.SUBTYPES.PERCENTAGE;*/
return null;
}
return null;
};//EndFunction.
var _filterBasedOnThreshold = function(metadata, threshold) {
ArrayUtils.IteratorOverKeys(metadata.types, function (fieldType, key) {
if (fieldType.typeConfidence >= threshold) return;
var arrHierarchyTypes = DataTypeHierarchy.HIERARCHY[fieldType.type];
var lastFieldType = { lastType: arrHierarchyTypes[0],
lastTypeCounter: fieldType._inferredTypes[arrHierarchyTypes[0]],
typeConfidence: 0 };
lastFieldType.typeConfidence = lastFieldType.lastTypeCounter / fieldType.numOfItems;
for (var i= 1, curType; i<arrHierarchyTypes.length, curType = arrHierarchyTypes[i]; i++) {
var numItemsOfCurType = fieldType._inferredTypes.hasOwnProperty(curType) ? fieldType._inferredTypes[curType] : 0 ;
lastFieldType.lastType = curType;
lastFieldType.lastTypeCounter += numItemsOfCurType;
lastFieldType.typeConfidence = lastFieldType.lastTypeCounter / fieldType.numOfItems;
if (lastFieldType.typeConfidence >= threshold) {
fieldType.type = lastFieldType.lastType;
fieldType.typeConfidence = lastFieldType.typeConfidence;
break;
}
}
});
return metadata;
};//EndFunction.
var jsonTraverse = function(json, fieldKeys, callback) {
var stack = [];
var numOfRows = 0;
stack.push({ item: json, fieldKeyIndex: 0 });
while (stack.length > 0) {
var stackTask = stack.pop();
var item = stackTask.item;
var fieldKeyIndex = stackTask.fieldKeyIndex;
var fieldKey = fieldKeys[fieldKeyIndex];
//Test fieldKey Value.
if (fieldKey == '*' && ArrayUtils.isArray(item) == false) {
var sProcessedKeys = fieldKeys.slice(0, fieldKeyIndex).toString();
ArrayUtils.IteratorOverKeys(item, function (value, key) {
var curKey = sProcessedKeys + (sProcessedKeys.length > 0 ? "," : "") + key;
var _value = callback(value, key, curKey, numOfRows);
item[key] = _value;
});
numOfRows++;
continue;
}
//It is an array, loops through its cells and pushes items within the stack.
if (fieldKey == '*' && ArrayUtils.isArray(item) == true) {
for (var j= 0, cell; j<item.length && (cell = item[j]); j++) {
stack.push({item: cell, fieldKeyIndex: fieldKeyIndex});
numOfRows++;
}
continue;
}
var jsonSubtree = item[fieldKey];
if (Array.isArray(jsonSubtree)) { //It is an array.
for (var j=0; j<jsonSubtree.length; j++) {
var jsonItem = jsonSubtree[j];
stack.push({ item: jsonItem, fieldKeyIndex: fieldKeyIndex+1 });
}//EndForJ.
} else {
stack.push({ item: jsonSubtree, fieldKeyIndex: fieldKeyIndex+1 });
}
}//EndWhile.
};//EndFunction.
return {
constructor: DataTypeConverter,
/**
* It parses the json in input and converts the content
* in according to the inferred data types.
* @param json
* @param path Format: field1->field2->field3
*/
cast: function(metadata, options) {
if (typeof options === 'undefined' || options == null)
options = { castThresholdConfidence: 1, castIfNull: false };
return this.convert(metadata, options);
},
/**
* It parses the json in input and converts the content
* in according to the inferred data types.
* @param json
* @param path Format: field1->field2->field3
* @deprecated
*/
convert: function (metadata, options) {
var lastRowIndex = 0;
var isRowInvalid = false;
var numOfRowsInvalid = 0;
var numOfRows = 0;
var numOfValues = 0;
var datasetErrors = 0;
var datasetMissingValues = 0;
if (typeof options === 'undefined' || options == null)
options = { castThresholdConfidence: 1, castIfNull: false };
jsonTraverse(metadata.dataset, metadata.fieldKeys, function(value, key, traversedKeys, rowIndex) {
var inferredType = metadata.types[traversedKeys];
numOfValues++;
if (lastRowIndex != rowIndex) {
lastRowIndex = rowIndex;
numOfRows++;
//if (isRowInvalid) numOfRowsInvalid++;
}
if (value == null || typeof value == 'undefined' || (value + "").length == 0) {
//datasetErrors++;
} //isRowInvalid = true;
//var isCast = !(options.castIfNull == false && inferredType.totalNullValues > 0);
var isCast = inferredType.typeConfidence >= options.castThresholdConfidence;
if (inferredType.type == DataTypeConverter.TYPES.NUMBER.name && isCast) {
var number = parseFloat(value);
if (isNaN(number)) {
datasetErrors++;
return value;
}
return number;
}
return value;
});
metadata.qualityIndex.notNullValues = (numOfValues - datasetMissingValues) / numOfValues;
metadata.qualityIndex.errors = (numOfValues - datasetErrors) / numOfValues;
return metadata;
},//EndFunction.
/**
* It parses the json and infers the data types.
* @param json
* @param path Array of field keys/names.
* @param options Infer Data Type options, in particular the threshold value for the confidence.
*/
inferJsonDataType: function (json, fieldKeys, options) {
if (typeof options === 'undefined' || options == null)
options = { thresholdConfidence: 1 };
var stack = [];
var fieldsType = {};
var fieldsSubType = {};
var numOfRows = 0;
if (typeof fieldKeys == 'undefined')
throw "IllegalArgumentException: undefined json path to analyse.";
//Insert the first item (json root) within the stack.
stack.push({ item: json, fieldKeyIndex: 0 });
while (stack.length > 0) {
var stackTask = stack.pop();
var item = stackTask.item;
var fieldKeyIndex = stackTask.fieldKeyIndex;
var fieldKey = fieldKeys[fieldKeyIndex];
//Test fieldKey Value.
//This if is executed when the fieldKey is * and the dataset it is NOT an ARRAY.
//Thus, it loops through the javascript object KEYs.
if (fieldKey == '*' && ArrayUtils.isArray(item) == false) {
var sProcessedKeys = fieldKeys.slice(0, fieldKeyIndex).toString();
ArrayUtils.IteratorOverKeys(item, function (item, key) {
var curKey = sProcessedKeys + ((sProcessedKeys.length == 0) ? "" : ",") + key;
var fieldType = ArrayUtils.TestAndInitializeKey(fieldsType, curKey, { name: curKey, _inferredTypes: [], _inferredSubTypes: [], _inferredValues: [], numOfItems: 0 });
fieldType.numOfItems++;
///TYPE
var inferredType = _processInferType(item);
ArrayUtils.TestAndIncrement(fieldType._inferredTypes, inferredType.name);
if (inferredType === DataTypeConverter.TYPES.TEXT)
ArrayUtils.TestAndIncrement(fieldType._inferredValues, item);
///SUBTYPE
var inferredSubType = _processInferSubType(item);
if (inferredSubType != null && typeof inferredSubType !== 'undefined') {
ArrayUtils.TestAndIncrement(fieldType._inferredSubTypes, inferredSubType.name);
/*if (inferredSubType === DataTypeConverter.TYPES.LATITUDE)
ArrayUtils.TestAndIncrement(fieldType._inferredSubTypes, DataTypeConverter.TYPES.LATITUDE);
if (inferredSubType === DataTypeConverter.TYPES.LONGITUDE)
ArrayUtils.TestAndIncrement(fieldType._inferredSubTypes, DataTypeConverter.TYPES.LONGITUDE);*/
}//EndSubtype.
});
numOfRows++;
continue;
}
//Loops through the array cells.
if (fieldKey == '*' && ArrayUtils.isArray(item)) {
for (var j= 0, cell; j<item.length && (cell = item[j]); j++) {
stack.push({item: cell, fieldKeyIndex: fieldKeyIndex});
numOfRows++;
}
continue;
}
//This is executed when the fieldKey is not *
var jsonSubtree = item[fieldKey];
if (Array.isArray(jsonSubtree)) { //It is an array.
for (var j=0; j<jsonSubtree.length; j++) {
var jsonItem = jsonSubtree[j];
stack.push({ item: jsonItem, fieldKeyIndex: fieldKeyIndex+1 });
}//EndForJ.
} else {
stack.push({ item: jsonSubtree, fieldKeyIndex: fieldKeyIndex+1 });
}
}//EndWhile.
_analyseDataTypes(fieldsType);
//Data quality.
var quality = { homogeneity: 1, completeness: 1, totalNullValues: 0, totalValues: 0 };
ArrayUtils.IteratorOverKeys(fieldsType, function(fieldType) {
quality.totalValues += fieldType.numOfItems;
quality.homogeneity *= fieldType.typeConfidence;
fieldType.totalNullValues = 0;
if (fieldType._inferredTypes.hasOwnProperty(DataTypeConverter.TYPES.EMPTY.name)) {
fieldType.totalNullValues = fieldType._inferredTypes[DataTypeConverter.TYPES.EMPTY.name];
quality.totalNullValues += fieldType.totalNullValues;
}
});
quality.homogeneity = Math.round(quality.homogeneity * 100) / 100;
var totFullValues = quality.totalValues - quality.totalNullValues;
quality.completeness = Math.round(totFullValues / quality.totalValues * 100) / 100;
//Converts confidence to description.
var warningsTextual = "";
ArrayUtils.IteratorOverKeys(fieldsType, function(fieldType) {
fieldType.errorsDescription = "";
var description = "";
//if (fieldType.typeConfidence < 1 || fieldType.totalNullValues > 0)
// description = "The field <" + fieldType.name + "> is a <" + fieldType.type + ">, ";
if (fieldType.typeConfidence < 1) {
/*if (fieldType._inferredTypes.hasOwnProperty(DataTypeConverter.TYPES.EMPTY.name)) {
var numNulls = fieldType._inferredTypes[DataTypeConverter.TYPES.EMPTY.name];
if (typeof numNulls !== 'undefined' && numNulls > 0)
description += " and has " + numNulls + " EMPTY values, ";
}*/
var incorrect = fieldType.numOfItems - fieldType.totalNullValues - fieldType._inferredTypes[fieldType.type];
if (incorrect > 0) {
description += "The column <" + fieldType.name + "> has the type <" + fieldType.type + ">";
var verb = (incorrect == 1) ? " value is" : " values are";
description += ", but " + incorrect + verb + " not a " + fieldType.type;
}
}
if (fieldType.totalNullValues > 0) {
description += "The column <" + fieldType.name + "> has " + fieldType.totalNullValues + " EMPTY value";
if (fieldType.totalNullValues > 1) description += "s";
}
if (description.length > 0)
description += ".";
fieldType.errorsDescription = description;
warningsTextual += description;
});
var metadata = { dataset: json, fieldKeys: fieldKeys, types: fieldsType, qualityIndex: quality, warningsTextual: warningsTextual };
_filterBasedOnThreshold(metadata, options.thresholdConfidence);
return metadata;
},//EndFunction.
/*inferDataTypes: function (jsonRows) {
this._fields = [];
this._numOfRows = 0;
_processDataset(jsonRows);
return this._fields;
},//EndFunction.*/
/**
* Given in input a value, the function infers the data type.
* @param value
* @returns {*}
*/
inferDataTypeOfValue: function (value) {
return _processInferType(value);
}//EndFunction.
};
})();