net.sourceforge.nite.corpus
Interface CorpusTool

All Known Implementing Classes:
OntologyTool

public interface CorpusTool

Interface to be instantated by all tools that can perform editing or management style tasks at a corpus-wide level. NOT intended for annotation tools! Each CorpusTool must publish a JPanel containing its interface and declare whether any changes need to be saved as well as providing a method to do its own saving.


Method Summary
 void applyChanges()
          apply the changes to the corpus
 java.lang.String getDescription()
          get a short textual description of this app
 java.lang.String getName()
          get the (one word) name of this app for naming a tab
 javax.swing.JPanel getPanel(NMetaData metadata)
          provide the interface for this tool
 java.lang.String getToolTip()
          get a handy tip to associate with this app
 boolean requiresSave()
          return true if outstanding changes are still to be committed
 

Method Detail

getPanel

javax.swing.JPanel getPanel(NMetaData metadata)
provide the interface for this tool


requiresSave

boolean requiresSave()
return true if outstanding changes are still to be committed


applyChanges

void applyChanges()
apply the changes to the corpus


getToolTip

java.lang.String getToolTip()
get a handy tip to associate with this app


getDescription

java.lang.String getDescription()
get a short textual description of this app


getName

java.lang.String getName()
get the (one word) name of this app for naming a tab