forester/java/src/org/forester/archaeopteryx/ArchaeopteryxA.java

   1 // $Id:
   2 // FORESTER -- software libraries and applications
   3 // for evolutionary biology research and applications.
   4 //
   5 // Copyright (C) 2008-2009 Christian M. Zmasek
   6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
   7 // All rights reserved
   8 //
   9 // This library is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU Lesser General Public
  11 // License as published by the Free Software Foundation; either
  12 // version 2.1 of the License, or (at your option) any later version.
  13 //
  14 // This library is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17 // Lesser General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU Lesser General Public
  20 // License along with this library; if not, write to the Free Software
  21 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  22 //
  23 // Contact: phylosoft @ gmail . com
  24 // WWW: https://sites.google.com/site/cmzmasek/home/software/forester
  25
  26 package org.forester.archaeopteryx;
  27
  28 import java.awt.Color;
  29 import java.awt.Font;
  30 import java.awt.Graphics;
  31 import java.awt.KeyboardFocusManager;
  32 import java.io.File;
  33 import java.net.URL;
  34
  35 import javax.swing.JApplet;
  36 import javax.swing.UIManager;
  37
  38 import org.forester.phylogeny.Phylogeny;
  39 import org.forester.util.ForesterUtil;
  40
  41 public class ArchaeopteryxA extends JApplet {
  42
  43     private static final long  serialVersionUID      = 2314899014580484146L;
  44     private final static Color background_color      = new Color( 0, 0, 0 );
  45     private final static Color font_color            = new Color( 0, 255, 0 );
  46     private final static Color ex_background_color   = new Color( 0, 0, 0 );
  47     private final static Color ex_font_color         = new Color( 255, 0, 0 );
  48     private final static Font  font                  = new Font( Configuration.getDefaultFontFamilyName(), Font.BOLD, 9 );
  49     private MainFrameApplet    _mainframe_applet;
  50     private String             _tree_url_str         = "";
  51     private String             _species_tree_url_str = "";
  52     private String             _message_1            = "";
  53     private String             _message_2            = "";
  54     public final static String NAME                  = "ArchaeopteryxA";
  55
  56     @Override
  57     public void destroy() {
  58         AptxUtil.printAppletMessage( NAME, "going to be destroyed" );
  59         if ( getMainFrameApplet() != null ) {
  60             getMainFrameApplet().close();
  61         }
  62     }
  63
  64
  65
  66     /**
  67      * This method returns the current external node data which
  68      * has been selected by the user by clicking the "Return ..."
  69      * menu item. This method is expected to be called from Javascript or
  70      * something like it.
  71      *
  72      * @return current external node data as String
  73      */
  74     public String getCurrentExternalNodesDataBuffer() {
  75         return getMainFrameApplet().getCurrentTreePanel().getCurrentExternalNodesDataBufferAsString();
  76     }
  77
  78     public int getCurrentExternalNodesDataBufferChangeCounter() {
  79         return getMainFrameApplet().getCurrentTreePanel().getCurrentExternalNodesDataBufferChangeCounter();
  80     }
  81
  82     public int getCurrentExternalNodesDataBufferLength() {
  83         return getMainFrameApplet().getCurrentTreePanel().getCurrentExternalNodesDataBufferAsString().length();
  84     }
  85
  86     public String getSpeciesTreeUrlStr() {
  87         return _species_tree_url_str;
  88     }
  89
  90     public String getTreeUrlStr() {
  91         return _tree_url_str;
  92     }
  93
  94     @Override
  95     public void init() {
  96         boolean has_exception = false;
  97         setName( NAME );
  98         setTreeUrlStr( getParameter( Constants.APPLET_PARAM_NAME_FOR_URL_OF_TREE_TO_LOAD ) );
  99         setSpeciesTreeUrlStr( getParameter( Constants.APPLET_PARAM_NAME_FOR_URL_OF_SPECIES_TREE_TO_LOAD ) );
 100         if ( !ForesterUtil.isEmpty( getTreeUrlStr() ) ) {
 101             AptxUtil.printAppletMessage( NAME, "URL of tree(s) to load: " + getTreeUrlStr() );
 102         }
 103         else {
 104             ForesterUtil.printErrorMessage( NAME, "no URL for tree(s) to load!" );
 105             setBackground( ex_background_color );
 106             setForeground( ex_font_color );
 107             has_exception = true;
 108             setMessage1( "no URL for tree(s) to load" );
 109             repaint();
 110         }
 111         if ( !ForesterUtil.isEmpty( getSpeciesTreeUrlStr() ) ) {
 112             AptxUtil.printAppletMessage( NAME, "URL of species tree to load: " + getSpeciesTreeUrlStr() );
 113         }
 114         setBackground( background_color );
 115         setForeground( font_color );
 116         setFont( font );
 117         repaint();
 118         String s = null;
 119         try {
 120             s = System.getProperty( "java.version" );
 121         }
 122         catch ( final Exception e ) {
 123             ForesterUtil.printWarningMessage( NAME, "minor error: " + e.getLocalizedMessage() );
 124         }
 125         if ( ( s != null ) && ( s.length() > 0 ) ) {
 126             setMessage2( "[Your Java version: " + s + "]" );
 127             repaint();
 128         }
 129         final String config_filename = getParameter( Constants.APPLET_PARAM_NAME_FOR_CONFIG_FILE_URL );
 130         AptxUtil.printAppletMessage( NAME, "URL for configuration file is: " + config_filename );
 131         final Configuration configuration = new Configuration( config_filename, true, true, true );
 132         try {
 133             if ( configuration.isUseNativeUI() ) {
 134                 UIManager.setLookAndFeel( UIManager.getSystemLookAndFeelClassName() );
 135             }
 136             else {
 137                 UIManager.setLookAndFeel( UIManager.getCrossPlatformLookAndFeelClassName() );
 138             }
 139             setVisible( false );
 140             _mainframe_applet = new MainFrameApplet( this, configuration, getSpeciesTreeUrlStr() );
 141             final URL tree_url = new URL( getTreeUrlStr() );
 142             final Phylogeny[] phys = AptxUtil.readPhylogeniesFromUrl( tree_url, configuration
 143                     .isValidatePhyloXmlAgainstSchema(), configuration.isReplaceUnderscoresInNhParsing(), configuration
 144                     .isInternalNumberAreConfidenceForNhParsing(), configuration.getTaxonomyExtraction(), configuration
 145                     .isMidpointReroot() );
 146             if ( phys == null ) {
 147                 ForesterUtil.printErrorMessage( NAME, "phylogenies from [" + tree_url + "] are null" );
 148             }
 149             else if ( phys.length < 1 ) {
 150                 ForesterUtil.printErrorMessage( NAME, "phylogenies from [" + tree_url + "] are empty" );
 151             }
 152             else {
 153                 AptxUtil.printAppletMessage( NAME, "loaded " + phys.length + " phylogenies from: " + tree_url );
 154             }
 155             AptxUtil.printAppletMessage( ArchaeopteryxA.NAME, "loaded " + phys.length + " phylogenies from: "
 156                     + tree_url );
 157             AptxUtil.addPhylogeniesToTabs( phys,
 158                                            new File( tree_url.getFile() ).getName(),
 159                                            getTreeUrlStr(),
 160                                            getMainFrameApplet().getConfiguration(),
 161                                            getMainFrameApplet().getMainPanel() );
 162             getMainFrameApplet().getMainPanel().getControlPanel().showWholeAll();
 163             getMainFrameApplet().getMainPanel().getControlPanel().showWhole();
 164             setVisible( true );
 165         }
 166         catch ( final Exception e ) {
 167             ForesterUtil.printErrorMessage( NAME, e.toString() );
 168             setBackground( ex_background_color );
 169             setForeground( ex_font_color );
 170             has_exception = true;
 171             setMessage1( "Exception: " + e );
 172             e.printStackTrace();
 173             repaint();
 174         }
 175         if ( !has_exception ) {
 176             setMessage1( NAME + " is now ready!" );
 177             repaint();
 178             AptxUtil.printAppletMessage( NAME, "successfully initialized" );
 179         }
 180         KeyboardFocusManager.getCurrentKeyboardFocusManager().clearGlobalFocusOwner();
 181         getMainFrameApplet().requestFocus();
 182         getMainFrameApplet().requestFocusInWindow();
 183         getMainFrameApplet().requestFocus();
 184         /* GUILHEM_BEG */
 185         final String default_relation = getParameter( Constants.APPLET_PARAM_NAME_FOR_DEFAULT_SEQUENCE_RELATION_TYPE );
 186         if ( default_relation != null ) {
 187             getMainFrameApplet().getMainPanel().getControlPanel().getSequenceRelationTypeBox()
 188                     .setSelectedItem( default_relation );
 189         }
 190         final String default_sequence = getParameter( Constants.APPLET_PARAM_NAME_FOR_DEFAULT_QUERY_SEQUENCE );
 191         if ( default_sequence != null ) {
 192             getMainFrameApplet().getMainPanel().getControlPanel().getSequenceRelationBox()
 193                     .setSelectedItem( default_sequence );
 194         }
 195         /* GUILHEM_END */
 196     }
 197
 198     /**
 199      * Prints message when initialization is finished. Called automatically.
 200      *
 201      * @param g
 202      *            Graphics
 203      */
 204     @Override
 205     public void paint( final Graphics g ) {
 206         g.setColor( background_color );
 207         g.fillRect( 0, 0, 300, 60 );
 208         g.setColor( font_color );
 209         g.drawString( getMessage2(), 10, 20 );
 210         g.drawString( getMessage1(), 10, 40 );
 211     }
 212
 213     @Override
 214     public void start() {
 215         getMainFrameApplet().getMainPanel().validate();
 216         getMainFrameApplet().requestFocus();
 217         getMainFrameApplet().requestFocusInWindow();
 218         getMainFrameApplet().requestFocus();
 219         AptxUtil.printAppletMessage( NAME, "started" );
 220     }
 221
 222     private MainFrameApplet getMainFrameApplet() {
 223         return _mainframe_applet;
 224     }
 225
 226     private String getMessage1() {
 227         return _message_1;
 228     }
 229
 230     private String getMessage2() {
 231         return _message_2;
 232     }
 233
 234     private void setMessage1( final String message_1 ) {
 235         _message_1 = message_1;
 236     }
 237
 238     private void setMessage2( final String message_2 ) {
 239         _message_2 = message_2;
 240     }
 241
 242     private void setSpeciesTreeUrlStr( final String url_string ) {
 243         _species_tree_url_str = url_string;
 244     }
 245
 246     private void setTreeUrlStr( final String url_string ) {
 247         _tree_url_str = url_string;
 248     }
 249 }