rdapit.typeregistry

Interface ITypeRegistry

All Known Implementing Classes:

TypeRegistry

public interface ITypeRegistry

Main abstraction interface towards the type registry. Contains all methods required from the registry by the core services.

Method Summary

Methods

Modifier and Type	Method and Description
void	createTypeDefinition(String typeIdentifier, TypeDefinition typeDefinition)
EntityClass	determineEntityClass(String identifier) Determines whether the given identifier references a property or type.
boolean	isTypeRegistryPID(String pid) Determines whether the given PID is an identifier in the type registry.
Object	query(String identifier) Generic query method.
PropertyDefinition	queryPropertyDefinition(String propertyIdentifier) Retrieves a property definition by its unique identifier.
List<PropertyDefinition>	queryPropertyDefinitionByName(String propertyName) Retrieves a property definition by its property name.
TypeDefinition	queryTypeDefinition(String typeIdentifier) Queries a type definition record from the type registry.
void	removePropertyDefinition(String propertyIdentifier) Removes the property definition with given PID.

Method Detail

queryPropertyDefinition

PropertyDefinition queryPropertyDefinition(String propertyIdentifier)
                                           throws IOException

Retrieves a property definition by its unique identifier.

Parameters:

propertyIdentifier -

Returns:

the property definition or null if there is no such definition.

Throws:

IOException - on communication errors with a remote registry

queryPropertyDefinitionByName

List<PropertyDefinition> queryPropertyDefinitionByName(String propertyName)
                                                       throws IOException

Retrieves a property definition by its property name. Note that the name is not unique, thus the method returns a List.

Parameters:

propertyName -

Returns:

a list with any number of entries (may be empty).

Throws:

IOException - on communication errors with a remote registry

removePropertyDefinition

void removePropertyDefinition(String propertyIdentifier)
                              throws IOException

Removes the property definition with given PID. If there is no definition with given PID, the method will do nothing.

Parameters:

propertyIdentifier -

Throws:

IOException - on communication errors with a remote registry

queryTypeDefinition

TypeDefinition queryTypeDefinition(String typeIdentifier)
                                   throws IOException

Queries a type definition record from the type registry.

Parameters:

typeIdentifier -

Returns:

a type definition record or null if the type is not registered.

Throws:

IOException - on communication errors with a remote registry

createTypeDefinition

void createTypeDefinition(String typeIdentifier,
                        TypeDefinition typeDefinition)

query

Object query(String identifier)
             throws com.fasterxml.jackson.core.JsonProcessingException,
                    IOException

Generic query method. Requires no a priori knowledge about the kind of entity registered (property, type, ...).

Parameters:

identifier -

Returns:

null if there is no object with given identifier, or an instance of PropertyDefinition or TypeDefinition.

Throws:

IOException

com.fasterxml.jackson.core.JsonProcessingException

isTypeRegistryPID

boolean isTypeRegistryPID(String pid)

Determines whether the given PID is an identifier in the type registry. Note that a positive answer does not necessarily mean the identifier is registered and resolvable.

Parameters:

pid -

Returns:

true if the PID is generally acceptable for the type registry, but may still be unregistered.

determineEntityClass

EntityClass determineEntityClass(String identifier)
                                 throws IOException

Determines whether the given identifier references a property or type.

Parameters:

identifier -

Returns:

a value of EntityClass

Throws:

IOException - on communication errors with a remote registry