ModelIdMapUtils
Utility class for manipulating and managing ModelIdMap objects. A ModelIdMap is a mapping of model identifiers (strings) to sets of local IDs (numbers). This class provides methods for joining, intersecting, cloning, adding, removing, and comparing ModelIdMap objects, as well as converting between ModelIdMap and plain JavaScript objects.
Methods
add()
staticadd(target,source,clone):void
Adds all entries from one ModelIdMap to another.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
target | ModelIdMap | undefined | The ModelIdMap to add to. |
source | ModelIdMap | undefined | The ModelIdMap to add from. |
clone | boolean | false | - |
Returns
void
clone()
staticclone(source):ModelIdMap
Creates a deep clone of a ModelIdMap.
Parameters
| Parameter | Type | Description |
|---|---|---|
source | ModelIdMap | The ModelIdMap to clone. |
Returns
A new ModelIdMap with the same model identifiers and localIds as the original.
fromRaw()
staticfromRaw(raw):ModelIdMap
Creates a ModelIdMap from a plain JavaScript object with array values.
Parameters
| Parameter | Type | Description |
|---|---|---|
raw | object | A plain JavaScript object where each key (model ID) maps to an array of local IDs. |
Returns
A ModelIdMap.
intersect()
staticintersect(maps):ModelIdMap
Creates a new ModelIdMap from the intersection of multiple ModelIdMaps.
Parameters
| Parameter | Type | Description |
|---|---|---|
maps | ModelIdMap[] | An array of ModelIdMaps. |
Returns
A new ModelIdMap containing only model identifiers and localIds present in all input maps.
isEmpty()
staticisEmpty(map):boolean
Checks if a ModelIdMap is empty.
Parameters
| Parameter | Type | Description |
|---|---|---|
map | ModelIdMap | The ModelIdMap to check. |
Returns
boolean
True if the ModelIdMap is empty, false otherwise.
isEqual()
staticisEqual(a,b):boolean
Checks if two ModelIdMaps are equal.
Parameters
| Parameter | Type | Description |
|---|---|---|
a | ModelIdMap | The first ModelIdMap. |
b | ModelIdMap | The second ModelIdMap. |
Returns
boolean
True if the ModelIdMaps are equal, false otherwise.
join()
staticjoin(maps):ModelIdMap
Creates a new ModelIdMap from the union of multiple ModelIdMaps.
Parameters
| Parameter | Type | Description |
|---|---|---|
maps | ModelIdMap[] | An array of ModelIdMaps to join. |
Returns
A new ModelIdMap containing all model identifiers and localIds from all input maps.
remove()
staticremove(target,source,clone):void
Remove all entries from one ModelIdMap to another.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
target | ModelIdMap | undefined | The ModelIdMap to subtract from. |
source | ModelIdMap | undefined | The ModelIdMap to subtract. |
clone | boolean | false | - |
Returns
void
toRaw()
statictoRaw(map):object
Converts a ModelIdMap into a plain JavaScript object with array values.
Parameters
| Parameter | Type | Description |
|---|---|---|
map | ModelIdMap | The ModelIdMap to convert. |
Returns
object
A plain JavaScript object where each key (model ID) maps to an array of local IDs.