hdca-model.js

import DC_MODEL from "mvc/collection/collection-model";
import HISTORY_CONTENT from "mvc/history/history-content-model";
import _l from "utils/localization";

/*==============================================================================

Models for DatasetCollections contained within a history.

TODO:
    these might be compactable to one class if some duplication with
    collection-model is used.

==============================================================================*/
var hcontentMixin = HISTORY_CONTENT.HistoryContentMixin;

var FlatDC = DC_MODEL.FlatDatasetCollection;
var NestedDC = DC_MODEL.NestedDatasetCollection;

//==============================================================================
/** Override to post to contents route w/o id. */
function buildHDCASave(_super) {
    return function _save(attributes, options) {
        if (this.isNew()) {
            options = options || {};
            options.url = `${this.urlRoot + this.get("history_id")}/contents`;
            attributes = attributes || {};
            attributes.type = "dataset_collection";
        }
        return _super.call(this, attributes, options);
    };
}

//==============================================================================
/** @class Backbone model for List Dataset Collection within a History.
 */
var HistoryListDatasetCollection = FlatDC.extend(hcontentMixin).extend(
    /** @lends HistoryListDatasetCollection.prototype */ {
        defaults: _.extend(_.clone(FlatDC.prototype.defaults), {
            history_content_type: "dataset_collection",
            collection_type: "list",
            model_class: "HistoryDatasetCollectionAssociation"
        }),

        /** Override to post to contents route w/o id. */
        save: buildHDCASave(FlatDC.prototype.save),

        /** String representation. */
        toString: function() {
            return `History${FlatDC.prototype.toString.call(this)}`;
        }
    }
);

//==============================================================================
/** @class Backbone model for Pair Dataset Collection within a History.
 *  @constructs
 */
var HistoryPairDatasetCollection = FlatDC.extend(hcontentMixin).extend(
    /** @lends HistoryPairDatasetCollection.prototype */ {
        defaults: _.extend(_.clone(FlatDC.prototype.defaults), {
            history_content_type: "dataset_collection",
            collection_type: "paired",
            model_class: "HistoryDatasetCollectionAssociation"
        }),

        /** Override to post to contents route w/o id. */
        save: buildHDCASave(FlatDC.prototype.save),

        /** String representation. */
        toString: function() {
            return `History${FlatDC.prototype.toString.call(this)}`;
        }
    }
);

//==============================================================================
/** @class Backbone model for List of Pairs Dataset Collection within a History. */
var HistoryListPairedDatasetCollection = NestedDC.extend(hcontentMixin).extend({
    defaults: _.extend(_.clone(NestedDC.prototype.defaults), {
        history_content_type: "dataset_collection",
        collection_type: "list:paired",
        model_class: "HistoryDatasetCollectionAssociation"
    }),

    /** Override to post to contents route w/o id. */
    save: buildHDCASave(NestedDC.prototype.save),

    /** String representation. */
    toString: function() {
        return `History${NestedDC.prototype.toString.call(this)}`;
    }
});

//==============================================================================
/** @class Backbone model for List of Lists Dataset Collection within a History. */
var HistoryListOfListsDatasetCollection = NestedDC.extend(hcontentMixin).extend({
    defaults: _.extend(_.clone(NestedDC.prototype.defaults), {
        history_content_type: "dataset_collection",
        collection_type: "list:list",
        model_class: "HistoryDatasetCollectionAssociation"
    }),

    /** Override to post to contents route w/o id. */
    save: buildHDCASave(NestedDC.prototype.save),

    /** String representation. */
    toString: function() {
        return `HistoryListOfListsDatasetCollection(${this.get("name")})`;
    }
});

//==============================================================================
export default {
    HistoryListDatasetCollection: HistoryListDatasetCollection,
    HistoryPairDatasetCollection: HistoryPairDatasetCollection,
    HistoryListPairedDatasetCollection: HistoryListPairedDatasetCollection,
    HistoryListOfListsDatasetCollection: HistoryListOfListsDatasetCollection
};