uk.ac.soton.itinnovation.registry.icomponent.discovery
Interface Discovery<E>

All Superinterfaces:

CredentialRequired

All Known Implementing Classes:

XmlDiscoveryFacility

public interface Discovery<E>
extends CredentialRequired

Method Summary

ResultIterator<E>	executePredefinedQuery(String name, ParameterValue... parameterValues) Execute a predefined query.
HashSet	getIdentifier(E resource, String concept) Get the identifier of a resource.
RegistryDomainModel	getRegistryDomainModel() Get the current used registry domain model.
E	lookup(Class clazz, Object id) Look up an object within the registry.
ResultIterator<E>	lookupByConcept(String concept) Lookup entities belonging to a specific concept.
ResultIterator<E>	query(XmlQuery query) Query the registry.
ResultIterator<E>	queryBySpecificQL(String query, String language) Query the registry by a specific query language, like XQuery, XPath, SPARQL, HQL, SQL, etc.

Methods inherited from interface uk.ac.soton.itinnovation.registry.icomponent.access.CredentialRequired

removeCredential, setCredential

Method Detail

getRegistryDomainModel

RegistryDomainModel getRegistryDomainModel()
                                           throws DiscoveryException,
                                                  AccessException

Get the current used registry domain model.

Returns:

the registry domain model

Throws:

AccessException

DiscoveryException

lookup

E lookup(Class clazz,
         Object id)
         throws DiscoveryException,
                AccessException

Look up an object within the registry.

Parameters:

id - identifier within the registry

Throws:

DiscoveryException

AccessException

lookupByConcept

ResultIterator<E> lookupByConcept(String concept)
                                  throws DiscoveryException,
                                         AccessException

Lookup entities belonging to a specific concept.

Parameters:

concept -

Throws:

DiscoveryException

AccessException

getIdentifier

HashSet getIdentifier(E resource,
                      String concept)
                      throws DiscoveryException,
                             AccessException

Get the identifier of a resource.

Parameters:

resource -

concept - concept under which to look or empty ("") for searching the whole registry

Throws:

DiscoveryException

AccessException

query

ResultIterator<E> query(XmlQuery query)
                        throws DiscoveryException,
                               AccessException,
                               ParsingException,
                               GeneratorException

Query the registry.

Parameters:

query - query specified by a XmlQuery container.

Throws:

DiscoveryException

AccessException

ParsingException

GeneratorException

queryBySpecificQL

ResultIterator<E> queryBySpecificQL(String query,
                                    String language)
                                    throws DiscoveryException,
                                           AccessException,
                                           ParsingException,
                                           GeneratorException

Query the registry by a specific query language, like XQuery, XPath, SPARQL, HQL, SQL, etc.

If the query language is not supported by the concrete registry, an exception will be thrown.

Parameters:

query - representing the query in a specific query language.

Throws:

DiscoveryException

AccessException

ParsingException

GeneratorException

executePredefinedQuery

ResultIterator<E> executePredefinedQuery(String name,
                                         ParameterValue... parameterValues)
                                         throws DiscoveryException,
                                                AccessException

Execute a predefined query.

Parameters:

name - name of the query

parameterValues - values of parameters

Throws:

DiscoveryException

AccessException