relution-sdk
Version:
Relution Software Development Kit for TypeScript and JavaScript
135 lines • 12.8 kB
JavaScript
/*
* @file query/SortOrder.ts
* Relution SDK
*
* Created by Thomas Beckmann on 22.06.2015
* Copyright 2016 M-Way Solutions GmbH
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @module query
*/
/** */
;
var _ = require('lodash');
/**
* defines a sort order of fields.
*
* Caution, member fields eventually are shared by multiple instances! You may mutate member
* fields, but not the objects and arrays referenced by them.
*/
var SortOrder = (function () {
/**
* default/copy constructor.
*
* @param other instance to optionally initialize an independent copy of.
*/
function SortOrder(other) {
this.sortFields = other && other.sortFields;
}
/**
* parses a JSON literal such as ['-rating', '+date', 'id'] into this instance.
*
* @param json data, such as ['-rating', '+date'].
* @return {SortOrder} this instance.
*/
SortOrder.prototype.fromJSON = function (json) {
this.sortFields = new Array(json.length);
for (var i = json.length - 1; i >= 0; --i) {
this.sortFields[i] = new SortField().fromJSON(json[i]);
}
return this;
};
/**
* formats a string such as '+name,-id'.
*
* @return {string} representation of SortOrder, may be the empty string when this is empty.
*/
SortOrder.prototype.toString = function () {
var str = '';
var length = this.sortFields.length;
for (var i = 0; i < length; ++i) {
if (i > 0) {
str += ',';
}
str += this.sortFields[i].toString();
}
return str;
};
/**
* combines an other instance such that this order is maintained by priority and equivalent elements are ordered by
* the other order.
*
* You may want to optimize after merging several instances.
*
* @param other order to merge into this as secondary.
*/
SortOrder.prototype.merge = function (other) {
this.sortFields = this.sortFields.concat(other.sortFields);
};
/**
* eliminates redundant sort fields that do not affect overall order.
*/
SortOrder.prototype.optimize = function () {
this.sortFields = _.uniqBy(this.sortFields, function (sortField) {
return sortField.name;
});
};
return SortOrder;
}());
exports.SortOrder = SortOrder;
var SortField = (function () {
/**
* default/copy constructor.
*
* @param other instance to optionally initialize an independent copy of.
*/
function SortField(other) {
if (other) {
this.name = other.name;
this.ascending = other.ascending;
}
}
/**
* parses a JSON literal such as '-rating' into this instance.
*
* @param json data, such as '-rating'.
* @return {SortField} this instance.
*/
SortField.prototype.fromJSON = function (json) {
var order = json.length > 0 && json.charAt(0);
this.name = order === '+' || order === '-' ? json.substring(1) : json;
this.ascending = order !== '-';
return this;
};
/**
* formats a JSON literal such as 'name'.
*
* @return {string} JSON literal such as 'name'.
*/
SortField.prototype.toJSON = function () {
return this.ascending ? this.name : '-' + this.name;
};
/**
* formats a string such as '+name'.
*
* @return {string} such as '+name'.
*/
SortField.prototype.toString = function () {
return this.ascending ? '+' + this.name : '-' + this.name;
};
return SortField;
}());
exports.SortField = SortField;
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"SortOrder.js","sourceRoot":"","sources":["../../src/query/SortOrder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH;;GAEG;AACH,MAAM;;AAEN,IAAY,CAAC,WAAM,QAAQ,CAAC,CAAA;AAE5B;;;;;GAKG;AACH;IAME;;;;OAIG;IACH,mBAAmB,KAAiB;QAClC,IAAI,CAAC,UAAU,GAAG,KAAK,IAAI,KAAK,CAAC,UAAU,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,4BAAQ,GAAf,UAAgB,IAAc;QAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,CAAY,IAAI,CAAC,MAAM,CAAC,CAAC;QACpD,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;YAC1C,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,SAAS,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;IACd,CAAC;IAED;;;;SAIK;IACE,4BAAQ,GAAf;QACE,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,IAAI,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QACpC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAChC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBACV,GAAG,IAAI,GAAG,CAAC;YACb,CAAC;YACD,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACvC,CAAC;QACD,MAAM,CAAC,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACI,yBAAK,GAAZ,UAAa,KAAgB;QAC3B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACI,4BAAQ,GAAf;QACE,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,UAAC,SAAoB;YAC/D,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;IACH,gBAAC;AAAD,CAAC,AAlED,IAkEC;AAlEY,iBAAS,YAkErB,CAAA;AAED;IAUE;;;;OAIG;IACH,mBAAmB,KAAiB;QAClC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACV,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YACvB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACnC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,4BAAQ,GAAf,UAAgB,IAAY;QAC1B,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,GAAG,KAAK,KAAK,GAAG,IAAI,KAAK,KAAK,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;QACtE,IAAI,CAAC,SAAS,GAAG,KAAK,KAAK,GAAG,CAAC;QAC/B,MAAM,CAAC,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,0BAAM,GAAb;QACE,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,4BAAQ,GAAf;QACE,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;IAC5D,CAAC;IACH,gBAAC;AAAD,CAAC,AApDD,IAoDC;AApDY,iBAAS,YAoDrB,CAAA","sourcesContent":["/*\n * @file query/SortOrder.ts\n * Relution SDK\n *\n * Created by Thomas Beckmann on 22.06.2015\n * Copyright 2016 M-Way Solutions GmbH\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n/**\n * @module query\n */\n/** */\n\nimport * as _ from 'lodash';\n\n/**\n * defines a sort order of fields.\n *\n * Caution, member fields eventually are shared by multiple instances! You may mutate member\n * fields, but not the objects and arrays referenced by them.\n */\nexport class SortOrder {\n  /**\n   * ordered list of fields to sort on.\n   */\n  sortFields: SortField[];\n\n  /**\n   * default/copy constructor.\n   *\n   * @param other instance to optionally initialize an independent copy of.\n   */\n  public constructor(other?: SortOrder) {\n    this.sortFields = other && other.sortFields;\n  }\n\n  /**\n   * parses a JSON literal such as ['-rating', '+date', 'id'] into this instance.\n   *\n   * @param json data, such as ['-rating', '+date'].\n   * @return {SortOrder} this instance.\n   */\n  public fromJSON(json: string[]): SortOrder {\n    this.sortFields = new Array<SortField>(json.length);\n    for (var i = json.length - 1; i >= 0; --i) {\n      this.sortFields[i] = new SortField().fromJSON(json[i]);\n    }\n    return this;\n  }\n\n  /**\n   * formats a string such as '+name,-id'.\n   *\n   * @return {string} representation of SortOrder, may be the empty string when this is empty.\n     */\n  public toString():  string {\n    var str = '';\n    var length = this.sortFields.length;\n    for (var i = 0; i < length; ++i) {\n      if (i > 0) {\n        str += ',';\n      }\n      str += this.sortFields[i].toString();\n    }\n    return str;\n  }\n\n  /**\n   * combines an other instance such that this order is maintained by priority and equivalent elements are ordered by\n   * the other order.\n   *\n   * You may want to optimize after merging several instances.\n   *\n   * @param other order to merge into this as secondary.\n   */\n  public merge(other: SortOrder) {\n    this.sortFields = this.sortFields.concat(other.sortFields);\n  }\n\n  /**\n   * eliminates redundant sort fields that do not affect overall order.\n   */\n  public optimize() {\n    this.sortFields = _.uniqBy(this.sortFields, (sortField: SortField) => {\n      return sortField.name;\n    });\n  }\n}\n\nexport class SortField {\n  /**\n   * name/path of field to sort by.\n   */\n  name: string;\n  /**\n   * whether to sort ascending (true) or descending (false).\n   */\n  ascending: boolean;\n\n  /**\n   * default/copy constructor.\n   *\n   * @param other instance to optionally initialize an independent copy of.\n   */\n  public constructor(other?: SortField) {\n    if (other) {\n      this.name = other.name;\n      this.ascending = other.ascending;\n    }\n  }\n\n  /**\n   * parses a JSON literal such as '-rating' into this instance.\n   *\n   * @param json data, such as '-rating'.\n   * @return {SortField} this instance.\n   */\n  public fromJSON(json: string): SortField {\n    var order = json.length > 0 && json.charAt(0);\n    this.name = order === '+' || order === '-' ? json.substring(1) : json;\n    this.ascending = order !== '-';\n    return this;\n  }\n\n  /**\n   * formats a JSON literal such as 'name'.\n   *\n   * @return {string} JSON literal such as 'name'.\n   */\n  public toJSON(): string {\n    return this.ascending ? this.name : '-' + this.name;\n  }\n\n  /**\n   * formats a string such as '+name'.\n   *\n   * @return {string} such as '+name'.\n   */\n  public toString(): string {\n    return this.ascending ? '+' + this.name : '-' + this.name;\n  }\n}\n"]}