org.forester.go.GoId Maven / Gradle / Ivy

// $Id:
// FORESTER -- software libraries and applications
// for evolutionary biology research and applications.
//
// Copyright (C) 2008-2009 Christian M. Zmasek
// Copyright (C) 2008-2009 Burnham Institute for Medical Research
// All rights reserved
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
//
// Contact: phylosoft @ gmail . com
// WWW: https://sites.google.com/site/cmzmasek/home/software/forester

package org.forester.go;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class GoId implements Comparable {

    private static final int     SIZE       = 10;
    private static final String  GO_PREFIX  = "GO:";
    private static final String  GO_FORMAT  = GO_PREFIX + "\\d{7}";
    private static final Pattern GO_PATTERN = Pattern.compile( GO_FORMAT );
    private final String         _id;

    public GoId( final String id ) {
        if ( id.length() != SIZE ) {
            throw new IllegalArgumentException( "unexpected format for GO id: " + id );
        }
        final Matcher m = GO_PATTERN.matcher( id );
        if ( !m.matches() ) {
            throw new IllegalArgumentException( "unexpected format for GO id: " + id );
        }
        _id = id.substring( 3 );
    }

    @Override
    public int compareTo( final GoId id ) {
        return getId().compareTo( id.getId() );
    }

    @Override
    public boolean equals( final Object o ) {
        if ( this == o ) {
            return true;
        }
        else if ( o == null ) {
            throw new IllegalArgumentException( "attempt to check go id equality to null" );
        }
        else if ( o.getClass() != this.getClass() ) {
            throw new IllegalArgumentException( "attempt to check go id equality to " + o + " [" + o.getClass() + "]" );
        }
        else {
            return getId().equals( ( ( GoId ) o ).getId() );
        }
    }

    public String getId() {
        return GO_PREFIX + _id;
    }

    @Override
    public int hashCode() {
        return getId().hashCode();
    }

    @Override
    public String toString() {
        return getId();
    }
}