forester/java/src/org/forester/go/GoId.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 import java.util.regex.Matcher;
  29 import java.util.regex.Pattern;
  30
  31 public class GoId implements Comparable<GoId> {
  32
  33     private static final int     SIZE       = 10;
  34     private static final String  GO_PREFIX  = "GO:";
  35     private static final String  GO_FORMAT  = GO_PREFIX + "\\d{7}";
  36     private static final Pattern GO_PATTERN = Pattern.compile( GO_FORMAT );
  37     private final String         _id;
  38
  39     public GoId( final String id ) {
  40         if ( id.length() != SIZE ) {
  41             throw new IllegalArgumentException( "unexpected format for GO id: " + id );
  42         }
  43         final Matcher m = GO_PATTERN.matcher( id );
  44         if ( !m.matches() ) {
  45             throw new IllegalArgumentException( "unexpected format for GO id: " + id );
  46         }
  47         _id = id.substring( 3 );
  48     }
  49
  50     public int compareTo( final GoId id ) {
  51         return getId().compareTo( id.getId() );
  52     }
  53
  54     @Override
  55     public boolean equals( final Object o ) {
  56         if ( this == o ) {
  57             return true;
  58         }
  59         else if ( o == null ) {
  60             throw new IllegalArgumentException( "attempt to check go id equality to null" );
  61         }
  62         else if ( o.getClass() != this.getClass() ) {
  63             throw new IllegalArgumentException( "attempt to check go id equality to " + o + " [" + o.getClass() + "]" );
  64         }
  65         else {
  66             return getId().equals( ( ( GoId ) o ).getId() );
  67         }
  68     }
  69
  70     public String getId() {
  71         return GO_PREFIX + _id;
  72     }
  73
  74     @Override
  75     public int hashCode() {
  76         return getId().hashCode();
  77     }
  78
  79     @Override
  80     public String toString() {
  81         return getId();
  82     }
  83 }