project35.soa.ontology.views
Interface OntologyView

All Known Implementing Classes:
DictionaryView, ListView, PictureView, TreeView

public interface OntologyView

describes the behaviour of an ontology view supported by the DefaultOntologyViewer


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 the view is capable of supporting terms provided by an ontology source
 void changeFont(java.awt.Font font)
           
 javax.swing.JComponent getComponent()
          gets the component that renders the view.
 java.lang.String getName()
          gets the name of the view
 OntologyTerm[] getSelectedOntologyTerms(Project35FormContext project35FormContext)
          gets the ontology terms selected in the view
 void reset()
          resets the display of terms in the view
 void setOntologySource(Project35FormContext project35FormContext, OntologySource ontologySource)
          sets the ontology source used by the view
 void setOntologyViewListener(OntologyViewListener ontologyViewListener)
          sets the object that listens for when end-users have finished selecting the terms they want to use to mark-up a field.
 

Method Detail

getName

java.lang.String getName()
gets the name of the view

Returns:
the name of the view

canViewSource

boolean canViewSource(Project35FormContext project35FormContext,
                      OntologySource ontologySource)
determines if the view is capable of supporting terms provided by an ontology source

Parameters:
project35FormContext - a collection of environment variables that refer to different parts of the Project35 Application
ontologySource - provides terms to the view. The View performs introspection on the source by checking what marker interfaces the source supports. It uses these to determine whether it can support a particular kind of view.

setOntologySource

void setOntologySource(Project35FormContext project35FormContext,
                       OntologySource ontologySource)
sets the ontology source used by the view

Parameters:
project35FormContext - a collection of environment variables that refer to different parts of the Project35 Application
ontologySource - provides terms to the view.

getSelectedOntologyTerms

OntologyTerm[] getSelectedOntologyTerms(Project35FormContext project35FormContext)
gets the ontology terms selected in the view

Parameters:
project35FormContext - a collection of environment variables that refer to different parts of the Project35 Application

reset

void reset()
resets the display of terms in the view


setOntologyViewListener

void setOntologyViewListener(OntologyViewListener ontologyViewListener)
sets the object that listens for when end-users have finished selecting the terms they want to use to mark-up a field.

Parameters:
ontologyViewListener - the object that performs some action based on knowledge that a set of terms were selected in the view.

getComponent

javax.swing.JComponent getComponent()
gets the component that renders the view.

Returns:
the component that renders the view. Typically this will be an instance of a JPanel

changeFont

void changeFont(java.awt.Font font)