33815abeaf379cbd84dd75389fe464bc77aa7edf
[jalview.git] / forester / java / src / org / forester / go / PfamToGoMapping.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.go;
27
28 public class PfamToGoMapping implements Mapping {
29
30     private final String _pfam_domain_id;
31     private final GoId   _go_id;
32
33     public PfamToGoMapping( final String pfam_domain_id, final GoId go_id ) {
34         _pfam_domain_id = pfam_domain_id;
35         _go_id = go_id;
36     }
37
38     @Override
39     public int compareTo( final Mapping m ) {
40         if ( this == m ) {
41             return 0;
42         }
43         return getKey().compareTo( ( String ) m.getKey() );
44     }
45
46     /**
47      * Based on key and value.
48      * 
49      * 
50      */
51     @Override
52     public boolean equals( final Object o ) {
53         if ( this == o ) {
54             return true;
55         }
56         else if ( o == null ) {
57             throw new IllegalArgumentException( "attempt to check pfam to go mapping equality to null" );
58         }
59         else if ( o.getClass() != this.getClass() ) {
60             throw new IllegalArgumentException( "attempt to check pfam to go mapping equality to " + o + " ["
61                     + o.getClass() + "]" );
62         }
63         else {
64             return getKey().equals( ( ( PfamToGoMapping ) o ).getKey() )
65                     && getValue().equals( ( ( PfamToGoMapping ) o ).getValue() );
66         }
67     }
68
69     @Override
70     public String getKey() {
71         return _pfam_domain_id;
72     }
73
74     @Override
75     public GoId getValue() {
76         return _go_id;
77     }
78
79     @Override
80     public String toString() {
81         final StringBuffer sb = new StringBuffer();
82         sb.append( getKey().toString() );
83         sb.append( " > " );
84         sb.append( getValue().toString() );
85         return sb.toString();
86     }
87 }