project35.soa.ontology.sources
Interface OntologySource

All Superinterfaces:
java.io.Serializable, ServiceClass
All Known Subinterfaces:
TreeOntologySource
All Known Implementing Classes:
AbstractTreeOntologySource, DefaultSubtreeOntologySource, MetaDataOntologySource, PictureOntologySource, Project35ConfigurationOntologySource, SingleColumnTextSource, TabIndentedTextSource, XMLOntologySource

public interface OntologySource
extends ServiceClass

describes a class that provides ontology terms to an OntologyViewer


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 containsTerm(Project35FormContext project35FormContext, OntologyTerm term)
          determine whether the source contains a particular ontology term
 OntologyServiceMetaData getOntologyServiceMetaData(Project35FormContext project35FormContext)
           
 OntologyTermProvenance getOntologyTermProvenance(Project35FormContext project35FormContext, OntologyTerm ontologyTerm)
           
 OntologyTerm[] getRelatedTerms(Project35FormContext project35FormContext, OntologyRelationshipType relationshipType, OntologyTerm ontologyTerm)
           
 OntologySource getSubOntologySource(Project35FormContext project35FormContext, Parameter[] parameters)
          returns another ontology source is basically this one but pared down by the parameters
 OntologyRelationshipType[] getSupportedOntologyRelationships(Project35FormContext project35FormContext)
           
 OntologyTerm[] getTerms(Project35FormContext project35FormContext)
          returns a collection of terms
 boolean isWorking()
          indicates whether the ontology source is ready for service
 java.lang.String test()
          diagnostic method that indicates whether the ontology source is working.
 
Methods inherited from interface project35.soa.ServiceClass
getInitialisationParameters, initialiseService
 

Method Detail

getOntologyServiceMetaData

OntologyServiceMetaData getOntologyServiceMetaData(Project35FormContext project35FormContext)

getOntologyTermProvenance

OntologyTermProvenance getOntologyTermProvenance(Project35FormContext project35FormContext,
                                                 OntologyTerm ontologyTerm)

getTerms

OntologyTerm[] getTerms(Project35FormContext project35FormContext)
returns a collection of terms


containsTerm

boolean containsTerm(Project35FormContext project35FormContext,
                     OntologyTerm term)
determine whether the source contains a particular ontology term


isWorking

boolean isWorking()
indicates whether the ontology source is ready for service


test

java.lang.String test()
diagnostic method that indicates whether the ontology source is working.


getSubOntologySource

OntologySource getSubOntologySource(Project35FormContext project35FormContext,
                                    Parameter[] parameters)
returns another ontology source is basically this one but pared down by the parameters


getSupportedOntologyRelationships

OntologyRelationshipType[] getSupportedOntologyRelationships(Project35FormContext project35FormContext)

getRelatedTerms

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