new ResourceMapStructureMutation()
Update package membership and links from metadata to documented data for
one Resource Map.
- Since:
- Source:
Methods
addAggregationTriples(pid, uri) → {ResourceMap}
Add the two RDF statements that make an object a package member:
`package --aggregates--> member` and
`member --isAggregatedBy--> package`.
Parameters:
| Name |
Type |
Description |
pid |
string
|
Member PID |
uri |
string
|
Member node URI |
- Source:
Returns:
Updated resource map
-
Type
-
ResourceMap
linkDocumentation(metadataPid, dataPid) → {ResourceMap}
Record in both directions that one metadata member documents a data
member.
Parameters:
| Name |
Type |
Description |
metadataPid |
string
|
Documenting metadata PID |
dataPid |
string
|
Documented member PID |
- Source:
Returns:
Updated resource map
-
Type
-
ResourceMap
removeMembers(pids) → {ResourceMap}
Remove package members and the managed relationships attached to their
exact RDF nodes.
Parameters:
| Name |
Type |
Description |
pids |
Array.<string>
|
Member PIDs to remove |
- Source:
Returns:
Updated resource map
-
Type
-
ResourceMap
replaceMember(oldPid, newPid) → {ResourceMap}
Change a package member's PID wherever managed package relationships use
it.
Parameters:
| Name |
Type |
Description |
oldPid |
string
|
Existing member PID |
newPid |
string
|
Replacement member PID |
- Source:
Throws:
-
When the source is missing or the replacement conflicts
-
-
Type
-
Error
Returns:
Updated resource map
-
Type
-
ResourceMap
setDocumentationLinks(links) → {ResourceMap}
Replace all links from metadata to documented data.
Parameters:
| Name |
Type |
Description |
links |
Array.<ResMapDocLink>
|
Desired documentation links |
- Source:
Throws:
-
When links is invalid or references non-members
-
-
Type
-
Error
Returns:
Updated resource map
-
Type
-
ResourceMap
setPackageStructure(pids, links) → {ResourceMap}
Set all package members and metadata documentation links in one edit. If
any step fails, the whole edit is rolled back.
Parameters:
| Name |
Type |
Description |
pids |
Array.<string>
|
Desired member PIDs |
links |
Array.<ResMapDocLink>
|
Desired documentation links |
- Source:
Throws:
-
When inputs are invalid or reference non-members
-
-
Type
-
Error
Returns:
Updated resource map
-
Type
-
ResourceMap
unlinkDocumentation(metadataPid, dataPid) → {ResourceMap}
Remove both RDF directions of a link from metadata to documented data.
Parameters:
| Name |
Type |
Description |
metadataPid |
string
|
Documenting metadata PID |
dataPid |
string
|
Documented member PID |
- Source:
Returns:
Updated resource map
-
Type
-
ResourceMap