rdapit.pidsystem

Interface IIdentifierSystem

All Known Subinterfaces:

ITypingService

All Known Implementing Classes:

HandleSystemRESTAdapter, TypingService

public interface IIdentifierSystem

Main abstraction interface towards the identifier system containing registered identifiers and associated state information.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deletePID(String pid) Remove the given PID.
boolean	isIdentifierRegistered(String pid) Checks whether the given PID is already registered.
PIDInformation	queryAllProperties(String pid) Queries all properties from the given PID, independent of types.
PIDInformation	queryByType(String pid, TypeDefinition typeDefinition) Queries all properties of a given type available from the given PID.
String	queryProperty(String pid, PropertyDefinition propertyDefinition) Queries a single property from the given PID.
String	registerPID(Map<String,String> properties) Registers a new PID with given property values.

Method Detail

isIdentifierRegistered

boolean isIdentifierRegistered(String pid)
                               throws IOException

Checks whether the given PID is already registered.

Parameters:

pid -

Returns:

True or false

Throws:

IOException

queryAllProperties

PIDInformation queryAllProperties(String pid)
                                  throws IOException

Queries all properties from the given PID, independent of types.

Parameters:

pid -

Returns:

a PID information record with property identifiers mapping to values. The property names will be empty strings. Contains all property values present in the record of the given PID. If the pid is not registered, the method returns null.

Throws:

IOException

queryProperty

String queryProperty(String pid,
                   PropertyDefinition propertyDefinition)
                     throws IOException

Queries a single property from the given PID.

Parameters:

pid -

propertyDefinition -

Returns:

the property value or null if there is no property of given name defined in this PID record.

Throws:

IOException

registerPID

String registerPID(Map<String,String> properties)
                   throws IOException

Registers a new PID with given property values. The method decides on a PID name automatically, guaranteeing its uniqueness and preventing failure due to potential overwrites.

Parameters:

properties - A simple dictionary with string keys and string values that contains the initial PID record.

Returns:

the name of the registered PID

Throws:

IOException

queryByType

PIDInformation queryByType(String pid,
                         TypeDefinition typeDefinition)
                           throws IOException

Queries all properties of a given type available from the given PID. If optional properties are present, they will be returned as well. If there are mandatory properties missing (i.e. the record of the given PID does not fully conform to the type), the method will NOT fail but simply return only those properties that are present.

Parameters:

pid -

typeDefinition -

Returns:

a PID information record with property identifiers mapping to values. The property names will not be available (empty Strings). Contains all property values present in the record of the given PID that are also specified by the type (mandatory or optional). If the pid is not registered, the method returns null.

Throws:

IOException

deletePID

boolean deletePID(String pid)

Remove the given PID. Obviously, this method is only for testing purposes, since we should not delete persistent identifiers...

Parameters:

pid -

Returns:

true if the identifier was deleted, false if it did not exist