project35.soa.ontology.views
Interface OntologyViewer

All Superinterfaces:

java.io.Serializable, ServiceClass

All Known Implementing Classes:

DefaultOntologyViewer, DefaultOntologyViewerPanel, StubbedOntologyViewer

public interface OntologyViewer
extends ServiceClass

describes a class that can render a collection of ontology terms.

Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.

Version:

1.0

Author:

Kevin Garwood (kgarwood@users.sourceforge.net)

Method Summary

boolean	canViewSource(Project35FormContext project35FormContext, OntologySource ontologySource) determines if this Viewer class is capable of rendering terms supplied by a given ontology source.
OntologyServiceMetaData	getOntologyServiceMetaData(Project35FormContext project35FormContext)
OntologyTermProvenance	getOntologyTermProvenance(Project35FormContext project35FormContext, OntologyTerm ontologyTerm)
OntologyTerm[]	getRelatedTerms(Project35FormContext project35FormContext, OntologyRelationshipType relationshipType, OntologyTerm ontologyTerm)
OntologyTerm[]	getSelectedOntologyTerms(Project35FormContext project35FormContext)
boolean	isWorking()
void	setOntologySource(Project35FormContext project35FormContext, OntologySource ontologySource) method called by Project35 to help establish the ontology source being rendered by the viewer class.
void	setOntologyTermSelectionListener(OntologyTermSelectionListener ontologyTermSelectionLilstener)
void	setVisible(boolean isVisible)
java.lang.String	test() this is a diagnostic method to retrieve any errors that may have occurred when the viewer was initially created.

Methods inherited from interface project35.soa.ServiceClass

getInitialisationParameters, initialiseService

Method Detail

getOntologyServiceMetaData

OntologyServiceMetaData getOntologyServiceMetaData(Project35FormContext project35FormContext)

isWorking

boolean isWorking()

setOntologySource

void setOntologySource(Project35FormContext project35FormContext,
                       OntologySource ontologySource)
                       throws java.lang.Exception

method called by Project35 to help establish the ontology source being rendered by the viewer class. The ontology context helps the viewer ask questions about what else might be on the form. This information could be used to limit what relevant terms are displayed to end users.

Throws:

java.lang.Exception

canViewSource

boolean canViewSource(Project35FormContext project35FormContext,
                      OntologySource ontologySource)

determines if this Viewer class is capable of rendering terms supplied by a given ontology source.

test

java.lang.String test()

this is a diagnostic method to retrieve any errors that may have occurred when the viewer was initially created.

setVisible

void setVisible(boolean isVisible)

getRelatedTerms

OntologyTerm[] getRelatedTerms(Project35FormContext project35FormContext,
                               OntologyRelationshipType relationshipType,
                               OntologyTerm ontologyTerm)

getOntologyTermProvenance

OntologyTermProvenance getOntologyTermProvenance(Project35FormContext project35FormContext,
                                                 OntologyTerm ontologyTerm)

getSelectedOntologyTerms

OntologyTerm[] getSelectedOntologyTerms(Project35FormContext project35FormContext)

setOntologyTermSelectionListener

void setOntologyTermSelectionListener(OntologyTermSelectionListener ontologyTermSelectionLilstener)