recordset.js revision 405904c4430a9e537ac2ef07a33447e71611d249
}
/**
* TODO: make recordsetChangedEvent fire through bubbling of other events
* TODO: figure out what object to send through recordsetChangedEvent when recordset is emptied
* TODO: finish updateRecord to make it work with indices, specific records, arrays
* TODO: update getRecord to return array of records
* TODO: Implement methods: hasRecord(), reverseRecords(), sortRecords(), toString(), getLength()
*/
/**
* Class name.
*
* @property NAME
* @type String
* @static
* @final
* @value "recordset"
*/
/////////////////////////////////////////////////////////////////////////////
//
// Recordset Attributes
//
/////////////////////////////////////////////////////////////////////////////
records: {
value: null,
setter: "_setRecords"
},
length: {
value: 0,
readOnly:true
}
};
/* Recordset extends Base */
_setRecords: function(allData) {
var records = [];
function initRecord(oneData){
}
return records;
},
initializer: function() {
},
destructor: function() {
},
/**
* Utility method called upon by add() - it is used to create a new record(s) in the recordset
*
* @method _add
* @param aRecord {Y.Record} A Y.Record instance
* @param index {Number} (optional) Index at which to add the record(s)
* @return {Y.Record} A Record instance.
* @private
*/
return aRecord;
},
var j=0,
rs = this,
//Arrays at the first index will always overwrite the one they are updating.
switch (j) {
case 0:
break;
default:
break;
}
}
},
//If overwrite is set to true, splice and remove the record at current entry, otherwise just add it
if (overwriteFlag) {
}
else {
}
},
//Take an object and create a record out of it, then return it
_changeToRecord: function(obj) {
var oRec;
}
else {
}
return oRec;
},
//---------------------------------------------
// Event Firing
//---------------------------------------------
/**
* Event that is fired whenever the recordset is changed. Note that multiple simultaneous changes still fires this event once.
* (ie: Adding multiple records via an array will only fire this event once at the completion of all the additions)
*
* @method _recordSetUpdated
* @param idx {Number} Index at which the modifications to the recordset were made
* @private
*/
_recordsetChanged: function(idx) {
Y.log('recordsetChangedEvent fired');
},
/**
* Event that is fired whenever the a record is added to the recordset. Multiple simultaneous changes still fires this event once.
*
* @method _recordAdded
* @param oRecord {Array} The record that was added, or an array of records added
* @param i {Number} Index at which the modifications to the recordset were made
* @private
*/
_recordAdded: function(oRecord, i) {
Y.log('recordsetAdded Event Fired');
},
/**
* Event that is fired whenever the a record is removed from the recordset. Multiple simultaneous changes still fires this event once.
*
* @method _recordDeleted
* @param oRecord {Array} An array of Y.Records that were deleted
* @param idx {Number} Index at which the modifications to the recordset were made
* @private
*/
Y.log('recordsetRemoved Event Fired');
},
/**
* Event that is fired when the record set is emptied
*
* @method _recordsetEmptied
* @private
*/
_recordsetEmptied: function() {
//TODO: What configuration object should be sent here?
this.fire('recordsetEmptiedEvent', {});
Y.log('recordsetEmptied Event Fired');
},
Y.log('recordsetUpdated Event Fired');
},
//---------------------------------------------
// Public Methods
//---------------------------------------------
/**
* Returns the record at a particular index
*
* @method getRecord
* @param index {Number} Index at which the required record resides
* @return {Y.Record} An Y.Record instance
* @public
*/
},
/**
* Returns a range of records beginning at particular index
*
* @method getRecord
* @param index {Number} Index at which the required record resides
* @param range {Number} (Optional) Number of records to retrieve. The default is 1
* @return {Array} An array of Y.Record instances
* @public
*/
var i=0, returnedRecords = [];
//Range cannot take on negative values
return returnedRecords;
},
/**
* Returns a string of values for a specified key in the recordset
*
* @method getRecord
* @param index {Number} (optional) Index at which the required record resides
* @return {Y.Record} An Y.Record instance
* @public
*/
getValuesByKey: function(key) {
for( ; i < len; i++) {
}
return retVals;
},
/**
* Adds one or more Records to the RecordSet at the given index. If index is null,
* then adds the Records to the end of the RecordSet.
*
* @method add
* @param oData {Y.Record, Object Literal, Array} A Y.Record instance, An object literal of data or an array of object literals
* @param index {Number} (optional) Index at which to add the record(s)
* @return {object} An object literal with two properties: "data" which contains array of Y.Record(s) and "index" which contains the index where the Y.Record(s) were added
* @public
*/
//Passing in array of object literals for oData
newRecords = [];
delete oRecord;
idx++;
}
}
//If it is an object literal of data
}
//it is an instance of Y.Record - checking explicitly here so nothing weird gets through
}
this._recordsetChanged(index);
//return an object literal, containing array of new Y.Record instances
},
/**
* Removes one or more Records to the RecordSet at the given index. If index is null,
* then removes a single Record from the end of the RecordSet.
*
* @method remove
* @param index {Number} (optional) Index at which to remove the record(s) from
* @param range {Number} (optional) Number of records to remove (including the one at the index)
* @return {object} An object literal with two properties: "data" which contains the removed set {Y.Record or Y.Recordset} and "index" which contains the index where the Y.Record(s) were removed from
* @public
*/
var remRecords=[];
//Default is to only remove the last record - the length is always 1 greater than the last index
//Remove records and store them in remRecords
//Fire events
this._recordsetChanged(index);
},
/**
* Empties the recordset
*
* @method empty
* @public
*/
empty: function() {
this._recordsetEmptied();
//TODO: What index should be sent to recordSetUpdatedEvent when the recordset is emptied?
this._recordsetChanged(0);
return null
},
//var rs = this, oRec;
//If passing in an array
}
//If its just an object, it will overwrite the existing one, so passing in true
}
//this._recordsetUpdated(oRecord, oData);
//console.log(this.get('records'));
return null;
}
});