org.wandora.application

Interface WandoraTool

All Superinterfaces:

java.io.Serializable, TopicMapLogger, WandoraToolLogger

All Known Implementing Classes:

AbbreviationExtractor, AboutCredits, AboutWandora, AbstractAlchemyExtractor, AbstractAudioScrobblerExtractor, AbstractBingExtractor, AbstractBossExtractor, AbstractCSVExtractor, AbstractDiscogsExtractor, AbstractDockingTool, AbstractDuckDuckGoExtractor, AbstractElavaArkistoExtractor, AbstractEuropeanaExtractor, AbstractExcelExtractor, AbstractExportTool, AbstractExtractor, AbstractFBGraphExtractor, AbstractFreebaseExtractor, AbstractGate, AbstractGenerator, AbstractGeoNamesExtractor, AbstractGitTool, AbstractGraphPinningTool, AbstractGraphTool, AbstractGuardianExtractor, AbstractImportTool, AbstractJsoupExtractor, AbstractJsoupMicroformatExtractor, AbstractLayerTool, AbstractMashapeExtractor, AbstractMediaWikiAPIExtractor, AbstractMillionFirstStepsExtractor, AbstractMusicBrainzExtractor, AbstractNYTExtractor, AbstractOccurrenceExtractor, AbstractOpenCycExtractor, AbstractPalvelukarttaExtractor, AbstractPalvelukarttaExtractor, AbstractRDFExtractor, AbstractRedditExtractor, AbstractRekognitionExtractor, AbstractSliderTool, AbstractStands4Extractor, AbstractTagtheExtractor, AbstractTwitterExtractor, AbstractUClassifier, AbstractUmbelExtractor, AbstractUmbelRelationExtractor, AbstractWandoraTool, AbstractWebViewTool, AbstractWordExtractor, AbstractYahooTermExtractor, AbstractYQLExtractor, AbstractZemantaExtractor, ActivateButtonToolSet, AddAssociations, AddClass, AddDockable, AddGraph, AddImplicitDisplayScopeToVariants, AddImplicitSortScopeToVariants, AddInstance, AddMissingLanguageScope, AddOccurrences, AddSchemalessAssociation, AddSchemalessOccurrence, AddScopeTopicToVariantName, AddSearch, AddSketchGrid, AddSubjectIdentifier, AddTraditional, AddTree, AddVariantName, AddWebLocationAsOccurrence, AddWebLocationAsSubjectIdentifier, AddWebLocationAsSubjectLocator, AddWebSelectionAsBasename, AddWebSelectionAsOccurrence, AddWebSourceAsOccurrence, AddWebView, AdjacencyListImport, AdjacencyMatrixExport, AdjacencyMatrixImport, AdrExtractor, AlbumInfoExtractor, AlchemyCategoryExtractor, AlchemyCategoryOccurrenceExtractor, AlchemyEntityExtractor, AlchemyEntityOccurrenceExtractor, AlchemyFaceDetection, AlchemyImageKeywordExtractor, AlchemyKeywordExtractor, AlchemyKeywordOccurrenceExtractor, AlchemyLanguageExtractor, AlchemyRelationExtractor, AlchemyRelationOccurrenceExtractor, AlchemySentimentExtractor, AlchemySentimentOccurrenceExtractor, AllEmptyVariantRemover, AllMappingsExtractor, AllVariantRemover, AnnieExtractor, AnnieOccurrenceExtractor, Any23Extractor, AppendOccurrence, ApplyChanges, ApplyPatchTool, ApuRahatCSVExtract, ArrangeLayers, ArticlesAdditionalFieldsExtractor, ArticlesExtractor, ArticleTagsExtractor, ArtistRelatedArtistsExtractor, ArtistTopAlbumsExtractor, ArtistTopTagsExtractor, ArtistTopTracksExtractor, AssetWeights, AssociateNearByOccurrenceCarriers, AssociationCounterTool, AssociationRowTableExtractor, AssociationTest, AtomExtractor, AudioScrobblerExtractor, AuthorAssociationFilter, AverageClusteringCoefficient, Back, BasenameNewlineRemover, BasenameRegexReplacer, BasenameRemover, BasenameTrimmer, BasenameWhiteSpaceCollapser, BasicN3Import, BasicRDFImport, BasicRDFJsonLDImport, BatchExtractMarcXML, BibtexExtractor, BigHugeThesaurusExtractor, BingExtractor, BingSearchExtractor, BingSearchResultExtractor, BookmarkExtractor, BossExtractor, BossSearchResultExtractor, BrowserHistoryExtractor, CalendarGenerator, CenterCurrentTopic, ChainExecuter, ChangeAssociationRole, ChangeAssociationRoles, ChangeAssociationType, ChangeCurvature, ChangeFramerate, ChangeNodeMass, ChangeOccurrenceTableRowHeight, ChangeOccurrenceType, ChangeOccurrenceView, ChangeScale, ChangeStiffness, ChangeVariantView, CheckSubjectIdentifiers, CheckSubjectLocator, ClearEdgeFilters, ClearNodeFilters, ClearSelection, ClearToolLocks, ClearTopicMap, ClearTopicMapIndexes, ClearUndoBuffers, Clone, CloseCurrentTopicPanel, CloseTopicNode, CloseTopicNodesOfType, CollapseTool, CollectBinaryToNary, CollectNary, Commit, CommitPush, CommitStoredSession, ConfigureLayer, ConnectNodesTool, ContextToolWrapper, ConvertSubjectLocatorToDataURL, CopyAsImage, CopyAssociations, CopyEdgePath, CopyOccurrence, CopySubjectIdentifiers, CopyTopicAssociationTypes, CopyTopicClasses, CopyTopicInstances, CopyTopicPlayers, CopyTopicRoles, CopyTopics, CopyTopicsToLayer, CreateAssociationType, CreateSymmetricAssociation, CreateTopicWithOccurrenceSelection, CreateWebLocationTopic, CreativeCommonsRDFExtractor, CustomCommandTool, CutOccurrence, CylinderGenerator, DbpediaExtractor, DbpediaRDFExtractor, DefinitionExtractor, DefinitionListExtractor, DeleteAllDockables, DeleteAllOccurrences, DeleteAssociations, DeleteAssociationsInTopic, DeleteAssociationsInTopicWithType, DeleteCurrentDockable, DeleteDockable, DeleteFromTopics, DeleteLayer, DeleteOccurrence, DeleteScopeTopicInVariantName, DeleteSubjectIdentifiers, DeleteSubjectIdentifiersWithRegex, DeleteSubjectLocator, DeleteSymmetricAssociation, DeleteTopics, DeleteTopicsExceptSelected, DeleteTopicsWithBasenameRegex, DeleteTopicsWithoutACI, DeleteTopicsWithoutAI, DeleteTopicsWithoutAssociations, DeleteTopicsWithoutBasename, DeleteTopicsWithoutClasses, DeleteTopicsWithoutInstances, DeleteTopicsWithoutOccurrences, DeleteTopicsWithoutVariants, DeleteTopicsWithSIRegex, DeleteUnaryAssociations, DeleteVariantName, DeliciousPostsExtractor, DeliciousURLExtractor, DetectCycles, DiffTool, DiggPostsExtractor, DiggURLExtractor, DiigoBookmarkExtractor, DiigoExtractor, DirectoryStructureExtractor, DirectoryStructureExtractor2, DiscogsArtistExtractor, DiscogsExtractor, DiscogsLabelExtractor, DiscogsMasterExtractor, DiscogsReleaseExtractor, DiscogsSearchExtractor, DoSelection, DOTExport, DoTopicSelection, DownloadAllOccurrences, DownloadOccurrence, DownloadSubjectLocators, DublinCoreRDFExtractor, DublinCoreXMLExtractor, DuckDuckGoExtractor, DuckDuckGoZeroClickExtractor, DummyExtractor, DummyTool, DuplicateAssociations, DuplicateAssociationsOfType, DuplicateOccurrence, DuplicateSubjectIdentifier, DuplicateTopics, EditOccurrences, EuropeanaExtractor, EuropeanaFilter, EuropeanaSearchExtractor, ExcelAdjacencyListExtractor, ExcelAdjacencyMatrixExtractor, ExcelExtractor, ExcelTopicExtractor, ExcelTopicNameExtractor, ExcelTopicOccurrenceExtractor, ExcelTopicTreeExtractor, Exec, ExecBrowser, ExecuteJavascript, ExitWandora, ExpandNodesRecursivelyTool, ExpandNodeTool, ExportRemoteTopicMap, ExportSchemaMap, ExportSite, ExportTopicMap, ExtractFNGTextEnrichment, ExtractIconclassKeywords, ExtractKiasmaKeywords, ExtractMuusaIconclassBridge, ExtractSIFFKeywords, ExtractTool, ExtractWithSubjectLocator, FacebookAPIExtractor, FBGraphExtractor, FilterEdges, FilterNode, FilterNodesOfType, FindAssociationsInOccurrence, FindAssociationsInOccurrenceSimple, FindNearByGeoNames, FindNearByGeoNamesOccurrence, FindPointInPolygonOccurrence, FindSubjectLocator, FindSubjectLocatorWithBasename, FindTopicsWithSimilarOccurrence, FiniteGroupGenerator, FixSubjectIdentifiers, FixSubjectIdentifiers2, FixTimeApellations, FlattenSubjectIdentifiers, FlattenTimeApellations, FlickrExtractor, FlipNameMatrix, FNGCidocTypeProcessor, FngOpenDataDublinCoreExporter, FngOpenDataDublinCoreExporter, FoafRDFExtractor, FoafRDFExtractor, Forward, FreebaseExtractor, FreebaseMQLExtractor, FreeDBExtractor, FullyConnectedGraphGenerator, GedcomExtractor, GellishExtractor, GenericDatabaseExtractor, GeoExtractor, GeoNamesChildren, GeoNamesCities, GeoNamesCountryInfo, GeoNamesExtractor, GeoNamesHierarchy, GeoNamesNearByWeather, GeoNamesNeighbours, GeoNamesSearch, GeoNamesSiblings, GeoNamesWikipediaBBox, GeoNamesWikipediaSearch, GephiExport, GMLExport, GOAImport, GraphDOTExport, GraphGMLExport, GraphGraphMLExport, GraphGraphXMLExport, GraphMLExport, GraphXMLExport, GroupInfoExtractor, GuardianContentSearchExtractor, GuardianExtractor, GuardianTagSearchExtractor, GXLExport, HCalendarExtractor, HCardExtractor, HelmetJSONExtractor, HSFeedExtractor, HTMLLinkStructureExtractor, HTTPServerOpenPage, HTTPServerStart, HTTPServerStop, HTTPServerTool, HyperCubeGenerator, ICalExtractor, IIIFExport, IIIFRDFExtractor, IMDBExtractor, ImportTopicsOfType, IncidenceMatrixExport, IncidenceMatrixImport, Init, InsertPlayer, InstanceListExtractor, InvertSelection, JavabibExtractor, JsoupAdrExtractor, JsoupAssociationRowTableExtractor, JsoupDefinitionListExtractor, JsoupGeoExtractor, JsoupHCalendarExtractor, JsoupHCardExtractor, JsoupHTMLLinkStructureExtractor, JsoupInstanceListExtractor, JsoupPropertyTableExtractor, JsoupSuperSubClassListExtractor, LatticeGenerator, LinearListGenerator, LoadWandoraProject, LocateSelectTopicInTree, LockLayers, LSystemGraphGenerator, LuceneIndexBuilder, MadsExtractor, MaianaExport, MaianaImport, MakeAssociationConsistentTool, MakeAssociationWithClassInstance, MakeAssociationWithOccurrence, MakeBasenameFromOccurrence, MakeBasenameFromSubjectIdentifier, MakeBookmarkBrowserExtractor, MakeDisplayVariantsFromBasename, MakeDisplayVariantsFromOccurrences, MakeInstancesWithAssociations, MakeOccurrenceFromAssociation, MakeOccurrenceFromBasename, MakeOccurrenceFromSubjectIdentifier, MakeOccurrenceFromSubjectLocator, MakeOccurrenceFromVariant, MakeOccurrencesFromVariants, MakeSIConsistentTool, MakeSIFromOccurrence, MakeSortVariantsFromBasename, MakeSubclassOf, MakeSubjectIdentifierFromBasename, MakeSubjectIdentifierFromFilename, MakeSubjectIdentifierFromOccurrence, MakeSubjectIdentifierFromSubjectLocator, MakeSubjectLocatorFromBasename, MakeSubjectLocatorFromFileContent, MakeSubjectLocatorFromFilename, MakeSubjectLocatorFromOccurrence, MakeSubjectLocatorFromSubjectIdentifier, MakeSuperclassOf, MarcXMLExtractor, MashapeDuckDuckGoExtractor, MashapeExtractor, MashapeLambdaExtractor, MaximizeDockable, MediaArticleExtractor, MediaExtractor, MediateekkiFilter, MediaWikiAPIExtractor, MediaWikiAPIHandler, MediaWikiAPIPageExtractor, MediaWikiAPIUploader, MediaWikiExtractor, MediawikiHandler, MediawikiOccurrenceUploader, MediawikiSubjectLocatorUploader, MergeLayers, MergeMatrixTool, MergePlayers, MergeTopics, MergeWandoraProject, MillionFirstStepsBookMetadataJSONExtractor, MillionFirstStepsBookTSVExtractor, MobyThesaurusExtractor, ModifyAssociation, ModifySchemalessAssociation, ModifySubjectIdentifiersWithRegex, ModifySubjectLocatorWithRegex, MoveSubjectLocatorResources, MusicBrainzExtractor, MuusaKeywordSplitter, NewLayer, NewTopic, NewTopicExtended, NYTArticleSearchExtractor, NYTEventSearchExtractor, NYTExtractor, OBOExport, OBOImport, OBORoundTrip, OccurrenceGoogleTranslate, OccurrenceMicrosoftTranslate, OccurrenceRegexReplacerAll, OccurrenceRegexReplacerOne, OccurrenceScopeCopier, OccurrenceSummaryReport, OccurrenceWatsonTranslate, OCRExtractor, OmaKaupunkiAbstractExtractor, OmaKaupunkiDirectoryCategoriesExtractor, OmaKaupunkiDirectoryExtractor, OmaKaupunkiEventCategoriesExtractor, OmaKaupunkiEventExtractor, OmaKaupunkiExtractor, OpenCalaisClassifier, OpenCalaisOccurrenceExtractor, OpenCycCommentExtractor, OpenCycDenotationsExtractor, OpenCycExtractor, OpenCycGenlsExtractor, OpenCycInstanceExtractor, OpenCycIsaExtractor, OpenCYCOWLExtractor, OpenCycSiblingsExtractor, OpenCycSpecsExtractor, OpenEdgeTopic, OpenFirebugInWebView, OpenOccurrenceInWebView, OpenRConsole, OpenSubjectIdentifier, OpenSubjectLocator, OpenTopic, OpenTopicIn, OpenTopicInNew, OpenTopicWithSX, OpenURLOccurrence, OpenWebLocationInExternalBrowser, OviExtractor, OviMediaExtractor, OWLExtractor, PalvelukarttaDepartmentExtractor, PalvelukarttaDepartmentExtractor, PalvelukarttaExtractor, PalvelukarttaExtractor, PalvelukarttaOrganizationExtractor, PalvelukarttaOrganizationExtractor, PalvelukarttaServiceExtractor, PalvelukarttaServiceExtractor, PalvelukarttaServiceTreeExtractor, PalvelukarttaServiceTreeExtractor, PalvelukarttaUnitExtractor, PalvelukarttaUnitExtractor, PasteAssociations, PasteAssociationsOfType, PasteBinOccurrenceDownloader, PasteBinOccurrenceUploader, PasteClasses, PasteInstances, PasteOccurrence, PasteSubjectIdentifiers, PasteTopics, PersonInfoExtractor, PhotoInfoExtractor, Pinger, PlatonicSolidGenerator, Print, PrintTopic, PropertyTableExtractor, Pull, Push, RandomGraphGenerator, RDFExport, RDFSExtractor, RedditExtractor, RedditThingExtractor, Redo, RefreshTopicTrees, RekognitionFaceDetector, RekognitionSceneDetector, ReleaseEdges, ReleaseNodesOfType, RemovePlayer, RemoveReferencesInSubjectIdentifiers, RenameLayer, ResetWandora, ReversePinningTool, RevertWandoraProject, RISExtractor, RSSExtractor, RSSRDFExtractor, RunOccurrenceAsQuery, RunOccurrenceAsTMQL, SameAs270aStoreSubjectExpander, SameAsAnywhereSubjectExpander, SameAsBritishLibraryStoreSubjectExpander, SameAsDataSouthamptonStoreSubjectExpander, SameAsDisaster20StoreSubjectExpander, SameAsEmailStoreSubjectExpander, SameAsFreebaseStoreSubjectExpander, SameAsKelleStoreSubjectExpander, SameAsLATCStoreSubjectExpander, SameAsLibrisStoreSubjectExpander, SameAsMusicNetStoreSubjectExpander, SameAsNoTubeStoreSubjectExpander, SameAsOrdnanceSurveyStoreSubjectExpander, SameAsPleiadesStoreSubjectExpander, SameAsSchemaOrgStoreSubjectExpander, SameAsSubjectExpander, SameAsTorverDataStoreSubjectExpander, SameAsVIAFStoreSubjectExpander, SameAsWebIndexStoreSubjectExpander, SaveSession, SaveWandoraProject, Search, SearchAndReplaceOccurrences, SearchTermExtract, SelectAll, SelectColumns, SelectDockable, SelectionInfo, SelectRows, SelectTopicIfInLayer, SelectTopicIfNoAI, SelectTopicIfNoAssociations, SelectTopicIfNoBasenames, SelectTopicIfNoClasses, SelectTopicIfNoInstances, SelectTopicIfNoOccurrences, SelectTopicIfNotInLayer, SelectTopicIfSL, SelectTopicWithAssociationType, SelectTopicWithClipboard, SelectTopicWithClipboardRegex, Sentences2Associations, SentimentUClassifier, SetMouseTool, SetOptions, SetOptionsLocal, SetPinnedTool, SetTopicStringifier, SetUnpinnedTool, SimbergExport, SimbergLIDOExporter, SimbergOAIDCExporter, SimbergOpenDataExporter, SimilarityMatchingExtractor, SimilarityMatrixExport, SimpleCSVAssociationExtractor, SimpleDocumentExtractor, SimpleEmailExtractor, SimpleFileExtractor, SimpleJPGExtractor, SimpleMP3Extractor, SimpleN3Import, SimplePDFExtractor, SimpleRDFImport, SimpleRDFJsonLDImport, SimpleRDFTurtleImport, SimpleWordMatchingExtractor, SKOSRDFExtractor, SolrIndexBuilder, SOMClassifier, SparqlExtractor, SplitToBinaryAssociations, SplitToInstancesWithBasename, SplitTopics, SplitTopicsWithBasename, SplitToSuperclassesWithBasename, SpreadOccurrence, SQLDumpExport, SQLExtractor, SQLTopicMapImport, Stands4Extractor, StanfordNERClassifier, StanfordNEROccurrenceExtractor, Status, StealAssociations, Subj3ctRecordExtractor, SuperSubClassListExtractor, SwapPlayers, SynonymExtractor, SystemClipboard, SystemClipboardCopy, TagtheExtractor, TagTopAlbumsExtractor, TagTopArtistsExtractor, TagTopTagsExtractor, TermsExtractor, TestRunner, TextLanguageUClassifier, TextWiseClassifier, TilingGenerator, ToggleAnimationTool, ToggleAntialiasTool, ToggleFilterWindow, ToggleFreezeForMouseOverTool, ToggleLabelEdges, ToggleProjectionSettings, ToggleStaticWidthNodeBoxes, ToggleViewFilterInfo, TopicClusteringCoefficient, TopicHilighter, TopicMapDiameter, TopicMapDiameterAlternative, TopicMapImport, TopicMapRoundTrip, TopicMapStatistics, TopicNameCopier, TopicsUClassifier, TopicTest, TransposeAssociations, TreeGraphGenerator, TwineExtractor, TwitterExtractor, TwitterJSONExtractor, UClassifier, UClassifyOccurrenceExtractor, UmbelGetBroader, UmbelGetConcept, UmbelGetNarrower, UmbelGetSubclasses, UmbelGetSuperclasses, UmbelGetSuperType, UmbelSearchConcept, Undo, UploadFile, UploadFileOld, URLOccurrenceChecker, VariantGoogleTranslate, VariantMicrosoftTranslate, VariantNewlineRemover, VariantRegexReplacer, VariantRemover, VariantScopeCopier, VariantsToTopicsAndAssociations, VariantWatsonTranslate, VariantWhiteSpaceCollapser, VerbOceanExtractor, ViewLayers, WandoraToolManager, WandoraToolManager2, WikipediaExtractor, WorkNameProcessor, XMLBigHugeThesaurusExtractor, XMLSubj3ctRecordExtractor, XSLImport, XTMRoundTrip, YahooTermExtractor, YahooTermOccurrenceExtractor, YouTubeExtractor, YouTubeURLExtractor, YouTubeVideoFeedExtractor, ZemantaExtractor, ZemantaOccurrenceExtractor

public interface WandoraTool
extends WandoraToolLogger, java.io.Serializable

The interface for Wandora tools. Wandora tool is a fundamental way of packing actions in Wandora. Instead of implementing this interface directly, you should extend AbstractWandoraTool. It contains implementation for most of the interface methods and eases developing tools.

Author:

olli, akivela

See Also:

AbstractWandoraTool

Field Summary

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Method Summary

Modifier and Type	Method and Description
void	configure(Wandora wandora, Options options, java.lang.String prefix) Open configuration dialog and allow user to configure the tool.
void	execute(Wandora wandora) Runs the tool.
void	execute(Wandora wandora, java.awt.event.ActionEvent actionEvent) Runs the tool.
void	execute(Wandora wandora, Context context) Runs the tool.
Context	getContext() Get tool's execution context.
java.lang.String	getDescription() Returns description of the tool.
javax.swing.Icon	getIcon() Return tool's icon.
java.lang.String	getName() Return tool's name.
SimpleMenuItem	getToolMenuItem(Wandora wandora, java.lang.String instanceName)
WandoraToolType	getType() Returns tool's type.
void	hlog(java.lang.String message) Shortcut to access tool's logger.
void	initialize(Wandora wandora, Options options, java.lang.String prefix) Read settings from options and initialize tool.
boolean	isConfigurable() Return true if tool has something to configure.
boolean	isRunning() Returns boolean value true if the tool is running and false if the execution has ended.
void	log(java.lang.Error e) Shortcut to access tool's logger.
void	log(java.lang.Exception e) Shortcut to access tool's logger.
void	log(java.lang.String message) Shortcut to access tool's logger.
void	log(java.lang.String message, java.lang.Exception e) Shortcut to access tool's logger.
boolean	requiresRefresh() Should the Wandora application refresh.
void	setContext(Context context) Set tool's execution context.
void	setToolLogger(WandoraToolLogger logger) Sets tools logger.
void	writeOptions(Wandora wandora, Options options, java.lang.String prefix) Save current tool settings to options.

Methods inherited from interface org.wandora.application.WandoraToolLogger

forceStop, getHistory, getState, lockLog, setLogTitle, setProgress, setProgressMax, setState

Method Detail

getName

java.lang.String getName()

Return tool's name.

Returns:

String representing tool's name.

getDescription

java.lang.String getDescription()

Returns description of the tool.

Returns:

String representing tool's description.

execute

void execute(Wandora wandora,
             java.awt.event.ActionEvent actionEvent)
      throws TopicMapException

Runs the tool.

Parameters:

wandora - is the application context.

actionEvent - is the event triggering the event.

Throws:

TopicMapException

execute

void execute(Wandora wandora,
             Context context)
      throws TopicMapException

Runs the tool. This is the main entry to the tool. Here the context

Parameters:

wandora -

context -

Throws:

TopicMapException

execute

void execute(Wandora wandora)
      throws TopicMapException

Runs the tool.

Parameters:

wandora -

Throws:

TopicMapException

isRunning

boolean isRunning()

Returns boolean value true if the tool is running and false if the execution has ended.

Returns:

true if the tool is running.

setContext

void setContext(Context context)

Set tool's execution context. The context contains topics and associations the tool should process, and application component that was active when the tool was executed. Usually the context is given as an argument while executing the tool.

Parameters:

context - Tool's new context.

getContext

Context getContext()

Get tool's execution context.

Returns:

Context object.

getType

WandoraToolType getType()

Returns tool's type. Tool type is a deprecated feature. It was originally used to distinguish tools that import, extract and export something. These days it has no strict meaning in Wandora.

Returns:

Tool's type object.

initialize

void initialize(Wandora wandora,
                Options options,
                java.lang.String prefix)
         throws TopicMapException

Read settings from options and initialize tool.

Parameters:

wandora -

options -

prefix -

Throws:

TopicMapException

isConfigurable

boolean isConfigurable()

Return true if tool has something to configure.

Returns:

true if the tool is configurable.

configure

void configure(Wandora wandora,
               Options options,
               java.lang.String prefix)
        throws TopicMapException

Open configuration dialog and allow user to configure the tool. Should save changes to options after the configuration.

Parameters:

wandora -

options -

prefix -

Throws:

TopicMapException

writeOptions

void writeOptions(Wandora wandora,
                  Options options,
                  java.lang.String prefix)

Save current tool settings to options.

Parameters:

wandora -

options -

prefix -

requiresRefresh

boolean requiresRefresh()

Should the Wandora application refresh. Refresh is required if the tool changed options, topics or associations, or any other setting that has an effect to the user interface.

Returns:

true if Wandora application should refresh user interface.

getToolMenuItem

SimpleMenuItem getToolMenuItem(Wandora wandora,
                               java.lang.String instanceName)

getIcon

javax.swing.Icon getIcon()

Return tool's icon. Wandora views the icon in the user interface.

Returns:

icon for the tool.

setToolLogger

void setToolLogger(WandoraToolLogger logger)

Sets tools logger. Logger is used to output textual message about the progress of tool execution.

Parameters:

logger - is new logger object.

hlog

void hlog(java.lang.String message)

Shortcut to access tool's logger.

Specified by:

hlog in interface TopicMapLogger

Specified by:

hlog in interface WandoraToolLogger

Parameters:

message - to be logged.

log

void log(java.lang.String message)

Shortcut to access tool's logger.

Specified by:

log in interface TopicMapLogger

Specified by:

log in interface WandoraToolLogger

Parameters:

message - to be logged.

log

void log(java.lang.String message,
         java.lang.Exception e)

Shortcut to access tool's logger.

Specified by:

log in interface TopicMapLogger

Specified by:

log in interface WandoraToolLogger

Parameters:

message - to be logged.

e - Exception to be logged.

log

void log(java.lang.Exception e)

Shortcut to access tool's logger.

Specified by:

log in interface TopicMapLogger

Specified by:

log in interface WandoraToolLogger

Parameters:

e - Exception to be logged.

log

void log(java.lang.Error e)

Shortcut to access tool's logger.

Specified by:

log in interface WandoraToolLogger

Parameters:

e - Error to be logged.