Voile.OaiPmh (Voile v0.1.26)

Copy Markdown View Source

Context module for OAI-PMH (Open Archives Initiative Protocol for Metadata Harvesting) v2.0.

Implements the six OAI-PMH verbs:

  • Identify: Repository identification and configuration
  • ListMetadataFormats: Available metadata formats
  • ListSets: Collection hierarchy (sets)
  • ListIdentifiers: Item identifiers with datestamps
  • ListRecords: Full metadata records
  • GetRecord: Single record retrieval

Follows the guidelines at: https://www.openarchives.org/OAI/2.0/guidelines.htm

Summary

Functions

Handles the GetRecord verb. Returns a single metadata record by identifier.

Handles the Identify verb. Returns repository identification information.

Handles the ListIdentifiers verb. Returns item identifiers with datestamps and set membership. Supports selective harvesting by date and set.

Handles the ListMetadataFormats verb. Returns available metadata formats, optionally for a specific identifier.

Handles the ListRecords verb. Returns full metadata records for items. Supports selective harvesting by date and set.

Handles the ListSets verb. Returns the set structure (collections hierarchy). Supports resumption tokens for pagination.

Functions

get_record(identifier, metadata_prefix)

Handles the GetRecord verb. Returns a single metadata record by identifier.

identify(base_url)

Handles the Identify verb. Returns repository identification information.

list_identifiers(opts \\ [])

Handles the ListIdentifiers verb. Returns item identifiers with datestamps and set membership. Supports selective harvesting by date and set.

list_metadata_formats(identifier \\ nil)

Handles the ListMetadataFormats verb. Returns available metadata formats, optionally for a specific identifier.

list_records(opts \\ [])

Handles the ListRecords verb. Returns full metadata records for items. Supports selective harvesting by date and set.

list_sets(resumption_token \\ nil)

Handles the ListSets verb. Returns the set structure (collections hierarchy). Supports resumption tokens for pagination.