Plato - lib/dataTier/flow/flowModel.js

/*jshint node: true, -W106 */
'use strict';

/*
* Name : graphModel.js
* Module : Lib::DataTier::FlowModel
* Location : /lib/dataTier/flow
*
* History :
* 
* Version   Date         Programmer         Description
* =========================================================
* 0.0.1     2015-05-14   Filippo Rampado    Initial code
* =========================================================
*/

var FilterModel = require('./filterModel.js');
var Helper = require('../../helpers/functionHelper.js');

//class constructor
function FlowModel(params) {
	if(params===undefined || params.ID===undefined || typeof params.ID !== 'string'|| params.ID.trim() === ''){ // ID field is required
		console.log('Error: 251');
		return;
	}

this._ID=params.ID;
	this._name='';
	this._type='';
	this._filters=null;
	this._records=[];
	this._progressiveIndex=0;
	if(typeof params.type === 'string' && (params.type==='BarChartFlow' || params.type==='LineChartFlow' || params.type==='MapChartFlow' || params.type==='TableFlow')){
        this._type=params.type;
    }
	this.updateBaseProperties(params);
}

//converts a record into a different format
FlowModel.prototype.converter = function(record, key, format) {
	return Helper.converter(record,key,format);
};

//generates an unique ID for a new record
FlowModel.prototype.generateNorrisRecordID = function(){
	var date = new Date();
	if (this._progressiveIndex>99){
		this._progressiveIndex=0;
	}
	this._progressiveIndex++;
	//to make the ID it uses the flow ID, the current datetime and a progressive number
	return this._ID.concat('_').concat(date.getTime()).concat('_').concat(this._progressiveIndex);
};

//returns the flow properties
FlowModel.prototype.getProperties = function(){
	var f=null;
	if (this._filters!==null){
		f=this._filters.getFilterText();
	}
	return {
		ID: this._ID,
		name: this._name,
		filters: f
	};
};

//returns the flow data
FlowModel.prototype.getData = function(){
	var flowData=[];
	var records= this._records.length;

for(var i=0; i<records; i++){
		if (this._records[i].norrisRecordIsValid){
			flowData.push(this._records[i]);
		}
	}//for records

return flowData;
};

//validates the whole flow data based on the filters
FlowModel.prototype.validateData = function(){
	var records= this._records.length;
	for (var i=0; i<records; i++){
		this.validateRecord(i);
	}
};

//validates a single record based on the filters
FlowModel.prototype.validateRecord = function(index){
	//checks if the index is valid
	if (typeof index === 'number' && index>=0 && index<this._records.length){
		this._records[index].norrisRecordIsValid = true;
		if (this._filters !== null){
			/*if (this._filters.validateRecord(this._records[index]) === true){
				this._records[index].norrisRecordIsValid = true;
			}
			if (this._filters.validateRecord(this._records[index]) === false){
				this._records[index].norrisRecordIsValid = false;
			}*/
			this._records[index].norrisRecordIsValid = this._filters.validateRecord(this._records[index]);
		}
	}
};

//updates the properties of the flow
FlowModel.prototype.updateBaseProperties = function(params) {
	if (params !== undefined){
		//ID field can't be modified
		var prop={};
		if(params.name!==undefined && typeof params.name === 'string'){
			this._name=prop.name=params.name;
		}

//creates a new filter if necessary
		if(params.filters !== undefined && typeof params.filters === 'string'){
			var filter=new FilterModel(params.filters);
			if (filter.hasOwnProperty('_filterText')){	//valid FilterModel
				this._filters = filter;
				prop.filters=params.filters;
				this.validateData();
			}
		}
		//returns the actually modified values
		return prop;
	}
	return 252;
};

//returns a record given its ID
FlowModel.prototype.getRecordByID = function(ID){
	if (typeof ID==='string' && ID.indexOf(this._ID) !== -1) { // check if ID belong to this flow
		var records=this._records.length;
		var i=0;
		var found=false;
		while (i<records && (!found)){
			if (this._records[i].norrisRecordID===ID){
				found=true;
			}
			else{
				i++;
			}
		}//while
		if (found){//in records[i] there is the ID
			return this._records[i];
		}
		//no ID in records
	}
	return 155;
};

module.exports = FlowModel;

lib/dataTier/flow/flowModel.js

Maintainability

Lines of code

Difficulty

Estimated Errors

Function weight

By Complexity

By SLOC