rdapit.pitservice

Class TypingService

java.lang.Object

rdapit.pitservice.TypingService

All Implemented Interfaces:

IIdentifierSystem, ITypingService

public class TypingService
extends Object
implements ITypingService

Core implementation class that offers the combined higher-level services through a type registry and an identifier system.

Field Summary

Fields

Modifier and Type	Field and Description
protected IIdentifierSystem	identifierSystem
protected ITypeRegistry	typeRegistry

Constructor Summary

Constructors

Constructor and Description
TypingService(IIdentifierSystem identifierSystem, ITypeRegistry typeRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	conformsToType(String pid, String typeIdentifier)
boolean	deletePID(String pid) Remove the given PID.
PropertyDefinition	describeProperty(String propertyIdentifier) Retrieves a property definition
TypeDefinition	describeType(String typeIdentifier) Retrieves a type definition
EntityClass	determineEntityClass(String identifier) Determines whether the given identifier references a simple object, a property, a type etc.
Object	genericResolve(String pid) Resolves the given PID without previous knowledge about the kind of entity it identifies (e.g. a common PID record, a property or type definition etc.).
IIdentifierSystem	getIdentifierSystem()
ITypeRegistry	getTypeRegistry()
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	queryAllProperties(String pid, boolean includePropertyNames)
PIDInformation	queryByType(String pid, String typeIdentifier, boolean includePropertyNames) Queries all properties of a type available from the given PID.
PIDInformation	queryByType(String pid, TypeDefinition typeDefinition) Queries all properties of a given type available from the given PID.
PIDInformation	queryByTypeWithConformance(String pid, List<String> typeIdentifiers, boolean includePropertyNames)
PIDInformation	queryByTypeWithConformance(String pid, String typeIdentifier, boolean includePropertyNames) Same as ITypingService.queryByType(java.lang.String, java.lang.String, boolean), but also performs a type conformance check.
String	queryProperty(String pid, PropertyDefinition propertyDefinition) Queries a single property from the given PID.
PIDInformation	queryProperty(String pid, String propertyIdentifier) Queries a single property from the PID.
String	registerPID(Map<String,String> properties) Registers a new PID with given property values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

identifierSystem

protected final IIdentifierSystem identifierSystem

typeRegistry

protected final ITypeRegistry typeRegistry

Constructor Detail

TypingService

public TypingService(IIdentifierSystem identifierSystem,
             ITypeRegistry typeRegistry)
              throws IOException

Throws:

IOException

Method Detail

isIdentifierRegistered

public boolean isIdentifierRegistered(String pid)
                               throws IOException

Description copied from interface: IIdentifierSystem

Checks whether the given PID is already registered.

Specified by:

isIdentifierRegistered in interface IIdentifierSystem

Returns:

True or false

Throws:

IOException

queryProperty

public String queryProperty(String pid,
                   PropertyDefinition propertyDefinition)
                     throws IOException

Description copied from interface: IIdentifierSystem

Queries a single property from the given PID.

Specified by:

queryProperty in interface IIdentifierSystem

Returns:

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

Throws:

IOException

registerPID

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

Description copied from interface: IIdentifierSystem

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.

Specified by:

registerPID in interface IIdentifierSystem

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

public PIDInformation queryByType(String pid,
                         TypeDefinition typeDefinition)
                           throws IOException

Description copied from interface: IIdentifierSystem

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.

Specified by:

queryByType in interface IIdentifierSystem

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

public boolean deletePID(String pid)

Description copied from interface: IIdentifierSystem

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

Specified by:

deletePID in interface IIdentifierSystem

Returns:

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

describeProperty

public PropertyDefinition describeProperty(String propertyIdentifier)
                                    throws IOException

Description copied from interface: ITypingService

Retrieves a property definition

Specified by:

describeProperty in interface ITypingService

Returns:

null if there is no property with given identifier, the definition record otherwise.

Throws:

IOException

describeType

public TypeDefinition describeType(String typeIdentifier)
                            throws IOException

Description copied from interface: ITypingService

Retrieves a type definition

Specified by:

describeType in interface ITypingService

Returns:

null if there is no type with given identifier, the definition record otherwise.

Throws:

IOException

conformsToType

public boolean conformsToType(String pid,
                     String typeIdentifier)
                       throws IOException

Specified by:

conformsToType in interface ITypingService

Throws:

IOException

genericResolve

public Object genericResolve(String pid)
                      throws IOException

Description copied from interface: ITypingService

Resolves the given PID without previous knowledge about the kind of entity it identifies (e.g. a common PID record, a property or type definition etc.).

Specified by:

genericResolve in interface ITypingService

Returns:

The returned object can be either a PID record, a property definition or a type definition. It can also be null, indicating the PID is not registered at all.

Throws:

IOException

queryAllProperties

public PIDInformation queryAllProperties(String pid)
                                  throws IOException

Description copied from interface: IIdentifierSystem

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

Specified by:

queryAllProperties in interface IIdentifierSystem

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

queryAllProperties

public PIDInformation queryAllProperties(String pid,
                                boolean includePropertyNames)
                                  throws IOException,
                                         InconsistentRecordsException

Throws:

IOException

InconsistentRecordsException

queryProperty

public PIDInformation queryProperty(String pid,
                           String propertyIdentifier)
                             throws IOException

Description copied from interface: ITypingService

Queries a single property from the PID.

Specified by:

queryProperty in interface ITypingService

propertyIdentifier - must be registered in the type registry

Returns:

a PIDInformation object containing the single property name and value or null if the property is undefined.

Throws:

IOException

queryByType

public PIDInformation queryByType(String pid,
                         String typeIdentifier,
                         boolean includePropertyNames)
                           throws IOException,
                                  InconsistentRecordsException

Description copied from interface: ITypingService

Queries all properties of a 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.

Specified by:

queryByType in interface ITypingService

typeIdentifier - a type identifier, not a name

includePropertyNames - if true, the method will also return property names at additional call costs.

Returns:

a PID information record with property identifiers mapping to values. 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

InconsistentRecordsException

queryByTypeWithConformance

public PIDInformation queryByTypeWithConformance(String pid,
                                        String typeIdentifier,
                                        boolean includePropertyNames)
                                          throws IOException,
                                                 InconsistentRecordsException

Description copied from interface: ITypingService

Same as ITypingService.queryByType(java.lang.String, java.lang.String, boolean), but also performs a type conformance check. The result of the check will be available from the PID information record returned.

Specified by:

queryByTypeWithConformance in interface ITypingService

Returns:

a PID information record with property information and conformance check results.

Throws:

IOException

InconsistentRecordsException

queryByTypeWithConformance

public PIDInformation queryByTypeWithConformance(String pid,
                                        List<String> typeIdentifiers,
                                        boolean includePropertyNames)
                                          throws IOException,
                                                 InconsistentRecordsException

Specified by:

queryByTypeWithConformance in interface ITypingService

Throws:

IOException

InconsistentRecordsException

determineEntityClass

public EntityClass determineEntityClass(String identifier)
                                 throws IOException

Description copied from interface: ITypingService

Determines whether the given identifier references a simple object, a property, a type etc. Note that the method may contact a remote registry to answer the request since information may not be encoded in the identifier string.

Specified by:

determineEntityClass in interface ITypingService

Returns:

a value of EntityClass

Throws:

IOException

getTypeRegistry

public ITypeRegistry getTypeRegistry()

getIdentifierSystem

public IIdentifierSystem getIdentifierSystem()