forester/java/src/org/forester/application/decorator.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: www.phylosoft.org/forester
  25
  26 package org.forester.application;
  27
  28 import java.io.File;
  29 import java.io.IOException;
  30 import java.util.ArrayList;
  31 import java.util.List;
  32 import java.util.Map;
  33
  34 import org.forester.io.parsers.PhylogenyParser;
  35 import org.forester.io.parsers.util.ParserUtils;
  36 import org.forester.io.writers.PhylogenyWriter;
  37 import org.forester.phylogeny.Phylogeny;
  38 import org.forester.phylogeny.data.Identifier;
  39 import org.forester.phylogeny.factories.ParserBasedPhylogenyFactory;
  40 import org.forester.phylogeny.factories.PhylogenyFactory;
  41 import org.forester.tools.PhylogenyDecorator;
  42 import org.forester.tools.PhylogenyDecorator.FIELD;
  43 import org.forester.util.BasicTable;
  44 import org.forester.util.BasicTableParser;
  45 import org.forester.util.CommandLineArguments;
  46 import org.forester.util.ForesterUtil;
  47
  48 public final class decorator {
  49
  50     private static final String SEQUENCE_NAME_FIELD                    = "s";
  51     private static final String TAXONOMY_CODE_FIELD                    = "c";
  52     private static final String TAXONOMY_SCIENTIFIC_NAME_FIELD         = "sn";
  53     private static final String DS_FILED                               = "d";
  54     private static final String SEQUENCE_ANNOTATION_DESC               = "a";
  55     private static final String NODE_NAME_FIELD                        = "n";
  56     final static private String PICKY_OPTION                           = "p";
  57     final static private String FIELD_OPTION                           = "f";
  58     final static private String TRIM_AFTER_TILDE_OPTION                = "t";
  59     final static private String MOVE_DOMAIN_NUMBER_OPTION              = "mdn";       // Hidden expert option.
  60     final static private String TREE_NAME_OPTION                       = "pn";
  61     final static private String TREE_ID_OPTION                         = "pi";
  62     final static private String TREE_DESC_OPTION                       = "pd";
  63     final static private String EXTRACT_BRACKETED_SCIENTIC_NAME_OPTION = "sn";
  64     final static private String PROCESS_NAME_INTELLIGENTLY_OPTION      = "x";
  65     final static private String PROCESS_SIMILAR_TO_OPTION              = "xs";
  66     final static private String CUT_NAME_AFTER_FIRST_SPACE_OPTION      = "c";
  67     final static private String ALLOW_REMOVAL_OF_CHARS_OPTION          = "r";
  68     final static private String ADVANCED_TABLE_OPTION                  = "table";
  69     final static private String KEY_COLUMN                             = "k";
  70     final static private String VALUE_COLUMN                           = "v";
  71     final static private String MAPPING_FILE_SEPARATOR_OPTION          = "s";
  72     final static private String MAPPING_FILE_SEPARATOR_DEFAULT         = ": ";
  73     final static private String PRG_NAME                               = "decorator";
  74     final static private String PRG_VERSION                            = "1.11";
  75     final static private String PRG_DATE                               = "2012.09.15";
  76
  77     private static void argumentsError() {
  78         System.out.println();
  79         System.out.println( decorator.PRG_NAME + " -" + ADVANCED_TABLE_OPTION + " | -f=<c> <phylogenies infile> "
  80                 + "[mapping table file] <phylogenies outfile>" );
  81         System.out.println();
  82         System.out.println( "options:" );
  83         System.out.println();
  84         System.out.println( " -" + ADVANCED_TABLE_OPTION + " : table instead of one to one map (-f=<c>)" );
  85         System.out.println( " -r=<n> : allow to remove up to n characters from the end of the names" );
  86         System.out.println( "          in phylogenies infile if not found (in map) otherwise" );
  87         System.out.println( " -p     : picky, fails if node name not found in mapping table" );
  88         System.out.println( " -" + TREE_NAME_OPTION + "=<s>: name for the phylogeny" );
  89         System.out.println( " -" + TREE_ID_OPTION + "=<s>: identifier for the phylogeny (in the form provider:value)" );
  90         System.out.println( " -" + TREE_DESC_OPTION + "=<s>: description for phylogenies" );
  91         System.out.println();
  92         System.out.println();
  93         System.out.println( "advanced options, only available if -" + ADVANCED_TABLE_OPTION + " is not used:" );
  94         System.out.println();
  95         System.out.println( " -f=<c> : field to be replaced: " + NODE_NAME_FIELD + " : node name" );
  96         System.out.println( "                                " + SEQUENCE_ANNOTATION_DESC
  97                 + " : sequence annotation description" );
  98         System.out.println( "                                " + DS_FILED + " : domain structure" );
  99         System.out.println( "                                " + TAXONOMY_CODE_FIELD + " : taxonomy code" );
 100         System.out.println( "                                " + TAXONOMY_SCIENTIFIC_NAME_FIELD
 101                 + ": taxonomy scientific name" );
 102         System.out.println( "                                " + SEQUENCE_NAME_FIELD + " : sequence name" );
 103         System.out.println( " -k=<n> : key column in mapping table (0 based)," );
 104         System.out.println( "          names of the node to be decorated - default is 0" );
 105         System.out.println( " -v=<n> : value column in mapping table (0 based)," );
 106         System.out.println( "          data which with to decorate - default is 1" );
 107         System.out.println( " -" + EXTRACT_BRACKETED_SCIENTIC_NAME_OPTION
 108                 + "    : to extract bracketed scientific names" );
 109         System.out.println( " -s=<c> : column separator in mapping file, default is \""
 110                 + decorator.MAPPING_FILE_SEPARATOR_DEFAULT + "\"" );
 111         System.out.println( " -x     : process name \"intelligently\" (only for -f=n)" );
 112         System.out.println( " -" + decorator.PROCESS_SIMILAR_TO_OPTION
 113                 + "    : process name \"intelligently\" and process information after \"similar to\" (only for -f=n)" );
 114         System.out.println( " -c     : cut name after first space (only for -f=n)" );
 115         System.out.println( " -" + decorator.TRIM_AFTER_TILDE_OPTION
 116                 + "     : trim node name to be replaced after tilde" );
 117         System.out.println();
 118         System.exit( -1 );
 119     }
 120
 121     public static void main( final String args[] ) {
 122         ForesterUtil.printProgramInformation( decorator.PRG_NAME, decorator.PRG_VERSION, decorator.PRG_DATE );
 123         if ( ( args.length < 4 ) || ( args.length > 12 ) ) {
 124             decorator.argumentsError();
 125         }
 126         CommandLineArguments cla = null;
 127         try {
 128             cla = new CommandLineArguments( args );
 129         }
 130         catch ( final Exception e ) {
 131             ForesterUtil.fatalError( PRG_NAME, e.getMessage() );
 132         }
 133         if ( ( cla.getNumberOfNames() < 3 ) || ( cla.getNumberOfNames() > 4 ) ) {
 134             decorator.argumentsError();
 135         }
 136         final File phylogenies_infile = cla.getFile( 0 );
 137         final File mapping_infile = cla.getFile( 1 );
 138         final File phylogenies_outfile = cla.getFile( 2 );
 139         if ( phylogenies_outfile.exists() ) {
 140             ForesterUtil.fatalError( PRG_NAME, "[" + phylogenies_outfile + "] already exists" );
 141         }
 142         final List<String> allowed_options = new ArrayList<String>();
 143         allowed_options.add( decorator.ADVANCED_TABLE_OPTION );
 144         allowed_options.add( decorator.PICKY_OPTION );
 145         allowed_options.add( decorator.FIELD_OPTION );
 146         allowed_options.add( decorator.PROCESS_NAME_INTELLIGENTLY_OPTION );
 147         allowed_options.add( decorator.PROCESS_SIMILAR_TO_OPTION );
 148         allowed_options.add( decorator.CUT_NAME_AFTER_FIRST_SPACE_OPTION );
 149         allowed_options.add( decorator.ALLOW_REMOVAL_OF_CHARS_OPTION );
 150         allowed_options.add( decorator.KEY_COLUMN );
 151         allowed_options.add( decorator.VALUE_COLUMN );
 152         allowed_options.add( decorator.MAPPING_FILE_SEPARATOR_OPTION );
 153         allowed_options.add( decorator.EXTRACT_BRACKETED_SCIENTIC_NAME_OPTION );
 154         allowed_options.add( decorator.TREE_NAME_OPTION );
 155         allowed_options.add( decorator.TREE_ID_OPTION );
 156         allowed_options.add( decorator.TREE_DESC_OPTION );
 157         allowed_options.add( decorator.MOVE_DOMAIN_NUMBER_OPTION );
 158         allowed_options.add( decorator.TRIM_AFTER_TILDE_OPTION );
 159         final String dissallowed_options = cla.validateAllowedOptionsAsString( allowed_options );
 160         if ( dissallowed_options.length() > 0 ) {
 161             ForesterUtil.fatalError( decorator.PRG_NAME, "unknown option(s): " + dissallowed_options );
 162         }
 163         final boolean advanced_table = cla.isOptionSet( decorator.ADVANCED_TABLE_OPTION );
 164         if ( !advanced_table ) {
 165             final List<String> mandatory_options = new ArrayList<String>();
 166             mandatory_options.add( decorator.FIELD_OPTION );
 167             final String missing_options = cla.validateMandatoryOptionsAsString( mandatory_options );
 168             if ( missing_options.length() > 0 ) {
 169                 ForesterUtil.fatalError( decorator.PRG_NAME, "missing option(s): " + missing_options );
 170             }
 171         }
 172         final boolean picky = cla.isOptionSet( decorator.PICKY_OPTION );
 173         String separator = decorator.MAPPING_FILE_SEPARATOR_DEFAULT;
 174         if ( cla.isOptionSet( decorator.MAPPING_FILE_SEPARATOR_OPTION ) ) {
 175             if ( advanced_table ) {
 176                 argumentsError();
 177             }
 178             separator = cla.getOptionValue( decorator.MAPPING_FILE_SEPARATOR_OPTION );
 179         }
 180         int key_column = 0;
 181         int value_column = 1;
 182         String field_str = "";
 183         FIELD field = FIELD.NODE_NAME;
 184         int numbers_of_chars_allowed_to_remove_if_not_found_in_map = -1;
 185         boolean cut_name_after_space = false;
 186         boolean process_name_intelligently = false;
 187         boolean process_similar_to = false;
 188         boolean extract_bracketed_scientific_name = false;
 189         boolean move_domain_numbers_at_end_to_middle = false;
 190         boolean trim_after_tilde = false;
 191         String tree_name = "";
 192         String tree_id = "";
 193         String tree_desc = "";
 194         try {
 195             if ( cla.isOptionSet( decorator.TREE_NAME_OPTION ) ) {
 196                 tree_name = cla.getOptionValueAsCleanString( decorator.TREE_NAME_OPTION );
 197             }
 198             if ( cla.isOptionSet( decorator.TREE_ID_OPTION ) ) {
 199                 tree_id = cla.getOptionValueAsCleanString( decorator.TREE_ID_OPTION );
 200             }
 201             if ( cla.isOptionSet( decorator.TREE_DESC_OPTION ) ) {
 202                 tree_desc = cla.getOptionValueAsCleanString( decorator.TREE_DESC_OPTION );
 203             }
 204             if ( cla.isOptionSet( decorator.EXTRACT_BRACKETED_SCIENTIC_NAME_OPTION ) ) {
 205                 if ( advanced_table ) {
 206                     argumentsError();
 207                 }
 208                 extract_bracketed_scientific_name = true;
 209             }
 210             if ( cla.isOptionSet( decorator.KEY_COLUMN ) ) {
 211                 if ( advanced_table ) {
 212                     argumentsError();
 213                 }
 214                 key_column = cla.getOptionValueAsInt( decorator.KEY_COLUMN );
 215             }
 216             if ( cla.isOptionSet( decorator.VALUE_COLUMN ) ) {
 217                 if ( advanced_table ) {
 218                     argumentsError();
 219                 }
 220                 value_column = cla.getOptionValueAsInt( decorator.VALUE_COLUMN );
 221             }
 222             if ( cla.isOptionSet( decorator.CUT_NAME_AFTER_FIRST_SPACE_OPTION ) ) {
 223                 if ( advanced_table ) {
 224                     argumentsError();
 225                 }
 226                 cut_name_after_space = true;
 227             }
 228             if ( cla.isOptionSet( decorator.PROCESS_NAME_INTELLIGENTLY_OPTION ) ) {
 229                 if ( advanced_table ) {
 230                     argumentsError();
 231                 }
 232                 process_name_intelligently = true;
 233             }
 234             if ( cla.isOptionSet( decorator.PROCESS_SIMILAR_TO_OPTION ) ) {
 235                 if ( advanced_table ) {
 236                     argumentsError();
 237                 }
 238                 process_similar_to = true;
 239             }
 240             if ( cla.isOptionSet( decorator.TRIM_AFTER_TILDE_OPTION ) ) {
 241                 if ( advanced_table ) {
 242                     argumentsError();
 243                 }
 244                 trim_after_tilde = true;
 245             }
 246             if ( cla.isOptionSet( decorator.ALLOW_REMOVAL_OF_CHARS_OPTION ) ) {
 247                 numbers_of_chars_allowed_to_remove_if_not_found_in_map = cla
 248                         .getOptionValueAsInt( decorator.ALLOW_REMOVAL_OF_CHARS_OPTION );
 249             }
 250             if ( cla.isOptionSet( decorator.MOVE_DOMAIN_NUMBER_OPTION ) ) {
 251                 move_domain_numbers_at_end_to_middle = true;
 252             }
 253             if ( cla.isOptionSet( decorator.FIELD_OPTION ) ) {
 254                 field_str = cla.getOptionValue( decorator.FIELD_OPTION );
 255                 if ( field_str.equals( NODE_NAME_FIELD ) ) {
 256                     field = FIELD.NODE_NAME;
 257                 }
 258                 else if ( field_str.equals( SEQUENCE_ANNOTATION_DESC ) ) {
 259                     field = FIELD.SEQUENCE_ANNOTATION_DESC;
 260                 }
 261                 else if ( field_str.equals( DS_FILED ) ) {
 262                     field = FIELD.DOMAIN_STRUCTURE;
 263                     extract_bracketed_scientific_name = false;
 264                 }
 265                 else if ( field_str.equals( TAXONOMY_CODE_FIELD ) ) {
 266                     field = FIELD.TAXONOMY_CODE;
 267                 }
 268                 else if ( field_str.equals( SEQUENCE_NAME_FIELD ) ) {
 269                     field = FIELD.SEQUENCE_NAME;
 270                 }
 271                 else if ( field_str.equals( TAXONOMY_SCIENTIFIC_NAME_FIELD ) ) {
 272                     field = FIELD.TAXONOMY_SCIENTIFIC_NAME;
 273                     extract_bracketed_scientific_name = false;
 274                 }
 275                 else {
 276                     ForesterUtil.fatalError( decorator.PRG_NAME, "unknown value for \"" + decorator.FIELD_OPTION
 277                             + "\" option: \"" + field_str + "\"" );
 278                 }
 279             }
 280         }
 281         catch ( final Exception e ) {
 282             ForesterUtil.fatalError( decorator.PRG_NAME, "error in command line: " + e.getMessage() );
 283         }
 284         if ( ( field != FIELD.NODE_NAME ) && ( cut_name_after_space || process_name_intelligently ) ) {
 285             ForesterUtil.fatalError( decorator.PRG_NAME, "attempt to use -x or -c option without -f=n" );
 286         }
 287         if ( ( field != FIELD.NODE_NAME ) && process_similar_to ) {
 288             ForesterUtil.fatalError( decorator.PRG_NAME, "attempt to use -" + decorator.PROCESS_SIMILAR_TO_OPTION
 289                     + " option without -f=n" );
 290         }
 291         if ( cut_name_after_space && process_name_intelligently ) {
 292             ForesterUtil.fatalError( decorator.PRG_NAME, "attempt to use -x and -c option together" );
 293         }
 294         if ( process_similar_to && process_name_intelligently ) {
 295             ForesterUtil.fatalError( decorator.PRG_NAME, "attempt to use -" + decorator.PROCESS_SIMILAR_TO_OPTION
 296                     + " and -x option together" );
 297         }
 298         if ( process_similar_to && cut_name_after_space ) {
 299             ForesterUtil.fatalError( decorator.PRG_NAME, "attempt to use -" + decorator.PROCESS_SIMILAR_TO_OPTION
 300                     + " and -c option together" );
 301         }
 302         Phylogeny[] phylogenies = null;
 303         try {
 304             final PhylogenyFactory factory = ParserBasedPhylogenyFactory.getInstance();
 305             final PhylogenyParser pp = ParserUtils.createParserDependingOnFileType( phylogenies_infile, true );
 306             phylogenies = factory.create( phylogenies_infile, pp );
 307         }
 308         catch ( final Exception e ) {
 309             ForesterUtil.fatalError( decorator.PRG_NAME, "failed to read phylgenies from [" + phylogenies_infile
 310                     + "] [" + e.getMessage() + "]" );
 311         }
 312         Map<String, String> map = null;
 313         if ( !advanced_table ) {
 314             BasicTable<String> mapping_table = null;
 315             try {
 316                 mapping_table = BasicTableParser.parse( mapping_infile, separator, false, true );
 317             }
 318             catch ( final Exception e ) {
 319                 ForesterUtil.fatalError( decorator.PRG_NAME,
 320                                          "failed to read [" + mapping_infile + "] [" + e.getMessage() + "]" );
 321             }
 322             if ( ( key_column < 0 ) || ( key_column >= mapping_table.getNumberOfColumns() ) ) {
 323                 ForesterUtil.fatalError( decorator.PRG_NAME, "illegal value for key column" );
 324             }
 325             if ( ( value_column < 0 ) || ( value_column >= mapping_table.getNumberOfColumns() ) ) {
 326                 ForesterUtil.fatalError( decorator.PRG_NAME, "illegal value for value column" );
 327             }
 328             map = mapping_table.getColumnsAsMap( key_column, value_column );
 329         }
 330         if ( !ForesterUtil.isEmpty( tree_name ) || !ForesterUtil.isEmpty( tree_id )
 331                 || !ForesterUtil.isEmpty( tree_desc ) ) {
 332             if ( ( phylogenies.length > 1 )
 333                     && ( !ForesterUtil.isEmpty( tree_name ) || !ForesterUtil.isEmpty( tree_id ) ) ) {
 334                 ForesterUtil.fatalError( decorator.PRG_NAME,
 335                                          "attempt to set same name or id on more than one phylogeny" );
 336             }
 337             if ( !ForesterUtil.isEmpty( tree_name ) ) {
 338                 phylogenies[ 0 ].setName( tree_name );
 339             }
 340             if ( !ForesterUtil.isEmpty( tree_id ) ) {
 341                 final String[] s_ary = tree_id.split( ":" );
 342                 phylogenies[ 0 ].setIdentifier( new Identifier( s_ary[ 1 ], s_ary[ 0 ] ) );
 343             }
 344             if ( !ForesterUtil.isEmpty( tree_desc ) ) {
 345                 for( int i = 0; i < phylogenies.length; ++i ) {
 346                     phylogenies[ i ].setDescription( tree_desc );
 347                 }
 348             }
 349         }
 350         try {
 351             if ( advanced_table ) {
 352                 Map<String, Map<String, String>> table = null;
 353                 try {
 354                     table = PhylogenyDecorator.parseMappingTable( mapping_infile );
 355                 }
 356                 catch ( final IOException e ) {
 357                     ForesterUtil.fatalError( decorator.PRG_NAME,
 358                                              "failed to read \"" + mapping_infile + "\" [" + e.getMessage() + "]" );
 359                 }
 360                 PhylogenyDecorator.decorate( phylogenies,
 361                                              table,
 362                                              picky,
 363                                              numbers_of_chars_allowed_to_remove_if_not_found_in_map );
 364             }
 365             else {
 366                 PhylogenyDecorator.decorate( phylogenies,
 367                                              map,
 368                                              field,
 369                                              extract_bracketed_scientific_name,
 370                                              picky,
 371                                              cut_name_after_space,
 372                                              process_name_intelligently,
 373                                              process_similar_to,
 374                                              numbers_of_chars_allowed_to_remove_if_not_found_in_map,
 375                                              move_domain_numbers_at_end_to_middle,
 376                                              trim_after_tilde );
 377             }
 378         }
 379         catch ( final NullPointerException e ) {
 380             ForesterUtil.unexpectedFatalError( decorator.PRG_NAME, e );
 381         }
 382         catch ( final Exception e ) {
 383             ForesterUtil.fatalError( decorator.PRG_NAME, e.getLocalizedMessage() );
 384         }
 385         try {
 386             final PhylogenyWriter w = new PhylogenyWriter();
 387             w.toPhyloXML( phylogenies, 0, phylogenies_outfile, ForesterUtil.getLineSeparator() );
 388         }
 389         catch ( final IOException e ) {
 390             ForesterUtil.fatalError( decorator.PRG_NAME, "failed to write output [" + e.getMessage() + "]" );
 391         }
 392         System.out.println();
 393         ForesterUtil.programMessage( PRG_NAME, "wrote: " + phylogenies_outfile );
 394         ForesterUtil.programMessage( PRG_NAME, "OK." );
 395     }
 396 }