doc/AddingGroovySupport.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.9)
   4  * Copyright (C) 2015 The Jalview Authors
   5  *
   6  * This file is part of Jalview.
   7  *
   8  * Jalview is free software: you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  18  * The Jalview Authors are detailed in the 'AUTHORS' file.
  19 -->
  20 <title>Adding Groovy Support to Jalview
  21 </title>
  22 <body>
  23 <h1>
  24 Adding Groovy Support to Jalview
  25 </h1>
  26 <p>
  27 There is currently no scripting language
  28 extension within Jalview, in part because a
  29 scripting API has not yet been developed.
  30 </p>
  31 <p>It is, however, really easy to embed scripting
  32 engines like groovy. If groovy is detected on the
  33 classpath, a new menu entry on the Desktop's Tools
  34 menu will open the GroovyShell.
  35 </p>
  36 <p>Here are some scripts to get you started:</p>
  37 <ul><li>Getting the title, alignment and first sequence from the current alignFrame<br>
  38 <pre>
  39 def alf = Jalview.getAlignframes();
  40 print alf[0].getTitle();
  41 def alignment = alf[0].viewport.alignment;
  42 def seq = alignment.getSequenceAt(0);
  43 </pre>
  44 </li>
  45 </ul>
  46 <h1>Getting Groovy...</h1>
  47 <p>
  48 You need the core groovy jars which include the GroovyShell. The easiest way of doing
  49 this is to add the groovy-all-*.jar to the lib directory whose path is given in the java.ext.dirs property.</p>
  50 <p>The is obtained from the <em>embedded</em> directory within the <a
  51 href="http://dist.codehaus.org/groovy/distributions"/>groovy distribution</a>).
  52 </p>
  53 <h2>TODO</h2>
  54 <p>
  55 Using Java class methods from Groovy is straightforward, but currently, there isn't a set of easy to use methods for the jalview objects. A Jalview Scripting API needs to be developed to make this easier.</p>
  56 <h3>Making it easier</h3>
  57 <p>jalview.bin.JalviewScript could be a top level jalview instance of a script execution thread, creating and maintaining the context for scripts operating on the jalview datamodel and interfacing with the Jalview GUI.
  58 </p>
  59 </body>
  60 </html>
  61