Interface RecordIDGenerator

All Known Implementing Classes:
UUIDGenerator
public interface RecordIDGenerator
A record-id generator.
Version:
$Revision$ $Date$
Author:
stack, gojomo

  • Method Details

    • getRecordID

      URI getRecordID()
      Returns:
      A URI that can serve as a record-id.

    • getQualifiedRecordID

      URI getQualifiedRecordID(Map<String,String> qualifiers)
      Parameters:
      qualifiers - Qualifiers to add.
      Returns:
      A URI qualified with passed qualifiers that can serve as a record-id, or, a new, unique record-id without qualifiers (if qualifiers not easily implemented using passed URI scheme).

    • getQualifiedRecordID

      URI getQualifiedRecordID(String key, String value)
      Parameters:
      key - Name of qualifier
      value - Value of qualifier
      Returns:
      A URI qualified with passed qualifiers that can serve as a record-id, or, a new, unique record-id without qualifiers (if qualifiers not easily implemented using passed URI scheme).

    • qualifyRecordID

      URI qualifyRecordID(URI recordId, Map<String,String> qualifiers)
      Append (or if already present, update) qualifiers to passed recordId. Use with caution. Guard against turning up a result that already exists. Use when writing a group of records inside a single transaction. How qualifiers are appended/updated varies with URI scheme. Its allowed that an invocation of this method does nought but call getRecordID(), returning a new URI unrelated to the passed recordId and passed qualifier.
      Parameters:
      recordId - URI to append qualifier to.
      qualifiers - Map of qualifier values keyed by qualifier name.
      Returns:
      New URI based off passed uri and passed qualifier.