forester/java/src/org/forester/util/BasicTableParser.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.util;
  27
  28 import java.io.BufferedReader;
  29 import java.io.IOException;
  30 import java.util.ArrayList;
  31 import java.util.List;
  32 import java.util.StringTokenizer;
  33
  34 public class BasicTableParser {
  35
  36     private final static String START_OF_COMMENT_LINE_DEFAULT = "#";
  37
  38     private BasicTableParser() {
  39     }
  40
  41     public static BasicTable<String> parse( final Object source, final String column_delimiter ) throws IOException {
  42         return BasicTableParser.parse( source, column_delimiter, false, START_OF_COMMENT_LINE_DEFAULT, false ).get( 0 );
  43     }
  44
  45     public static BasicTable<String> parse( final Object source,
  46                                             final String column_delimiter,
  47                                             final boolean use_first_separator_only ) throws IOException {
  48         return BasicTableParser.parse( source,
  49                                        column_delimiter,
  50                                        use_first_separator_only,
  51                                        START_OF_COMMENT_LINE_DEFAULT,
  52                                        false ).get( 0 );
  53     }
  54
  55     public static List<BasicTable<String>> parse( final Object source,
  56                                                   final String column_delimiter,
  57                                                   final boolean use_first_separator_only,
  58                                                   final String start_of_comment_line,
  59                                                   final boolean tables_separated_by_single_string_line )
  60             throws IOException {
  61         final BufferedReader reader = ForesterUtil.obtainReader( source );
  62         final List<BasicTable<String>> tables = new ArrayList<BasicTable<String>>();
  63         BasicTable<String> table = new BasicTable<String>();
  64         int row = 0;
  65         String line;
  66         boolean saw_first_table = false;
  67         final boolean use_start_of_comment_line = !( ForesterUtil.isEmpty( start_of_comment_line ) );
  68         while ( ( line = reader.readLine() ) != null ) {
  69             line = line.trim();
  70             if ( !ForesterUtil.isEmpty( line )
  71                     && ( ( ( line.charAt( 0 ) == '"' ) && ( line.charAt( line.length() - 1 ) == '"' ) && ( ForesterUtil
  72                             .countChars( line, '"' ) == 2 ) ) || ( ( line.charAt( 0 ) == '\'' )
  73                             && ( line.charAt( line.length() - 1 ) == '\'' ) && ( ForesterUtil.countChars( line, '\'' ) == 2 ) ) ) ) {
  74                 line = line.substring( 1, line.length() - 1 ).trim();
  75             }
  76             if ( saw_first_table
  77                     && ( ForesterUtil.isEmpty( line ) || ( tables_separated_by_single_string_line && ( line
  78                             .indexOf( column_delimiter ) < 0 ) ) ) ) {
  79                 if ( !table.isEmpty() ) {
  80                     tables.add( table );
  81                 }
  82                 table = new BasicTable<String>();
  83                 row = 0;
  84             }
  85             else if ( !ForesterUtil.isEmpty( line )
  86                     && ( !use_start_of_comment_line || !line.startsWith( start_of_comment_line ) ) ) {
  87                 saw_first_table = true;
  88                 final StringTokenizer st = new StringTokenizer( line, column_delimiter );
  89                 int col = 0;
  90                 if ( st.hasMoreTokens() ) {
  91                     table.setValue( col++, row, st.nextToken().trim() );
  92                 }
  93                 if ( !use_first_separator_only ) {
  94                     while ( st.hasMoreTokens() ) {
  95                         table.setValue( col++, row, st.nextToken().trim() );
  96                     }
  97                 }
  98                 else {
  99                     final StringBuffer rest = new StringBuffer();
 100                     while ( st.hasMoreTokens() ) {
 101                         rest.append( st.nextToken() );
 102                     }
 103                     table.setValue( col++, row, rest.toString().trim() );
 104                 }
 105                 ++row;
 106             }
 107         }
 108         if ( !table.isEmpty() ) {
 109             tables.add( table );
 110         }
 111         reader.close();
 112         return tables;
 113     }
 114 }