IQSS / IQSS/dataverse

Feature Request: enable static OAI-PMH sets for the collection tree

Open
#9,344 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Harvesting
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request

When harvesting is enabled, all collections should be available for harvesting without creating a search first. This was discussed on the Google Group: https://groups.google.com/d/msgid/dataverse-community/e9ff1e51-ea37-4c8f-8fcc-3fb22b4dc886n%40googlegroups.com with @philippconzett @jggautier etc

The idea is to use the OAI-PMH set spec to express what collection is requested.

a setSpec -- a colon [:] separated list indicating the path from the root of the set hierarchy to the respective node. Each element in the list is a string consisting of any valid URI unreserved characters, which must not contain any colons [:]. Since a setSpec forms a unique identifier for the set within the repository, it must be unique for each set. Flat set organizations have only sets with setSpec that do not contain any colons [:].

First inspiration: create a set hierarchy starting with collections: being the root Dataverse collection and digging your path down the tree by separating with ":". Example: "collections:topcoll:subcoll:subsubcoll" Expressing the set with such a spec meaning results comprise only from datasets of the specified node (collection), no children. (Maybe include linked datasets).
If you want to go for a full subtree in a set, create a set as usual using the search function.

Second thoughts: as Dataverse is comprised of unique collection names and the "hierarchy" is just UI eyecandy, one might as well make all avail as "collections:xxx" as set spec. And then play around with sth. like "collections:xxx:all" to express the intent to include all subcollections in the response, too.

What kind of user is the feature intended for?
API User, Curator, Depositor

What inspired the request?
https://groups.google.com/d/msgid/dataverse-community/e9ff1e51-ea37-4c8f-8fcc-3fb22b4dc886n%40googlegroups.com

What existing behavior do you want changed?
There are no standard, default sets, but they might be useful.

Any brand new behavior do you want to add to Dataverse?
No, this is just an extension of what's already there.

Any related open or closed issues to this feature request?
This might be a part of IQSS/dataverse-pm#25

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing OAI-PMH harvesting and search-set behavior; this issue names no files or tests. Resolve the setSpec model first—collection-only paths versus an option including subcollections—then define acceptance for default collection sets and validate it against the linked discussion.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.