uk.ac.soton.itinnovation.registry.component.xml.discovery
Class XmlDiscoveryFacility<E>

java.lang.Object
  uk.ac.soton.itinnovation.registry.component.xml.login.XmlCredentialRequiredAdapter<E>
      uk.ac.soton.itinnovation.registry.component.xml.discovery.XmlDiscoveryFacility<E>

All Implemented Interfaces:

CredentialRequired, Discovery<E>

public class XmlDiscoveryFacility<E>
extends XmlCredentialRequiredAdapter<E>
implements Discovery<E>

Field Summary

Fields inherited from class uk.ac.soton.itinnovation.registry.component.xml.login.XmlCredentialRequiredAdapter

credentialFacility, logger

Constructor Summary

XmlDiscoveryFacility()

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 class uk.ac.soton.itinnovation.registry.component.xml.login.XmlCredentialRequiredAdapter

getAccess, removeCredential, setCredential

Methods inherited from class java.lang.Object

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

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

removeCredential, setCredential

Constructor Detail

XmlDiscoveryFacility

public XmlDiscoveryFacility()

Method Detail

getRegistryDomainModel

public RegistryDomainModel getRegistryDomainModel()
                                           throws DiscoveryException,
                                                  AccessException

Description copied from interface: Discovery

Get the current used registry domain model.

Specified by:

getRegistryDomainModel in interface Discovery<E>

Returns:

the registry domain model

Throws:

DiscoveryException

AccessException

getIdentifier

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

Description copied from interface: Discovery

Get the identifier of a resource.

Specified by:

getIdentifier in interface Discovery<E>

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

Throws:

DiscoveryException

AccessException

lookup

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

Description copied from interface: Discovery

Look up an object within the registry.

Specified by:

lookup in interface Discovery<E>

id - identifier within the registry

Throws:

DiscoveryException

AccessException

lookupByConcept

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

Description copied from interface: Discovery

Lookup entities belonging to a specific concept.

Specified by:

lookupByConcept in interface Discovery<E>

Throws:

DiscoveryException

AccessException

executePredefinedQuery

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

Description copied from interface: Discovery

Execute a predefined query.

Specified by:

executePredefinedQuery in interface Discovery<E>

Parameters:

name - name of the query

parameterValues - values of parameters

Throws:

DiscoveryException

AccessException

queryBySpecificQL

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

Description copied from interface: Discovery

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.

Specified by:

queryBySpecificQL in interface Discovery<E>

Parameters:

query - representing the query in a specific query language.

Throws:

DiscoveryException

AccessException

ParsingException

GeneratorException

query

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

Description copied from interface: Discovery

Query the registry.

Specified by:

query in interface Discovery<E>

Parameters:

query - query specified by a XmlQuery container.

Throws:

DiscoveryException

AccessException

ParsingException

GeneratorException