2 // FORESTER -- software libraries and applications
3 // for evolutionary biology research and applications.
5 // Copyright (C) 2008-2009 Christian M. Zmasek
6 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
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.
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.
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
23 // Contact: phylosoft @ gmail . com
24 // WWW: www.phylosoft.org/forester
26 package org.forester.go;
28 import java.util.regex.Matcher;
29 import java.util.regex.Pattern;
31 public class GoId implements Comparable<GoId> {
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;
39 public GoId( final String id ) {
40 if ( id.length() != SIZE ) {
41 throw new IllegalArgumentException( "unexpected format for GO id: " + id );
43 final Matcher m = GO_PATTERN.matcher( id );
45 throw new IllegalArgumentException( "unexpected format for GO id: " + id );
47 _id = id.substring( 3 );
51 public int compareTo( final GoId id ) {
52 return getId().compareTo( id.getId() );
56 public boolean equals( final Object o ) {
60 else if ( o == null ) {
61 throw new IllegalArgumentException( "attempt to check go id equality to null" );
63 else if ( o.getClass() != this.getClass() ) {
64 throw new IllegalArgumentException( "attempt to check go id equality to " + o + " [" + o.getClass() + "]" );
67 return getId().equals( ( ( GoId ) o ).getId() );
71 public String getId() {
72 return GO_PREFIX + _id;
76 public int hashCode() {
77 return getId().hashCode();
81 public String toString() {