Installing your own tool

From WandoraWiki
(Difference between revisions)
Jump to: navigation, search
(Placing the tool class file)
(Placing the tool Java class file)
 
(17 intermediate revisions by one user not shown)
Line 1: Line 1:
 
To install your own tool
 
To install your own tool
  
* Place your tool class file into Wandora's tool directory.
+
* Place your tool Java class file into Wandora's tool directory, by default '''org/wandora/application/tools'''.
* Restart Wandora.
+
* Open Wandora.
* Open Tool manager.
+
* Open [[Tool manager]].
* Create new tool.
+
* Select '''generic''' tool set.
* Locate your tool class and give a name for your tool.
+
* Click '''Add tool''' and select your tool in tool selector.
* Accept new tool and close tool manager.
+
* Close Tool manager.
  
 
Now your tool is available at '''Tools''' menu and ready to be executed.
 
Now your tool is available at '''Tools''' menu and ready to be executed.
  
 +
==Placing the tool Java class file==
  
==Placing the tool class file==
+
Tool manager scans through given paths for class files. If scanned class file implements [http://www.wandora.org/wandora/docs/api/org/wandora/application/WandoraTool.html tool interface] the class is accepted as a Wandora tool. [[Tool manager]] seeks tool classes in class paths specified in the Tool manager's '''Paths''' tab. By default the [[Tool manager]] seeks tool classes in package '''org/wandora/application/tools'''.
  
Tool manager seeks tool classes in:
+
If you add new path to [[Tool manager]] make sure the path is also Java's class path. To change class path's of Wandora you need to edit '''bin/SetClasspath.bat''' and '''bin/SetClasspath.sh'''.
  
      com/gripstudios/applications/wandora/admin/tools
+
== See also ==
      com/gripstudios/applications/wandora/admin/tools/exporters
+
      com/gripstudios/applications/wandora/admin/tools/extractors
+
      com/gripstudios/applications/wandora/admin/tools/importers
+
      com/gripstudios/applications/wandora/admin/tools/layers
+
      com/gripstudios/applications/wandora/admin/tools/subjects
+
      com/gripstudios/applications/wandora/admin/tools/selections
+
      com/gripstudios/applications/wandora/admin/tools/associations
+
      com/gripstudios/applications/wandora/admin/tools/generators
+
      com/gripstudios/applications/wandora/admin/tools/navigate
+
      com/gripstudios/applications/wandora/admin/tools/project
+
      com/gripstudios/applications/wandora/admin/tools/subjects
+
      com/gripstudios/applications/wandora/admin/tools/topicnames
+
      com/gripstudios/applications/fng/tools
+
  
Path list is in [[Wandora options]] file. You have to place your tool class into one of these package or you have to add new path element for your class file. If your tool class package is '''org.myproject.tools''' add element
+
* [[Tool manager]]
 
+
* [[:Category:Tools|Available tools]]
    <path15>org/myprojects/tools</path15>
+
* [[Writing your own tool]]
 
+
* [[Tool locks]]
to options. Here we assume that options already contains 14 path settings.
+
* [[Configuring tools]]
 +
* [[Additional tool help]]

Latest revision as of 14:45, 10 August 2013

To install your own tool

  • Place your tool Java class file into Wandora's tool directory, by default org/wandora/application/tools.
  • Open Wandora.
  • Open Tool manager.
  • Select generic tool set.
  • Click Add tool and select your tool in tool selector.
  • Close Tool manager.

Now your tool is available at Tools menu and ready to be executed.

[edit] Placing the tool Java class file

Tool manager scans through given paths for class files. If scanned class file implements tool interface the class is accepted as a Wandora tool. Tool manager seeks tool classes in class paths specified in the Tool manager's Paths tab. By default the Tool manager seeks tool classes in package org/wandora/application/tools.

If you add new path to Tool manager make sure the path is also Java's class path. To change class path's of Wandora you need to edit bin/SetClasspath.bat and bin/SetClasspath.sh.

[edit] See also