Class: DataPackageMembers

DataPackageMembers()

new DataPackageMembers()

Store data package members and provide PID and format based lookups.

Since:

2.39.0

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 22

Methods

add(memberInfo, optionsopt) → {DataPackageMembers}

Add or merge member info into the collection.

Parameters:

Name Type Attributes Description

memberInfo object | Array.<object> One or more member info objects

options

object

Add options

Properties

Name	Type	Attributes	Description
`merge`	boolean	<optional>	Merge into an existing member
`sources`	Array.<string>	<optional>	Source tags for added/merged data
`onlyExisting`	boolean	<optional>	When true, only merge into members that already exist; never create new members. Used to enrich an authoritative member set (for example, from the index) without adding members that are not aggregated

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 57

Returns:

This collection

Type: DataPackageMembers

get(pid) → {DataPackageMember|null}

Return a member by PID.

Parameters:

Name	Type	Description
`pid`	string	Member PID

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 99

Returns:

Matching member, or null

Type: DataPackageMember | null

getActiveMembers() → {Array.<DataPackageMember>}

Return members not marked for removal.

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 180

Returns:

Active members

Type: Array.<DataPackageMember>

getData() → {Array.<DataPackageMember>}

Return data members.

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 134

Returns:

Data members

Type: Array.<DataPackageMember>

getFromSource(source) → {Array.<DataPackageMember>}

Return members loaded from a manifest source.

Parameters:

Name	Type	Description
`source`	string	Source name

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 143

Returns:

Matching members

Type: Array.<DataPackageMember>

getMembers(pids) → {Array.<DataPackageMember>}

Return members whose PIDs are in the requested set.

Parameters:

Name	Type	Description
`pids`	Array.<string>	Member PIDs

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 109

Returns:

Matching members

Type: Array.<DataPackageMember>

getMetadata() → {Array.<DataPackageMember>}

Return metadata members.

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 126

Returns:

Metadata members

Type: Array.<DataPackageMember>

getResourceMaps() → {Array.<DataPackageMember>}

Return resource map members.

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 118

Returns:

Resource map members

Type: Array.<DataPackageMember>

purgeRemoved() → {DataPackageMembers}

Delete members marked for removal.

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 200

Returns:

This collection

Type: DataPackageMembers

remove(pid) → {DataPackageMembers}

Remove a member by PID.

Parameters:

Name	Type	Description
`pid`	string	Member PID

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 84

Returns:

This collection

Type: DataPackageMembers

replacePid(oldPid, newPid) → {DataPackageMember}

Atomically change a member's desired PID and lookup map key.

Parameters:

Name	Type	Description
`oldPid`	string	Current PID
`newPid`	string	Desired replacement PID

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 154

Throws:

When a PID is invalid, missing, or already in use
Type Error

Returns:

Rekeyed member

Type: DataPackageMember

retain(pids) → {DataPackageMembers}

Remove every member not included in the authoritative PID set.

Parameters:

Name	Type	Description
`pids`	Array.<string>	PIDs to retain

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 210

Returns:

This collection

Type: DataPackageMembers

toArray() → {Array.<DataPackageMember>}

Return a copy of the member array.

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 226

Returns:

Package members

Type: Array.<DataPackageMember>

DataPackageMembers(objectFormatsopt, packageEventsopt)

new DataPackageMembers(objectFormatsopt, packageEventsopt)

Create a member collection.

Parameters:

Name	Type	Attributes	Default	Description
`objectFormats`	ObjectFormats \| null	<optional>	null	Object format collection
`packageEvents`	object \| null	<optional>	null	Owning package event emitter

Source:

src/js/models/dataPackage/DataPackageMembers.js, line 34

Methods

add(memberInfo, optionsopt) → {DataPackageMembers}

Add or merge member info into the collection.

Parameters:

Name Type Attributes Description

memberInfo object | Array.<object> One or more member info objects

options

object

Add options

Properties

Name	Type	Attributes	Description
`merge`	boolean	<optional>	Merge into an existing member
`sources`	Array.<string>	<optional>	Source tags for added/merged data
`onlyExisting`	boolean	<optional>	When true, only merge into members that already exist; never create new members. Used to enrich an authoritative member set (for example, from the index) without adding members that are not aggregated