initial commit
[jalview.git] / 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 {
59             throw new IllegalArgumentException( "unknown GO subset type: " + my_s );
60         }
61     }
62
63     public BasicGoSubset( final Type type ) {
64         _type = type;
65     }
66
67     public int compareTo( final GoSubset sub ) {
68         return getType().compareTo( sub.getType() );
69     }
70
71     @Override
72     public boolean equals( final Object o ) {
73         if ( this == o ) {
74             return true;
75         }
76         else if ( o == null ) {
77             throw new IllegalArgumentException( "attempt to check go subset equality to null" );
78         }
79         else if ( o.getClass() != this.getClass() ) {
80             throw new IllegalArgumentException( "attempt to check go subset equality to " + o + " [" + o.getClass()
81                     + "]" );
82         }
83         else {
84             return ( getType() == ( ( GoSubset ) o ).getType() );
85         }
86     }
87
88     public Type getType() {
89         return _type;
90     }
91
92     @Override
93     public String toString() {
94         final StringBuilder sb = new StringBuilder();
95         switch ( getType() ) {
96             case GOSLIM_CANDIDA:
97                 sb.append( GOSLIM_CANDIDA_STR );
98                 break;
99             case GOSLIM_GENERIC:
100                 sb.append( GOSLIM_GENERIC_STR );
101                 break;
102             case GOSLIM_GOA:
103                 sb.append( GOSLIM_GOA_STR );
104                 break;
105             case GOSLIM_PIR:
106                 sb.append( GOSLIM_PIR_STR );
107                 break;
108             case GOSLIM_PLANT:
109                 sb.append( GOSLIM_PLANT_STR );
110                 break;
111             case GOSLIM_YEAST:
112                 sb.append( GOSLIM_YEAST_STR );
113                 break;
114             case GOSUBSET_PROK:
115                 sb.append( GOSUBSET_PROK_STR );
116                 break;
117             case GOSLIM_POMBE:
118                 sb.append( GOSLIM_POMBE_STR );
119                 break;
120             default:
121                 new AssertionError( "unknown type: " + getType() );
122         }
123         return sb.toString();
124     }
125 }