@openui5/sap.ui.core 1.108.0 → 1.109.0

package/src/sap/ui/model/odata/v4/lib/_AggregationCache.js

@@ -41,6 +41,7 @@ sap.ui.define([
 	 *   Whether a grand total is needed
 	 *
 	 * @alias sap.ui.model.odata.v4.lib._AggregationCache
+	 * @borrows sap.ui.model.odata.v4.lib._CollectionCache#requestSideEffects as #requestSideEffects
 	 * @constructor
 	 * @extends sap.ui.model.odata.v4.lib._Cache
 	 * @private
@@ -73,6 +74,7 @@ sap.ui.define([
 			});
 		}
 		this.oFirstLevel = this.createGroupLevelCache(null, bHasGrandTotal || !!fnLeaves);
+		this.requestSideEffects = this.oFirstLevel.requestSideEffects; // @borrows ...
 		this.oGrandTotalPromise = undefined;
 		if (bHasGrandTotal) {
 			this.oGrandTotalPromise = new SyncPromise(function (resolve) {
@@ -132,31 +134,31 @@ sap.ui.define([
 
 		function addElement(oElement, i) {
 			var oOldElement = aElements[iOffset + i],
-				oParent,
+				oOtherElement,
 				sPredicate = _Helper.getPrivateAnnotation(oElement, "predicate");
 
 			if (oOldElement) { // check before overwriting
 				if (oOldElement === oElement) {
 					return;
 				}
-				oParent = _Helper.getPrivateAnnotation(oOldElement, "parent");
-				if (!oParent) {
-					throw new Error("Unexpected element");
-				}
-				if (oParent !== oCache
-						|| _Helper.getPrivateAnnotation(oOldElement, "index") !== iStart + i) {
-					throw new Error("Wrong placeholder");
-				}
+				_AggregationHelper
+					.beforeOverwritePlaceholder(oOldElement, oElement, oCache, iStart + i);
 			} else if (iOffset + i >= aElements.length) {
 				throw new Error("Array index out of bounds: " + (iOffset + i));
 			}
-			if (sPredicate in aElements.$byPredicate
-					&& aElements.$byPredicate[sPredicate] !== oElement) {
+			oOtherElement = aElements.$byPredicate[sPredicate];
+			if (oOtherElement && oOtherElement !== oElement
+					&& !(oOtherElement instanceof SyncPromise)) {
 				throw new Error("Duplicate predicate: " + sPredicate);
 			}
 
-			aElements[iOffset + i] = oElement;
-			aElements.$byPredicate[sPredicate] = oElement;
+			aElements.$byPredicate[sPredicate] = aElements[iOffset + i] = oElement;
+
+			if (oCache) {
+				// remember index & parent for #requestSideEffects
+				_Helper.setPrivateAnnotation(oElement, "index", iStart + i);
+				_Helper.setPrivateAnnotation(oElement, "parent", oCache);
+			}
 		}
 
 		if (iOffset < 0) {
@@ -169,6 +171,23 @@ sap.ui.define([
 		}
 	};
 
+	/**
+	 * Deletes the "$apply" system query option before side effects are requested.
+	 *
+	 * @param {object} mQueryOptions
+	 *   A modifiable map of key-value pairs representing the query string
+	 * @throws {Error}
+	 *   If no recursive hierarchy is used
+	 *
+	 * @see sap.ui.model.odata.v4.lib._CollectionCache#requestSideEffects
+	 */
+	_AggregationCache.prototype.beforeRequestSideEffects = function (mQueryOptions) {
+		if (!this.oAggregation.hierarchyQualifier) {
+			throw new Error("Missing recursive hierarchy");
+		}
+		delete mQueryOptions.$apply;
+	};
+
 	/**
 	 * Collapses the group node at the given path.
 	 *
@@ -195,20 +214,26 @@ sap.ui.define([
 			iCount += 1;
 		}
 
-		oCollapsed = _Helper.getPrivateAnnotation(oGroupNode, "collapsed");
+		oCollapsed = _AggregationHelper.getCollapsedObject(oGroupNode);
 		_Helper.updateAll(this.mChangeListeners, sGroupNodePath, oGroupNode, oCollapsed);
 
 		iDescendants = _Helper.getPrivateAnnotation(oGroupNode, "descendants");
 		if (iDescendants) { // => this.oAggregation.expandTo > 1
+			// Note: "descendants" refers to LimitedDescendantCountProperty and counts descendants
+			// within "top pyramid" only!
 			iGroupNodeLevel = this.oAggregation.expandTo;
 		}
 		while (i < aElements.length) {
 			if (aElements[i]["@$ui5.node.level"] <= iGroupNodeLevel) {
-				// Note: level 1 is used for placeholders of 1st level cache!
+				// Note: level 0 or 1 is used for initial placeholders of 1st level cache!
 				if (!iDescendants) {
 					break; // we've reached a sibling of the collapsed node
 				}
 				iDescendants -= 1;
+				if (aElements[i]["@$ui5.node.isExpanded"] === false) {
+					// skip descendants of manually collapsed node
+					iDescendants -= _Helper.getPrivateAnnotation(aElements[i], "descendants") || 0;
+				}
 			}
 			collapse(i);
 			i += 1;
@@ -275,7 +300,7 @@ sap.ui.define([
 		mQueryOptions.$count = true;
 		oCache = _Cache.create(this.oRequestor, this.sResourcePath, mQueryOptions, true);
 		oCache.calculateKeyPredicate = oAggregation.hierarchyQualifier
-			? _AggregationCache.calculateKeyPredicateRH.bind(null, oGroupNode)
+			? _AggregationCache.calculateKeyPredicateRH.bind(null, oGroupNode, oAggregation)
 			: _AggregationCache.calculateKeyPredicate.bind(null, oGroupNode, aGroupBy,
 				aAllProperties, bLeaf, bTotal);
 
@@ -305,6 +330,7 @@ sap.ui.define([
 				: vGroupNodeOrPath,
 			iIndex,
 			aSpliced = _Helper.getPrivateAnnotation(oGroupNode, "spliced"),
+			bStale,
 			that = this;
 
 		if (vGroupNodeOrPath !== oGroupNode) {
@@ -315,6 +341,7 @@ sap.ui.define([
 
 		if (aSpliced) {
 			_Helper.deletePrivateAnnotation(oGroupNode, "spliced");
+			bStale = aSpliced.$stale;
 
 			iIndex = aElements.indexOf(oGroupNode) + 1;
 			// insert aSpliced at iIndex
@@ -323,20 +350,21 @@ sap.ui.define([
 
 			iCount = aSpliced.length;
 			this.aElements.$count = aElements.$count + iCount;
-			aSpliced.forEach(function (oElement) {
+			aSpliced.forEach(function (oElement, i) {
 				var sPredicate = _Helper.getPrivateAnnotation(oElement, "predicate");
 
-				if (sPredicate) {
-					that.aElements.$byPredicate[sPredicate] = oElement;
-					if (_Helper.hasPrivateAnnotation(oElement, "expanding")) {
-						_Helper.deletePrivateAnnotation(oElement, "expanding");
-						iCount += that.expand(_GroupLock.$cached, oElement).getResult();
+				if (!_Helper.hasPrivateAnnotation(oElement, "placeholder")) {
+					if (bStale) {
+						that.replaceByPlaceholder(iIndex + i, oElement, sPredicate);
+					} else {
+						that.aElements.$byPredicate[sPredicate] = oElement;
+						if (_Helper.hasPrivateAnnotation(oElement, "expanding")) {
+							_Helper.deletePrivateAnnotation(oElement, "expanding");
+							iCount += that.expand(_GroupLock.$cached, oElement).getResult();
+						}
 					}
 				}
 			});
-			_Helper.updateAll(that.mChangeListeners, vGroupNodeOrPath, oGroupNode,
-				{"@$ui5.node.groupLevelCount" :
-					_Helper.getPrivateAnnotation(oGroupNode, "groupLevelCount")});
 			return SyncPromise.resolve(iCount);
 		}
 
@@ -350,7 +378,7 @@ sap.ui.define([
 		return oCache.read(0, this.iReadLength, 0, oGroupLock).then(function (oResult) {
 			var iIndex = that.aElements.indexOf(oGroupNode) + 1,
 				iLevel = oGroupNode["@$ui5.node.level"],
-				oSubtotals = _Helper.getPrivateAnnotation(oGroupNode, "collapsed"),
+				oSubtotals = _AggregationHelper.getCollapsedObject(oGroupNode),
 				// Note: there is at least one key for "@$ui5.node.isExpanded"; there are more keys
 				// if and only if subtotals are actually being requested and only or also shown at
 				// bottom
@@ -369,6 +397,10 @@ sap.ui.define([
 			}
 
 			iCount = oResult.value.$count;
+			if (_Helper.hasPrivateAnnotation(oGroupNode, "groupLevelCount")
+				&& _Helper.getPrivateAnnotation(oGroupNode, "groupLevelCount") !== iCount) {
+				throw new Error("Unexpected structural change: groupLevelCount");
+			}
 			_Helper.setPrivateAnnotation(oGroupNode, "groupLevelCount", iCount);
 			_Helper.updateAll(that.mChangeListeners, vGroupNodeOrPath, oGroupNode,
 				{"@$ui5.node.groupLevelCount" : iCount});
@@ -406,7 +438,7 @@ sap.ui.define([
 		}, function (oError) {
 			// Note: typeof vGroupNodeOrPath === "string"
 			_Helper.updateAll(that.mChangeListeners, vGroupNodeOrPath, oGroupNode,
-				_Helper.getPrivateAnnotation(oGroupNode, "collapsed"));
+				_AggregationHelper.getCollapsedObject(oGroupNode));
 
 			throw oError;
 		});
@@ -437,6 +469,8 @@ sap.ui.define([
 	 */
 	_AggregationCache.prototype.fetchValue = function (oGroupLock, sPath, fnDataRequested,
 			oListener) {
+		var that = this;
+
 		if (sPath === "$count") {
 			if (this.oLeavesPromise) {
 				return this.oLeavesPromise;
@@ -451,9 +485,45 @@ sap.ui.define([
 			return this.oFirstLevel.fetchValue(oGroupLock, sPath, fnDataRequested, oListener);
 		}
 
-		this.registerChangeListener(sPath, oListener);
+		return SyncPromise.resolve(this.aElements.$byPredicate[sPath.split("/")[0]])
+			.then(function () {
+				that.registerChangeListener(sPath, oListener);
+
+				return that.drillDown(that.aElements, sPath, oGroupLock);
+			});
+	};
+
+	/**
+	 * Determines the list of visible elements determined by the given predicates. All other
+	 * elements are replaced by placeholders (lazily).
+	 *
+	 * @param {string[]} aPredicates
+	 *   The key predicates of the elements to request side effects for
+	 * @returns {object[]}
+	 *   The list of visible elements
+	 *
+	 * @private
+	 * @see sap.ui.model.odata.v4.lib._CollectionCache#filterVisibleElements
+	 * @see sap.ui.model.odata.v4.lib._CollectionCache#requestSideEffects
+	 */
+	_AggregationCache.prototype.filterVisibleElements = function (aPredicates) {
+		var mPredicates = {}, // a set of the predicates (as map to true) to speed up the search
+			that = this;
+
+		aPredicates.forEach(function (sPredicate) {
+			mPredicates[sPredicate] = true;
+		});
+
+		return this.aElements.filter(function (oElement, i) {
+			var sPredicate = _Helper.getPrivateAnnotation(oElement, "predicate");
+
+			if (mPredicates[sPredicate]) {
+				_AggregationHelper.markSplicedStale(oElement);
+				return true; // keep and request
+			}
 
-		return this.drillDown(this.aElements, sPath, oGroupLock);
+			that.replaceByPlaceholder(i, oElement, sPredicate);
+		});
 	};
 
 	/**
@@ -476,7 +546,7 @@ sap.ui.define([
 		}
 
 		aAllElements = this.aElements.map(function (oElement) {
-			return _Helper.hasPrivateAnnotation(oElement, "parent") ? undefined : oElement;
+			return _Helper.hasPrivateAnnotation(oElement, "placeholder") ? undefined : oElement;
 		});
 		aAllElements.$count = this.aElements.$count;
 
@@ -516,6 +586,14 @@ sap.ui.define([
 		return this.sDownloadUrl;
 	};
 
+	/**
+	 * @override
+	 * @see sap.ui.model.odata.v4.lib._Cache#isDeletingInOtherGroup
+	 */
+	_AggregationCache.prototype.isDeletingInOtherGroup = function (_sGroupId) {
+		return false;
+	};
+
 	/**
 	 * Returns a promise to be resolved with an OData object for a range of the requested data.
 	 *
@@ -525,11 +603,7 @@ sap.ui.define([
 	 *   The length of the range; <code>Infinity</code> is supported
 	 * @param {number} iPrefetchLength
 	 *   The number of rows to read before and after the given range; with this it is possible to
-	 *   prefetch data for a paged access. The cache ensures that at least half the prefetch length
-	 *   is available left and right of the requested range without a further request. If data is
-	 *   missing on one side, the full prefetch length is added at this side.
-	 *   <code>Infinity</code> is supported. In case server-driven paging (@odata.nextLink) has been
-	 *   encountered before, this parameter is ignored.
+	 *   prefetch data for a paged access. <code>Infinity</code> is supported.
 	 * @param {sap.ui.model.odata.v4.lib._GroupLock} oGroupLock
 	 *   A lock for the group to associate the requests with
 	 * @param {function} [fnDataRequested]
@@ -540,8 +614,7 @@ sap.ui.define([
 	 *   "@odata.context" and the rows as an array in the property <code>value</code>, enhanced
 	 *   with a number property <code>$count</code> representing the element count on server-side;
 	 *   <code>$count</code> may be <code>undefined</code>, but not <code>Infinity</code>). If an
-	 *   HTTP request fails, the error from the _Requestor is returned and the requested range is
-	 *   reset to <code>undefined</code>.
+	 *   HTTP request fails, the error from the _Requestor is returned.
 	 *   The promise is rejected if a conflicting {@link #collapse} happens before the response
 	 *   arrives, in this case the error has the property <code>canceled</code> with value
 	 *   <code>true</code>.
@@ -554,12 +627,12 @@ sap.ui.define([
 	_AggregationCache.prototype.read = function (iIndex, iLength, iPrefetchLength, oGroupLock,
 			fnDataRequested) {
 		var oCurrentParent,
+			oElement,
 			iFirstLevelIndex = iIndex,
 			iFirstLevelLength = iLength,
 			oGapParent,
 			iGapStart,
-			bHasGrandTotal = !!this.oGrandTotalPromise,
-			bHasGrandTotalAtTop = bHasGrandTotal
+			bHasGrandTotalAtTop = this.oGrandTotalPromise
 				&& this.oAggregation.grandTotalAtBottomOnly !== true,
 			aReadPromises = [],
 			i, n,
@@ -573,47 +646,9 @@ sap.ui.define([
 		 * @param {number} iGapEnd end of gap, exclusive
 		 */
 		function readGap(iGapStart, iGapEnd) {
-			var oCache = oGapParent,
-				mQueryOptions = oGapParent.getQueryOptions(),
-				iStart = _Helper.getPrivateAnnotation(that.aElements[iGapStart], "index"),
-				oStartElement = that.aElements[iGapStart];
-
-			if (mQueryOptions.$count) { // $count not needed anymore, 1st read was done by #expand
-				delete mQueryOptions.$count;
-				oGapParent.setQueryOptions(mQueryOptions, true);
-			}
-
 			aReadPromises.push(
-				oGapParent.read(iStart, iGapEnd - iGapStart, 0, oGroupLock.getUnlockedCopy(),
-						fnDataRequested)
-					.then(function (oResult) {
-						var bGapHasMoved = false,
-							oError;
-
-						// Note: aElements[iGapStart] may have changed by a parallel operation
-						if (oStartElement !== that.aElements[iGapStart]
-								&& oResult.value[0] !== that.aElements[iGapStart]) {
-							// start of the gap has moved meanwhile
-							bGapHasMoved = true;
-							iGapStart = that.aElements.indexOf(oStartElement);
-							if (iGapStart < 0) {
-								iGapStart = that.aElements.indexOf(oResult.value[0]);
-								if (iGapStart < 0) {
-									oError = new Error("Collapse before read has finished");
-									oError.canceled = true;
-									throw oError;
-								}
-							}
-						}
-
-						that.addElements(oResult.value, iGapStart, oCache, iStart);
-
-						if (bGapHasMoved) {
-							oError = new Error("Collapse or expand before read has finished");
-							oError.canceled = true;
-							throw oError;
-						}
-					}));
+				that.readGap(oGapParent, iGapStart, iGapEnd, oGroupLock.getUnlockedCopy(),
+					fnDataRequested));
 		}
 
 		if (bHasGrandTotalAtTop && !iIndex && iLength === 1) {
@@ -625,7 +660,9 @@ sap.ui.define([
 			return this.oGrandTotalPromise.then(function (oGrandTotal) {
 				return {value : [oGrandTotal]};
 			});
-		} else if (this.aElements.$count === undefined) {
+		}
+
+		if (this.aElements.$count === undefined) {
 			this.iReadLength = iLength + iPrefetchLength;
 			if (bHasGrandTotalAtTop) { // account for grand total row at top
 				if (iFirstLevelIndex) {
@@ -634,57 +671,15 @@ sap.ui.define([
 					iFirstLevelLength -= 1;
 				}
 			}
-
 			aReadPromises.push(
-				this.oFirstLevel.read(iFirstLevelIndex, iFirstLevelLength, iPrefetchLength,
-						oGroupLock, fnDataRequested)
-					.then(function (oResult) {
-						// Note: this code must be idempotent, it might well run twice!
-						var oGrandTotal,
-							oGrandTotalCopy,
-							iOffset = 0, // offset for 1st level data rows
-							j;
-
-						that.aElements.length = that.aElements.$count = oResult.value.$count;
-
-						if (bHasGrandTotal) {
-							that.aElements.$count += 1;
-							that.aElements.length += 1;
-							oGrandTotal = that.oGrandTotalPromise.getResult();
-
-							switch (that.oAggregation.grandTotalAtBottomOnly) {
-								case false: // top & bottom
-									iOffset = 1;
-									that.aElements.$count += 1;
-									that.aElements.length += 1;
-									that.addElements(oGrandTotal, 0);
-									oGrandTotalCopy
-										= _Helper.getPrivateAnnotation(oGrandTotal, "copy");
-									that.addElements(oGrandTotalCopy, that.aElements.length - 1);
-									break;
-
-								case true: // bottom
-									that.addElements(oGrandTotal, that.aElements.length - 1);
-									break;
-
-								default: // top
-									iOffset = 1;
-									that.addElements(oGrandTotal, 0);
-							}
-						}
-
-						that.addElements(oResult.value, iFirstLevelIndex + iOffset,
-							that.oFirstLevel, iFirstLevelIndex);
-						for (j = 0; j < that.aElements.$count; j += 1) {
-							if (!that.aElements[j]) {
-								that.aElements[j] = _AggregationHelper.createPlaceholder(1,
-									j - iOffset, that.oFirstLevel);
-							}
-						}
-					}));
+				this.readFirst(iFirstLevelIndex, iFirstLevelLength, iPrefetchLength,
+					oGroupLock, fnDataRequested));
 		} else {
 			for (i = iIndex, n = Math.min(iIndex + iLength, this.aElements.length); i < n; i += 1) {
-				oCurrentParent = _Helper.getPrivateAnnotation(this.aElements[i], "parent");
+				oElement = this.aElements[i];
+				oCurrentParent = _Helper.hasPrivateAnnotation(oElement, "placeholder")
+					? _Helper.getPrivateAnnotation(oElement, "parent")
+					: undefined;
 				if (oCurrentParent !== oGapParent) {
 					if (iGapStart !== undefined) { // end of gap
 						readGap(iGapStart, i);
@@ -694,6 +689,12 @@ sap.ui.define([
 						iGapStart = i;
 						oGapParent = oCurrentParent;
 					}
+				} else if (iGapStart !== undefined
+						&& _Helper.getPrivateAnnotation(oElement, "index")
+							!== _Helper.getPrivateAnnotation(this.aElements[i - 1], "index") + 1) {
+					// Note: w/ side effect, indices might not be consecutive => split gap
+					readGap(iGapStart, i);
+					iGapStart = i;
 				}
 			}
 			if (iGapStart !== undefined) { // gap at end
@@ -711,6 +712,159 @@ sap.ui.define([
 		});
 	};
 
+	/**
+	 * Returns a promise to be resolved with an OData object for the first range of data requested.
+	 *
+	 * @param {number} iStart
+	 *   The start index of the range
+	 * @param {number} iLength
+	 *   The length of the range; <code>Infinity</code> is supported
+	 * @param {number} iPrefetchLength
+	 *   The number of rows to read before and after the given range; with this it is possible to
+	 *   prefetch data for a paged access. code>Infinity</code> is supported.
+	 * @param {sap.ui.model.odata.v4.lib._GroupLock} oGroupLock
+	 *   A lock for the group to associate the requests with
+	 * @param {function} [fnDataRequested]
+	 *   The function is called just before a back-end request is sent.
+	 *   If no back-end request is needed, the function is not called.
+	 * @returns {sap.ui.base.SyncPromise}
+	 *   A promise resolving without a defined result when the read is finished, or rejecting in
+	 *   case of an error
+	 * @throws {Error} If given index or length is less than 0
+	 *
+	 * @private
+	 */
+	_AggregationCache.prototype.readFirst = function (iStart, iLength, iPrefetchLength, oGroupLock,
+			fnDataRequested) {
+		var that = this;
+
+		return this.oFirstLevel.read(iStart, iLength, iPrefetchLength, oGroupLock, fnDataRequested)
+			.then(function (oResult) {
+				// Note: this code must be idempotent, it might well run twice!
+				var oGrandTotal,
+					oGrandTotalCopy,
+					iOffset = 0, // offset for 1st level data rows
+					j;
+
+				that.aElements.length = that.aElements.$count = oResult.value.$count;
+
+				if (that.oGrandTotalPromise) {
+					that.aElements.$count += 1;
+					that.aElements.length += 1;
+					oGrandTotal = that.oGrandTotalPromise.getResult();
+
+					switch (that.oAggregation.grandTotalAtBottomOnly) {
+						case false: // top & bottom
+							iOffset = 1;
+							that.aElements.$count += 1;
+							that.aElements.length += 1;
+							that.addElements(oGrandTotal, 0);
+							oGrandTotalCopy
+								= _Helper.getPrivateAnnotation(oGrandTotal, "copy");
+							that.addElements(oGrandTotalCopy, that.aElements.length - 1);
+							break;
+
+						case true: // bottom
+							that.addElements(oGrandTotal, that.aElements.length - 1);
+							break;
+
+						default: // top
+							iOffset = 1;
+							that.addElements(oGrandTotal, 0);
+					}
+				}
+
+				that.addElements(oResult.value, iStart + iOffset, that.oFirstLevel, iStart);
+				for (j = 0; j < that.aElements.$count; j += 1) {
+					if (!that.aElements[j]) {
+						that.aElements[j] = _AggregationHelper.createPlaceholder(
+							that.oAggregation.expandTo > 1 ? /*don't know*/0 : 1,
+							j - iOffset, that.oFirstLevel);
+					}
+				}
+			});
+	};
+
+	/**
+	 * Reads the given gap from the given cache and replaces the gap with the read's result.
+	 *
+	 * @param {sap.ui.model.odata.v4.lib._CollectionCache} oCache
+	 *   The collection cache to read data from
+	 * @param {number} iStart
+	 *   Start of gap, inclusive
+	 * @param {number} iEnd
+	 *   End of gap, exclusive
+	 * @param {sap.ui.model.odata.v4.lib._GroupLock} oGroupLock
+	 *   A lock for the group to associate the requests with
+	 * @param {function} [fnDataRequested]
+	 *   The function is called just before a back-end request is sent.
+	 *   If no back-end request is needed, the function is not called.
+	 * @returns {sap.ui.base.SyncPromise}
+	 *   A promise resolving without a defined result when the read is finished, or rejecting in
+	 *   case of an error
+	 * @throws {Error} If index of placeholder at start of gap is less than 0, or if end of gap is
+	 *   before start
+	 *
+	 * @private
+	 */
+	_AggregationCache.prototype.readGap = function (oCache, iStart, iEnd, oGroupLock,
+			fnDataRequested) {
+		var sPredicate,
+			oPromise,
+			mQueryOptions = oCache.getQueryOptions(),
+			iIndex = _Helper.getPrivateAnnotation(this.aElements[iStart], "index"),
+			oStartElement = this.aElements[iStart],
+			i,
+			that = this;
+
+		if (mQueryOptions.$count) { // $count not needed anymore, 1st read was done by #expand
+			delete mQueryOptions.$count;
+			oCache.setQueryOptions(mQueryOptions, true);
+		}
+
+		oPromise = oCache.read(iIndex, iEnd - iStart, 0, oGroupLock, fnDataRequested)
+			.then(function (oResult) {
+				// Note: this code must be idempotent, it might well run twice!
+				var bGapHasMoved = false,
+					oError;
+
+				// Note: aElements[iGapStart] may have changed by a parallel operation
+				if (oStartElement !== that.aElements[iStart]
+						&& oResult.value[0] !== that.aElements[iStart]) {
+					// start of the gap has moved meanwhile
+					bGapHasMoved = true;
+					iStart = that.aElements.indexOf(oStartElement);
+					if (iStart < 0) {
+						iStart = that.aElements.indexOf(oResult.value[0]);
+						if (iStart < 0) {
+							oError = new Error("Collapse before read has finished");
+							oError.canceled = true;
+							throw oError;
+						}
+					}
+				}
+
+				that.addElements(oResult.value, iStart, oCache, iIndex);
+
+				if (bGapHasMoved) {
+					oError = new Error("Collapse or expand before read has finished");
+					oError.canceled = true;
+					throw oError;
+				}
+			});
+		if (oPromise.isPending()) {
+			for (i = iStart; i < iEnd; i += 1) {
+				sPredicate = _Helper.getPrivateAnnotation(this.aElements[i], "predicate");
+
+				if (sPredicate) {
+					this.aElements.$byPredicate[sPredicate] = oPromise;
+				}
+			}
+		}
+
+		return oPromise;
+	};
+
 	/**
 	 * Refreshes the kept-alive elements. Nothing to do here, we have no kept-alive elements.
 	 *
@@ -719,6 +873,35 @@ sap.ui.define([
 	 */
 	_AggregationCache.prototype.refreshKeptElements = function () {};
 
+	/**
+	 * Replaces the given element, which is at the given position and has the given predicate, with
+	 * a placeholder which keeps all private annotations. The original element is removed from its
+	 * corresponding cache and must not be used any longer.
+	 *
+	 * @param {number} iIndex - Its index
+	 * @param {object} oElement - An element
+	 * @param {string} sPredicate - Its predicate
+	 *
+	 * @private
+	 */
+	_AggregationCache.prototype.replaceByPlaceholder = function (iIndex, oElement, sPredicate) {
+		if (_Helper.hasPrivateAnnotation(oElement, "placeholder")) {
+			return;
+		}
+
+		_AggregationHelper.markSplicedStale(oElement);
+		this.aElements[iIndex] = {
+			"@$ui5._" : Object.assign(oElement["@$ui5._"], {placeholder : true}),
+			"@$ui5.node.isExpanded" : oElement["@$ui5.node.isExpanded"],
+			"@$ui5.node.level" : oElement["@$ui5.node.level"]
+		};
+		delete this.aElements.$byPredicate[sPredicate];
+
+		// drop original element from its cache's collection
+		_Helper.getPrivateAnnotation(oElement, "parent")
+			.drop(_Helper.getPrivateAnnotation(oElement, "index"), sPredicate);
+	};
+
 	/**
 	 * Returns the cache's URL.
 	 *
@@ -805,6 +988,9 @@ sap.ui.define([
 	 *
 	 * @param {object} [oGroupNode]
 	 *   The group node or <code>undefined</code> for an element of the first level cache
+	 * @param {object} oAggregation
+	 *   An object holding the information needed for a recursive hierarchy; must already be
+	 *   normalized by {@link _AggregationHelper.buildApply4Hierarchy}
 	 * @param {object} oElement
 	 *   The element for which to calculate the key predicate
 	 * @param {object} mTypeForMetaPath
@@ -817,17 +1003,19 @@ sap.ui.define([
 	 * @public
 	 */
 	// @override sap.ui.model.odata.v4.lib._Cache#calculateKeyPredicate
-	_AggregationCache.calculateKeyPredicateRH = function (oGroupNode, oElement, mTypeForMetaPath,
-			sMetaPath) {
-		var iLevel = 1,
+	_AggregationCache.calculateKeyPredicateRH = function (oGroupNode, oAggregation, oElement,
+			mTypeForMetaPath, sMetaPath) {
+		var sDistanceFromRootProperty = oAggregation.$DistanceFromRootProperty,
+			sDrillStateProperty = oAggregation.$DrillStateProperty,
 			bIsExpanded,
+			iLevel = 1,
+			sLimitedDescendantCountProperty = oAggregation.$LimitedDescendantCountProperty,
 			sPredicate = _Helper.getKeyPredicate(oElement, sMetaPath, mTypeForMetaPath);
 
 		_Helper.setPrivateAnnotation(oElement, "predicate", sPredicate);
-		switch (oElement.DrillState) {
+		switch (oElement[sDrillStateProperty]) {
 			case "expanded":
 				bIsExpanded = true;
-				_AggregationHelper.getOrCreateExpandedObject({/*oAggregation*/}, oElement);
 				break;
 
 			case "collapsed":
@@ -841,17 +1029,19 @@ sap.ui.define([
 		}
 		if (oGroupNode) {
 			iLevel = oGroupNode["@$ui5.node.level"] + 1;
-		} else if (oElement.DistanceFromRoot) {
-			iLevel = oElement.DistanceFromRoot + 1;
+		} else if (oElement[sDistanceFromRootProperty]) { // Edm.Int64
+			iLevel = parseInt(oElement[sDistanceFromRootProperty]) + 1;
 		}
 		// set the node values
 		_AggregationHelper.setAnnotations(oElement, bIsExpanded, /*bIsTotal*/undefined, iLevel);
-		if (oElement.DescendantCount) {
-			_Helper.setPrivateAnnotation(oElement, "descendants", oElement.DescendantCount);
+		if (oElement[sLimitedDescendantCountProperty]
+			&& oElement[sLimitedDescendantCountProperty] !== "0") { // Edm.Int64
+			_Helper.setPrivateAnnotation(oElement, "descendants",
+				parseInt(oElement[sLimitedDescendantCountProperty]));
 		}
-		delete oElement.DescendantCount;
-		delete oElement.DistanceFromRoot;
-		delete oElement.DrillState;
+		delete oElement[sDistanceFromRootProperty];
+		delete oElement[sDrillStateProperty];
+		delete oElement[sLimitedDescendantCountProperty];
 
 		return sPredicate;
 	};
@@ -863,7 +1053,8 @@ sap.ui.define([
 	 * @param {sap.ui.model.odata.v4.lib._Requestor} oRequestor
 	 *   The requestor
 	 * @param {string} sResourcePath
-	 *   A resource path relative to the service URL; it must not contain a query string<br>
+	 *   A resource path relative to the service URL; it must not contain a query string
+	 *   <br>
 	 *   Example: Products
 	 * @param {string} sDeepResourcePath
 	 *   The deep resource path to be used to build the target path for bound messages
@@ -874,7 +1065,8 @@ sap.ui.define([
 	 * @param {object} mQueryOptions
 	 *   A map of key-value pairs representing the query string, the value in this pair has to
 	 *   be a string or an array of strings; if it is an array, the resulting query string
-	 *   repeats the key for each array value.<br>
+	 *   repeats the key for each array value.
+	 *   <br>
 	 *   Examples:
 	 *   {foo : "bar", "bar" : "baz"} results in the query string "foo=bar&bar=baz"
 	 *   {foo : ["bar", "baz"]} results in the query string "foo=bar&foo=baz"