org.biomoby.registry.meta
Interface Registries

All Known Implementing Classes:

ExampleList, RegistriesList

public interface Registries

An interface defining properties (such as endpoints) of all known BioMoby registries.

Its implementation can be used in order to easily select a registry from a list of known registries.

Version:

$Id: Registries.java,v 1.1 2006/10/02 17:57:49 senger Exp $

Author:

Martin Senger

Field Summary

static String

DEFAULT_REGISTRY_SYNONYM A synonym (abbreviation) used for a default BioMoby registry.

Method Summary

Registry	get(String synonym) Return an object with properties of a given BioMoby registry.
Registry[]	getAll() Return properties of all known BioMoby registries.
String[]	list() Return a list of synonyms (abbreviations) of all known BioMoby registries.

Field Detail

DEFAULT_REGISTRY_SYNONYM

static final String DEFAULT_REGISTRY_SYNONYM

A synonym (abbreviation) used for a default BioMoby registry.

See Also:

list, Constant Field Values

Method Detail

list

String[] list()

Return a list of synonyms (abbreviations) of all known BioMoby registries. It should always return at least a default synonym that represents a default BioMoby registry.

The returned synonyms can be used in the get method.

Returns:

always a non-empty array

get

Registry get(String synonym)
             throws MobyException

Return an object with properties of a given BioMoby registry.

Parameters:

synonym - is the name (abbreviation) of a BioMoby registry whose properties shall be returned; it can be null - in which case properties of a default BioMoby registry are returned

Returns:

properties of the given registry

Throws:

MobyException - if the given 'synonym' does not represent any known registry

getAll

Registry[] getAll()

Return properties of all known BioMoby registries. At least one registry (the default one) should be always included.

Returns:

always a non-empty array