analytics/webcontent/bi/js/dashboard-analytics/features/dashboard/queryService/api/QueryDataItemSetAPI.js

"use strict";

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

/**
 * Licensed Materials - Property of IBM
 * IBM Business Analytics (C) Copyright IBM Corp. 2019, 2020
 * US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
 */

/**
 * @typedef {Object} CalculationInfo
 * @property {String} operator - operator of the calculation
 * @property {String[]} operands - list of operands of the calculation
 */

/**
 * @class QueryDataItemSetAPI
 * @hideconstructor
 * @classdesc API class for sets of Data Items - loosely, an abstraction of an edge or slot.
 * It holds Data Items which are unioned together, and Data Item Sets, which are nested.
 */
define([], function () {
	var QueryDataItemSetAPI = function () {
		function QueryDataItemSetAPI() {
			_classCallCheck(this, QueryDataItemSetAPI);
		}

		/**
   * Add a data item to this set
   * @param {DataItemAPI} dataItem
   */
		QueryDataItemSetAPI.prototype.addDataItem = function addDataItem() {};

		/**
   * Add an array of data items to this set
   * @param {DataItemAPI[]} dataItems
   */


		QueryDataItemSetAPI.prototype.addDataItemList = function addDataItemList() {};

		/**
   * Replace the existing dataItems with the new one.
   * @param {DataItemAPI[]} dataItems An array of {@DataItemAPI} to replace the existing one.
   */


		QueryDataItemSetAPI.prototype.setDataItemList = function setDataItemList() {};

		/**
   * Get all data items in this set
   * @return {DataItemAPI[]}
   */


		QueryDataItemSetAPI.prototype.getDataItemList = function getDataItemList() {};

		/**
   * @param {DataItemAPI[]} dataItems An array of one or more data items to initialize the QueryDataItemSetAPI with
   * @return {QueryDataItemSetAPI}
   */


		QueryDataItemSetAPI.prototype.createDataItemSet = function createDataItemSet() {};

		/**
   * Get all data item sets in this set
   * @return {QueryDataItemSetAPI[]}
   */


		QueryDataItemSetAPI.prototype.getDataItemSetList = function getDataItemSetList() {};

		/**
   * Get all data items in this set and its descendants
   * @return {QueryDataItemAPI[]}
   */


		QueryDataItemSetAPI.prototype.getAllDataItemsList = function getAllDataItemsList() {};

		/**
   * Return true if this dataItemSet contains facts.
   * @return {Boolean}
   */


		QueryDataItemSetAPI.prototype.isMeasureItemSet = function isMeasureItemSet() {};

		/**
   * Return true if this dataItemSet is nested (includes a non-empty dataItemSets member)
   * @return {Boolean}
   */


		QueryDataItemSetAPI.prototype.isNestedItemSet = function isNestedItemSet() {};

		/**
   * @return {String} - the constant summary data item name prefix (summary:)
   */


		QueryDataItemSetAPI.prototype.getSummaryItemPrefix = function getSummaryItemPrefix() {};

		/**
   * @return {Boolean} - true if this id represents a summary dataItem (starts with 'summary:')
   */


		QueryDataItemSetAPI.prototype.isSummaryItemId = function isSummaryItemId() {};

		/**
   * @function QueryDataItemSetAPI#addCalculation
   * Add calculation to a measure item set
   * @param {String} operator operator of the calculation
   * @param {String[]} dataItemIds dataItem operands of the calculation
   */


		QueryDataItemSetAPI.prototype.addCalculation = function addCalculation() {};

		/**
   * @function QueryDataItemSetAPI#getCalculationList
   * Get list of calculations of a measure item set
   * @param {String} [dataItemId] dataItem operand of the calculation. Returns all calculations if omitted.
   * @return {CalculationInfo[]} list of calculations
   */


		QueryDataItemSetAPI.prototype.getCalculationList = function getCalculationList() {};

		return QueryDataItemSetAPI;
	}();

	return QueryDataItemSetAPI;
});
//# sourceMappingURL=QueryDataItemSetAPI.js.map