recordset-base-debug.js revision b41c27a66cb2271249d8117d3d5395ab17594f86
1549N/AYUI.add('recordset-base', function(Y) {
1549N/A
1549N/A
1549N/A/**
1549N/A * Class name.
1549N/A *
1549N/A * @property NAME
1549N/A * @type String
1549N/A * @static
1549N/A * @final
1549N/A * @value "record"
1549N/A */
1549N/Avar Record = Y.Base.create('record', Y.Base, [], {
1549N/A _setId: function() {
1549N/A return Y.guid();
1549N/A },
1549N/A
1549N/A initializer: function(o) {
1549N/A
1549N/A },
1549N/A
1549N/A destructor: function() {
1549N/A },
1549N/A
1549N/A getValue: function(field) {
1549N/A if (field === undefined) {
1549N/A return this.get("data");
1549N/A }
1549N/A else if (field === 'id') {
1549N/A return this.get('id');
1549N/A }
1549N/A else {
1549N/A return this.get("data")[field];
1549N/A }
1549N/A return null;
1549N/A }
1549N/A},
1549N/A{
1549N/A ATTRS: {
1549N/A id: {
1549N/A valueFn: "_setId"
1549N/A },
1549N/A data : {
1549N/A value: null
1549N/A }
1549N/A }
1549N/A});
1549N/A
1549N/AY.Record = Record;
1549N/Avar ArrayList = Y.ArrayList,
1549N/A Bind = Y.bind,
1549N/A Recordset = Y.Base.create('recordset', Y.Base, [], {
1549N/A
1549N/A initializer: function() {
1549N/A
1549N/A //set up event listener to fire events when recordset is modified in anyway
1549N/A this.publish('add', {defaultFn: this._defAddFn});
1549N/A this.publish('remove', {defaultFn: this._defRemoveFn});
1549N/A this.publish('empty', {defaultFn: this._defEmptyFn});
1549N/A this.publish('update', {defaultFn: this._defUpdateFn});
1549N/A
1549N/A this._recordsetChanged();
1549N/A this._syncHashTable();
1549N/A },
1549N/A
1549N/A destructor: function() {
1549N/A },
1549N/A
/**
* Helper method called upon by add() - it is used to create a new record(s) in the recordset
*
* @method _defAddFn
* @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
*/
_defAddFn: function(e) {
var len = this._items.length,
recs = e.added,
index = e.index,
i=0;
//index = (Y.Lang.isNumber(index) && (index > -1)) ? index : len;
for (; i < recs.length; i++) {
//if records are to be added one at a time, push them in one at a time
if (index === len) {
this._items.push(recs[i]);
}
else {
this._items.splice(index,0,recs[i]);
index++;
}
}
Y.log('add Fired');
},
_defRemoveFn: function(e) {
if (e.index === 0) {
this._items.pop();
}
else {
this._items.splice(e.index,e.range);
}
//this._defRemoveHash(e);
Y.log('remove fired');
},
_defEmptyFn: function(e) {
this._items = [];
//this._defEmptyHash();
Y.log('empty fired');
},
_defUpdateFn: function(e) {
for (var i=0; i<e.updated.length; i++) {
this._items[e.index + i] = this._changeToRecord(e.updated[i]);
}
//this._defUpdateHash(e);
},
//---------------------------------------------
// Hash Table Methods
//---------------------------------------------
_defAddHash: function(e) {
var obj = this.get('table'), key = this.get('key'), i=0;
for (; i<e.added.length; i++) {
obj[e.added[i].getValue(key)] = e.added[i];
}
this.set('table', obj);
},
_defRemoveHash: function(e) {
var obj = this.get('table'), key = this.get('key'), i=0;
for (; i<e.removed.length; i++) {
delete obj[e.removed[i].getValue(key)];
}
this.set('table', obj);
},
_defUpdateHash: function(e) {
var obj = this.get('table'), key = this.get('key'), i=0;
//deletes the object key that held on to an overwritten record and
//creates an object key to hold on to the updated record
for (; i < e.updated.length; i++) {
delete obj[e.overwritten[i].get(key)];
obj[e.updated[i].getValue(key)] = e.updated[i];
}
this.set('table', obj);
},
_defEmptyHash: function() {
this.set('table', {});
},
_setHashTable: function() {
var obj = {}, key=this.get('key'), i=0, len = this._items.length;
for (; i<len; i++) {
obj[this._items[i].getValue(key)] = this._items[i];
}
return obj;
},
/**
* Helper method - it takes an object bag and converts it to a Y.Record
*
* @method _changeToRecord
* @param obj {Object || Y.Record} Any objet literal or Y.Record instance
* @return {Y.Record} A Record instance.
* @private
*/
_changeToRecord: function(obj) {
var oRec;
if (obj instanceof Y.Record) {
oRec = obj;
}
else {
oRec = new Y.Record({data:obj});
}
return oRec;
},
//---------------------------------------------
// Events
//---------------------------------------------
/**
* 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
* @private
*/
_recordsetChanged: function() {
this.on(['update', 'add', 'remove', 'empty'], function() {
Y.log('change fire');
this.fire('change', {});
});
},
_syncHashTable: function() {
this.after('add', function(e) {
this._defAddHash(e);
});
this.after('remove', function(e) {
this._defRemoveHash(e);
});
this.after('update', function(e) {
this._defUpdateHash(e);
});
this.after('update', function(e) {
this._defEmptyHash();
});
},
//---------------------------------------------
// Public Methods
//---------------------------------------------
/**
* Returns the record with particular ID
*
* @method getRecord
* @param i {id} The ID of the record
* @return {Y.Record} An Y.Record instance
* @public
*/
getRecord: function(i) {
if (Y.Lang.isString(i)) {
return this.get('table')[i];
}
else if (Y.Lang.isNumber(i)) {
return this._items[i];
}
return null;
},
/**
* Returns the record at a particular index
*
* @method getRecordByIndex
* @param i {Number} Index at which the required record resides
* @return {Y.Record} An Y.Record instance
* @public
*/
getRecordByIndex: function(i) {
return this._items[i];
},
/**
* Returns a range of records beginning at particular index
*
* @method getRecordsByIndex
* @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
*/
getRecordsByIndex: function(index, range) {
var i=0, returnedRecords = [];
//Range cannot take on negative values
range = (Y.Lang.isNumber(range) && (range > 0)) ? range : 1;
for(; i<range; i++) {
returnedRecords.push(this._items[index+i]);
}
return returnedRecords;
},
getLength: function() {
return this.size();
},
/**
* Returns an array of values for a specified key in the recordset
*
* @method getRecord
* @param index {Number} (optional) Index at which the required record resides
* @return {Array} An array of values for the given key
* @public
*/
getValuesByKey: function(key) {
var i = 0, len = this._items.length, retVals = [];
for( ; i < len; i++) {
retVals.push(this._items[i].getValue(key));
}
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
*/
add: function(oData, index) {
var newRecords=[], idx, i=0;
idx = (Y.Lang.isNumber(index) && (index > -1)) ? index : this._items.length;
//Passing in array of object literals for oData
if (Y.Lang.isArray(oData)) {
for(; i < oData.length; i++) {
newRecords[i] = this._changeToRecord(oData[i]);
}
}
else if (Y.Lang.isObject(oData)) {
newRecords[0] = this._changeToRecord(oData);
}
this.fire('add', {added:newRecords, index:idx});
return this;
},
/**
* 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
*/
remove: function(index, range) {
var remRecords=[];
//Default is to only remove the last record - the length is always 1 greater than the last index
index = (index > -1) ? index : (this.size()-1);
range = (range > 0) ? range : 1;
remRecords = this._items.slice(index,(index+range));
this.fire('remove', {removed: remRecords, range:range, index:index});
//this._recordRemoved(remRecords, index);
//return ({data: remRecords, index:index});
return this;
},
/**
* Empties the recordset
*
* @method empty
* @public
*/
empty: function() {
this.fire('empty', {});
return this;
},
update: function(data, index) {
var rec, arr, i=0;
//Whatever is passed in, we are changing it to an array so that it can be easily iterated in the _defUpdateFn method
arr = (!(Y.Lang.isArray(data))) ? [data] : data;
rec = this._items.slice(index, index+arr.length);
for (; i<arr.length; i++) {
arr[i] = this._changeToRecord(arr[i]);
}
this.fire('update', {updated:arr, overwritten:rec, index:index});
return this;
}
},
{
ATTRS: {
records: {
validator: Y.Lang.isArray,
getter: function () {
// give them a copy, not the internal object
return Y.Array(this._items);
},
setter: function (allData) {
var records = [];
function initRecord(oneData) {
var o;
if (oneData instanceof Y.Record) {
records.push(oneData);
}
else {
o = new Y.Record({data:oneData});
records.push(o);
}
}
Y.Array.each(allData, initRecord);
this._items = Y.Array(records);
},
//initialization of the attribute must be done before the first call is made.
//see http://developer.yahoo.com/yui/3/api/Attribute.html#method_addAttr for details on this
lazyAdd: false
},
table: {
valueFn: '_setHashTable'
},
key: {
value:'id'
}
}
});
Y.augment(Recordset, ArrayList);
Y.Recordset = Recordset;
}, '@VERSION@' ,{requires:['base','record','arraylist']});