forester/java/src/org/forester/go/BasicGoSubset.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.go;
  27
  28 public class BasicGoSubset implements GoSubset {
  29
  30     final Type _type;
  31
  32     public BasicGoSubset( final String s ) {
  33         final String my_s = s.trim().toLowerCase();
  34         if ( my_s.equals( GOSLIM_GENERIC_STR ) ) {
  35             _type = Type.GOSLIM_GENERIC;
  36         }
  37         else if ( my_s.equals( GOSLIM_GOA_STR ) ) {
  38             _type = Type.GOSLIM_GOA;
  39         }
  40         else if ( my_s.equals( GOSLIM_PIR_STR ) ) {
  41             _type = Type.GOSLIM_PIR;
  42         }
  43         else if ( my_s.equals( GOSUBSET_PROK_STR ) ) {
  44             _type = Type.GOSUBSET_PROK;
  45         }
  46         else if ( my_s.equals( GOSLIM_CANDIDA_STR ) ) {
  47             _type = Type.GOSLIM_CANDIDA;
  48         }
  49         else if ( my_s.equals( GOSLIM_PLANT_STR ) ) {
  50             _type = Type.GOSLIM_PLANT;
  51         }
  52         else if ( my_s.equals( GOSLIM_YEAST_STR ) ) {
  53             _type = Type.GOSLIM_YEAST;
  54         }
  55         else if ( my_s.equals( GOSLIM_POMBE_STR ) ) {
  56             _type = Type.GOSLIM_POMBE;
  57         }
  58         else if ( my_s.equals( HIGH_LEVEL_ANNOTATION_QC_STR ) ) {
  59             _type = Type.HIGH_LEVEL_ANNOTATION_QC;
  60         }
  61         else if ( my_s.equals( UNVETTED_STR ) ) {
  62             _type = Type.UNVETTED;
  63         }
  64         else {
  65             throw new IllegalArgumentException( "unknown GO subset type: " + my_s );
  66         }
  67     }
  68
  69     public BasicGoSubset( final Type type ) {
  70         _type = type;
  71     }
  72
  73     @Override
  74     public int compareTo( final GoSubset sub ) {
  75         return getType().compareTo( sub.getType() );
  76     }
  77
  78     @Override
  79     public boolean equals( final Object o ) {
  80         if ( this == o ) {
  81             return true;
  82         }
  83         else if ( o == null ) {
  84             throw new IllegalArgumentException( "attempt to check go subset equality to null" );
  85         }
  86         else if ( o.getClass() != this.getClass() ) {
  87             throw new IllegalArgumentException( "attempt to check go subset equality to " + o + " [" + o.getClass()
  88                     + "]" );
  89         }
  90         else {
  91             return ( getType() == ( ( GoSubset ) o ).getType() );
  92         }
  93     }
  94
  95     @Override
  96     public Type getType() {
  97         return _type;
  98     }
  99
 100     @Override
 101     public String toString() {
 102         final StringBuilder sb = new StringBuilder();
 103         switch ( getType() ) {
 104             case GOSLIM_CANDIDA:
 105                 sb.append( GOSLIM_CANDIDA_STR );
 106                 break;
 107             case GOSLIM_GENERIC:
 108                 sb.append( GOSLIM_GENERIC_STR );
 109                 break;
 110             case GOSLIM_GOA:
 111                 sb.append( GOSLIM_GOA_STR );
 112                 break;
 113             case GOSLIM_PIR:
 114                 sb.append( GOSLIM_PIR_STR );
 115                 break;
 116             case GOSLIM_PLANT:
 117                 sb.append( GOSLIM_PLANT_STR );
 118                 break;
 119             case GOSLIM_YEAST:
 120                 sb.append( GOSLIM_YEAST_STR );
 121                 break;
 122             case GOSUBSET_PROK:
 123                 sb.append( GOSUBSET_PROK_STR );
 124                 break;
 125             case GOSLIM_POMBE:
 126                 sb.append( GOSLIM_POMBE_STR );
 127                 break;
 128             default:
 129                 new AssertionError( "unknown type: " + getType() );
 130         }
 131         return sb.toString();
 132     }
 133 }