Removes some (or all) of the mappings of the specified key in the element map with the specified identifier.
Note: The function removes associations of elements with the specified key only. The same elements may be associated with other keys in this map and those associations won't change.
Parameters:
elementMapId
The element map identifier.Note: When the element map with such an identifier does not exist, the generator raises an error.
key
The hash key
filterQuery
Specify a condition on the elements that are to be removed from the key mapping.When specified, this must be a boolean subquery created with
BooleanQuery()
function. The subquery is processed against each element currently associated with the key. If it returnstrue
, the element will be removed from the association with the key; iffalse
the element will be left. The tested element is passed as the generator context element.If this parameter is not specified (or
null
) all mappings of the specified key will be removed.
Returns:
The number of key/element associations removed
See Also:
removeElementByKey(), clearElementMap(),
putElementsByKey(), findElementsByKey(), checkElementsByKey()