vub.starlab.ontoserver.database
Interface IDatabaseRetrievalAPI

All Superinterfaces:

IDatabaseAPI

All Known Implementing Classes:

DatabaseAPI

public interface IDatabaseRetrievalAPI

extends IDatabaseAPI

Method Summary

IContext	getContextDetail(java.lang.String ontologyName, java.lang.String contextIdentifyingTerm) This method returns the details associated with a context.
OntologyObjectCollection	getContexts(java.lang.String ontologyName) This method retrieves all contexts for a stored ontology present the ontology server.
OntologyObjectCollection	getLexons(java.lang.String ontologyName, java.lang.String contextIdentifyingTerm) This method retrieves all lexons for a context within a stored ontology As parameters, the ontology name and the context name for which you want to retrieve the lexons are required.
OntologyObjectCollection	getOntologies() This method retrieves all ontologies currently stored in the ontology server.
IOntology	getOntologyDetail(java.lang.String ontoName) This method returns the details associated with an ontology.
ITerm	getTermDetail(java.lang.String ontologyName, java.lang.String contextIdentifyingTerm, java.lang.String term) This method returns the details associated with a term.
OntologyObjectCollection	getTerms(java.lang.String ontologyName, java.lang.String contextIdentifyingTerm) This method retrieves all terms for a context withing a stored ontology present the ontology server.
IUser	getUserDetail(java.lang.String userName) This method returns the details associated with a user.
OntologyObjectCollection	getUsers() This method retrieves all users currently registered in the ontology server.

Methods inherited from interface vub.starlab.ontoserver.database.IDatabaseAPI

closeConnection, establishConnection

Method Detail

getOntologies

public OntologyObjectCollection getOntologies()

This method retrieves all ontologies currently stored in the ontology server. The method returns an OntologyObjectCollection, which in its turn contains objects implementing the IOntology interface: objects retrieved from the OntologyObjectCollection must be casted to the IOntology type

Returns:

OntologyObjectCollection a collection designed to contain object implementing the IOntologyObject interface

See Also:

OntologyObjectCollection, OntologyObjectIterator, OntologyCollectionIterator, IOntology

getOntologyDetail

public IOntology getOntologyDetail(java.lang.String ontoName)
                            throws OntologyNotFoundException

This method returns the details associated with an ontology. The return object implements the IOntology interface, and contains the ontology details. This method expects as parameters an ontology name, the ontology for which you want the details. If the ontology is not found, an OntologyNotFoundException is returned.

Parameters:

ontoName - the name of the ontology for which you want the details

Returns:

IOntology an object implementing the IOntology interface

Throws:

OntologyNotFoundException - exception thrown when the ontology is not found

See Also:

IOntology, OntologyNotFoundException

getUsers

public OntologyObjectCollection getUsers()

This method retrieves all users currently registered in the ontology server. The method returns an OntologyObjectCollection, which in its turn contains objects implementing the IUser interface: objects retrieved from the OntologyObjectCollection must be casted to the IUser type

Returns:

OntologyObjectCollection a collection designed to contain object implementing the IOntologyObject interface

See Also:

OntologyObjectCollection, OntologyObjectIterator, UserCollectionIterator, IUser

getUserDetail

public IUser getUserDetail(java.lang.String userName)
                    throws UserNotFoundException

This method returns the details associated with a user. The return object implements the IUser interface, and contains the user details. This method expects as a parameter a username, the username for the person you want the details from. If the user is not found, an UserNotFoundException is returned.

Parameters:

userName - the username for which you want the details

Returns:

IUser an object implementing the IUser interface

Throws:

UserNotFoundException - exception thrown when the user is not found

See Also:

IUser, UserNotFoundException

getContexts

public OntologyObjectCollection getContexts(java.lang.String ontologyName)
                                     throws ContextNotFoundException

This method retrieves all contexts for a stored ontology present the ontology server. As parameters, the ontology name for which you want retrieve its contexts is required. The method returns an OntologyObjectCollection, which in its turn contains objects implementing the IContext interface: objects retrieved from the OntologyObjectCollection must be casted to the IContext type

Parameters:

ontologyName - the name of the ontology for which you want the contexts

Returns:

OntologyObjectCollection a collection designed to contain object implementing the IOntologyObject interface

See Also:

OntologyObjectCollection, OntologyObjectIterator, ContextCollectionIterator, IContext

getContextDetail

public IContext getContextDetail(java.lang.String ontologyName,
                                 java.lang.String contextIdentifyingTerm)
                          throws ContextNotFoundException

This method returns the details associated with a context. The return object implements the IContext interface, and contains the context details. This method expects as parameters an ontology name and the context name for which you want the details. If the context is not found, an ContextNotFoundException is returned.

Parameters:

userName - the username for which you want the details

Returns:

IContext an object implementing the IContext interface

Throws:

ContextNotFoundException - exception thrown when the context is not found

See Also:

IContext, ContextNotFoundException

getLexons

public OntologyObjectCollection getLexons(java.lang.String ontologyName,
                                          java.lang.String contextIdentifyingTerm)
                                   throws ContextNotFoundException

This method retrieves all lexons for a context within a stored ontology As parameters, the ontology name and the context name for which you want to retrieve the lexons are required. The method returns an OntologyObjectCollection, which in its turn contains objects implementing the ILexon interface: objects retrieved from the OntologyObjectCollection must be casted to the ILexon type

Parameters:

ontologyName - the name of the ontology

contextIdentifyingTerm - the name of the context

Returns:

OntologyObjectCollection a collection designed to contain object implementing the IOntologyObject interface

See Also:

OntologyObjectCollection, OntologyObjectIterator, LexonCollectionIterator, ILexon

getTerms

public OntologyObjectCollection getTerms(java.lang.String ontologyName,
                                         java.lang.String contextIdentifyingTerm)
                                  throws ContextNotFoundException

This method retrieves all terms for a context withing a stored ontology present the ontology server. As parameters, the ontology name and a context are required for which you want to retrieve the terms are required. The method returns an OntologyObjectCollection, which in its turn contains objects implementing the IContext interface: objects retrieved from the OntologyObjectCollection must be casted to the ITerm type

Parameters:

ontologyName - the name of the ontology for which you want the contexts

contextIdentifyingTerm - the name of the term specifying the context

Returns:

OntologyObjectCollection a collection designed to contain object implementing the IOntologyObject interface

See Also:

OntologyObjectCollection, OntologyObjectIterator, TermCollectionIterator, ITerm

getTermDetail

public ITerm getTermDetail(java.lang.String ontologyName,
                           java.lang.String contextIdentifyingTerm,
                           java.lang.String term)
                    throws ContextNotFoundException,
                           TermNotFoundException

This method returns the details associated with a term. The return object implements the ITerm interface, and contains the term details. This method expects as parameters an ontology name, a term identifying the context within this ontology, and the term for which you want to retrieve the details. If the context is not found within this ontology, a ContextNotFoundException is returned. NOTE: error throwing is not yet fully implemented here

Parameters:

ontologyName - the name of the ontology for which you want the contexts

contextIdentifyingTerm - the name of the term specifying the context

term - the term for which you want to retrieve the details

Returns:

IContext an object implementing the IContext interface

Throws:

ContextNotFoundException - exception thrown when the context is not found

ContextNotFoundException - exception thrown when the term is not found

See Also:

ITerm, ContextNotFoundException, TermNotFoundException