Writing your own tool - Revision history

Akivela: /* Example tool - SearchAndReplaceOccurrences */

2012-02-15T08:38:00Z

‎Example tool - SearchAndReplaceOccurrences

Akivela at 14:51, 21 March 2009

2009-03-21T14:51:34Z

Akivela: /* Example tool - SearchAndReplaceOccurrences */

2009-03-21T14:38:47Z

‎Example tool - SearchAndReplaceOccurrences

Akivela: /* Example tool - HelloWorld */

2009-03-21T14:38:29Z

‎Example tool - HelloWorld

Akivela at 14:37, 21 March 2009

2009-03-21T14:37:53Z

Akivela: /* AbstractAdminTool */

2008-05-08T18:38:16Z

‎AbstractAdminTool

Akivela: /* Tool context */

2008-03-05T12:49:27Z

‎Tool context

Akivela: /* Example tool - SearchAndReplaceOccurrences */

2008-03-04T15:52:16Z

‎Example tool - SearchAndReplaceOccurrences

Akivela: /* Example tool - HelloWorld */

2008-03-04T15:50:53Z

‎Example tool - HelloWorld

Akivela: /* Example tool - HelloWorld */

2008-03-04T15:50:22Z

‎Example tool - HelloWorld

← Older revision		Revision as of 08:38, 15 February 2012
Line 174:		Line 174:

	}		}
		+
		+
		+	== See also ==
		+
		+	* [[Tool manager]]
		+	* [[:Category:Tools\|Available tools]]
		+	* [[Installing your own tool]]
		+	* [[Tool locks]]
		+	* [[Configuring tools]]
		+	* [[Additional tool help]]

@@ Line 44: / Line 44: @@
   |}
-More detailed description of methods and a few more methods that you can override can be found in the [[AbstractAdminTool]] page.
+More detailed description of methods and a few more methods that you can override can be found in the [[AbstractWandoraTool]] page.
 If the tool execution can take a long time, you should try to provide some feedback for the user. Use the log method to show messages. You should also periodically check if the user has aborted the execution. To do this call  forceStop method. If returns true, you should abort the execution and return from execute as soon as possible.

@@ Line 118: / Line 118: @@
   import java.util.regex.*;
-  public class SearchAndReplaceOccurrences extends AbstractAdminTool {
+  public class SearchAndReplaceOccurrences extends AbstractWandoraTool {
      public SearchAndReplaceOccurrences() {

@@ Line 79: / Line 79: @@
   import java.util.*;
-  public class HelloWorld extends AbstractAdminTool {
+  public class HelloWorld extends AbstractWandoraTool {
      public HelloWorld () {

@@ Line 1: / Line 1: @@
-It is possible to make your own tools for Wandora. To make your own tool you need to make a Java class that implements the [[AdminTool]] interface. Most of the time easiest way to do this is to extend the [[AbstractAdminTool]] class which implements AdminTool interface and provides some commonly used methods. [http://www.wandora.net/wandora/docs/api/ Wandora Javadocs] are also available.
+It is possible to make your own tools for Wandora. To make your own tool you need to make a Java class that implements the [[WandoraTool]] interface. Most of the time easiest way to do this is to extend the [[AbstractWandoraTool]] class which implements WandoraTool interface and provides some commonly used methods. [http://www.wandora.net/wandora/docs/api/ Wandora Javadocs] are also available.
-== AbstractAdminTool ==
+== AbstractWandoraTool ==
-The simplest way to make your own tool is to extend AbstractAdminTool class and then implement and override a few methods. Following table lists methods that are most often overridden.
+The simplest way to make your own tool is to extend AbstractWandoraTool class and then implement and override a few methods. Following table lists methods that are most often overridden.
 {| cellspacing="0" cellpadding="5" border="1"

@@ Line 9: / Line 9: @@
   ! Description
   |-
-  | execute(WandoraAdmin,Context)
+  | execute(Wandora,Context)
   | Main method of the tool. In all cases you must implement this method. It should perform all processing of the tool. You can open dialogs for user input if you want to.
   |-

@@ Line 50: / Line 50: @@
 == Tool context ==
-The execute method receives a Context object as one of its parameters. The context contains objects the tool should modify or inspect. There are many kinds of contexts a tool can use. If the tool modifies topics, then it will probably want to use one of the topic contexts. If it modifies associations then it should use an association context. Depending on what kind of context is used, the context will contain different kinds of objects. You should set the preferred context before invocation of the tool. Best place to do this is in tool constructor. To set the context call setContext method with a new context object. Following table lists some of the more commonly used contexts. Package for all built in contexts is com.gripstudios.applications.wandora.admin.contexts.
+The execute method receives a Context object as one of its parameters. The context contains objects the tool should modify or inspect. There are many kinds of contexts a tool can use. If the tool modifies topics, then it will probably want to use one of the topic contexts. If it modifies associations then it should use an association context. Depending on what kind of context is used, the context will contain different kinds of objects. You should set the preferred context before invocation of the tool. Best place to do this is in tool constructor. To set the context call setContext method with a new context object. Following table lists some of the more commonly used contexts. Package for all built in contexts is org.wandora.application.contexts.
 {| cellspacing="0" cellpadding="5" border="1"
@@ Line 68: / Line 68: @@
   | This context returns the selected associations in an association table or the associations of the selected topics or the current topic.
   |}
 == Example tool - HelloWorld ==

@@ Line 109: / Line 109: @@
 This is a simple tool that searches for a regular expression in occurrences of context topic(s) and replaces matches with some other string. The tool asks for both the regular expression and the replacement string. The input dialogs are shown with a WandoraOptionPane class. This class is similar to the javax.swing.JOptionPane class and has several static methods to show input and message dialogs.
-  package com.gripstudios.applications.wandora.admin.tools;
+  package org.wandora.application.tools;
-  import com.gripstudios.applications.wandora.topicmap.layered.*;
+  import org.wandora.topicmap.layered.*;
-  import com.gripstudios.applications.wandora.topicmap.*;
+  import org.wandora.topicmap.*;
-  import com.gripstudios.applications.wandora.admin.*;
+  import org.wandora.application.*;
-  import com.gripstudios.applications.wandora.admin.contexts.*;
+  import org.wandora.application.contexts.*;
-  import com.gripstudios.applications.wandora.admin.gui.*;
+  import org.wandora.application.gui.*;
   import java.util.*;
   import java.util.regex.*;
@@ Line 125: / Line 125: @@
+     }
-     public void execute(final WandoraAdmin admin, Context context) {
+     public void execute(final Wandora admin, Context context) {
          String search=WandoraOptionPane.showInputDialog(admin,"Enter search string","","Search and replace");
          if(search==null || search.length()==0) return;

@@ Line 95: / Line 95: @@
         setState(WAIT);
+     }
-−
      public String getName() {
          return "Hello World";
@@ Line 103: / Line 103: @@
          return "Hello World simply writes Hello World to the log dialog!";
+     }
 == Example tool - SearchAndReplaceOccurrences ==