doc/AddingGroovySupport.html

   1 <html>
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   4  * Copyright (C) $$Year-Rel$$ 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 Groovy Support in Jalview
  25 </h1>
  26 <p>
  27   <a href="http://www.groovy-lang.org">Groovy</a> has been bundled with the Jalview desktop since circa 2012. The program supports interactive execution of groovy scripts via the Groovy Console, and command line execution via the '-groovy' option. The main source for documentation about Groovy in Jalview is the <a href="http://www.jalview.org/help/html/features/groovy.html">online help pages</a>.
  28 </p>
  29 <p>Here are some scripts to get you started:</p>
  30 <ul><li>Getting the title, alignment and first sequence from the current alignFrame<br>
  31 <pre>
  32 def alf = Jalview.getAlignFrames();
  33 print alf[0].getTitle();
  34 def alignment = alf[0].viewport.alignment;
  35 def seq = alignment.getSequenceAt(0);
  36 </pre>
  37 </li>
  38 </ul>
  39 <h2>TODO</h2>
  40 <p>
  41 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>
  42 <h3>Making it easier</h3>
  43 <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.
  44 </p>
  45 </body>
  46 </html>
  47