3 // FORESTER -- software libraries and applications
4 // for evolutionary biology research and applications.
6 // Copyright (C) 2008-2009 Christian M. Zmasek
7 // Copyright (C) 2008-2009 Burnham Institute for Medical Research
10 // This library is free software; you can redistribute it and/or
11 // modify it under the terms of the GNU Lesser General Public
12 // License as published by the Free Software Foundation; either
13 // version 2.1 of the License, or (at your option) any later version.
15 // This library is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Lesser General Public License for more details.
20 // You should have received a copy of the GNU Lesser General Public
21 // License along with this library; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 // Contact: phylosoft @ gmail . com
25 // WWW: www.phylosoft.org/forester
27 package org.forester.surfacing;
29 import org.forester.go.GoId;
30 import org.forester.util.ForesterUtil;
32 public class BasicDomain implements Domain {
34 final private DomainId _id;
35 final private int _from;
36 final private int _to;
37 final private short _number;
38 final private short _total_count;
39 final private double _per_sequence_evalue;
40 final private double _per_sequence_score;
41 final private double _per_domain_evalue;
42 final private double _per_domain_score;
44 public BasicDomain( final String id_str ) {
45 if ( ForesterUtil.isEmpty( id_str ) ) {
46 throw new IllegalArgumentException( "attempt to create protein domain with null or empty id" );
48 _id = new DomainId( id_str );
53 _per_sequence_evalue = -1;
54 _per_sequence_score = -1;
55 _per_domain_evalue = -1;
56 _per_domain_score = -1;
59 public BasicDomain( final String id_str,
63 final short total_count,
64 final double per_sequence_evalue,
65 final double per_sequence_score ) {
66 if ( ( from >= to ) || ( from < 0 ) ) {
67 throw new IllegalArgumentException( "attempt to create protein domain from " + from + " to " + to );
69 if ( ForesterUtil.isEmpty( id_str ) ) {
70 throw new IllegalArgumentException( "attempt to create protein domain with null or empty id" );
72 if ( ( number > total_count ) || ( number < 0 ) ) {
73 throw new IllegalArgumentException( "attempt to create protein domain number " + number + " out of "
76 if ( per_sequence_evalue < 0.0 ) {
77 throw new IllegalArgumentException( "attempt to create protein domain with E-value" );
79 _id = new DomainId( id_str );
83 _total_count = total_count;
84 _per_sequence_evalue = per_sequence_evalue;
85 _per_sequence_score = per_sequence_score;
86 _per_domain_evalue = -1;
87 _per_domain_score = -1;
90 public BasicDomain( final String id_str,
94 final short total_count,
95 final double per_sequence_evalue,
96 final double per_sequence_score,
97 final double per_domain_evalue,
98 final double per_domain_score ) {
99 if ( ( from >= to ) || ( from < 0 ) ) {
100 throw new IllegalArgumentException( "attempt to create protein domain from " + from + " to " + to );
102 if ( ForesterUtil.isEmpty( id_str ) ) {
103 throw new IllegalArgumentException( "attempt to create protein domain with null or empty id" );
105 if ( ( number > total_count ) || ( number < 0 ) ) {
106 throw new IllegalArgumentException( "attempt to create protein domain number " + number + " out of "
109 if ( ( per_sequence_evalue < 0.0 ) || ( per_domain_evalue < 0.0 ) ) {
110 throw new IllegalArgumentException( "attempt to create protein domain with E-value" );
112 _id = new DomainId( id_str );
116 _total_count = total_count;
117 _per_sequence_evalue = per_sequence_evalue;
118 _per_sequence_score = per_sequence_score;
119 _per_domain_evalue = per_domain_evalue;
120 _per_domain_score = per_domain_score;
123 public void addGoId( final GoId go_id ) {
124 getDomainId().getGoIds().add( go_id );
128 * Basic domains are compared/sorted based upon their identifiers (case
129 * insensitive) and their numbers.
132 public int compareTo( final Domain domain ) {
133 if ( domain.getClass() != this.getClass() ) {
134 throw new IllegalArgumentException( "attempt to compare [" + domain.getClass() + "] to " + "["
135 + this.getClass() + "]" );
137 if ( this == domain ) {
140 return getDomainId().compareTo( domain.getDomainId() );
144 * Basic domains are considered equal if they have the same identifier (case
149 public boolean equals( final Object o ) {
153 else if ( o == null ) {
154 throw new IllegalArgumentException( "attempt to check [" + this.getClass() + "] equality to null" );
156 else if ( o.getClass() != this.getClass() ) {
157 throw new IllegalArgumentException( "attempt to check [" + this.getClass() + "] equality to " + o + " ["
158 + o.getClass() + "]" );
161 return getDomainId().equals( ( ( Domain ) o ).getDomainId() );
165 public DomainId getDomainId() {
169 public int getFrom() {
173 public GoId getGoId( final int i ) {
174 return getDomainId().getGoIds().get( i );
177 public short getNumber() {
181 public int getNumberOfGoIds() {
182 return getDomainId().getGoIds().size();
186 public double getPerDomainEvalue() {
187 return _per_domain_evalue;
191 public double getPerDomainScore() {
192 return _per_domain_score;
195 public double getPerSequenceEvalue() {
196 return _per_sequence_evalue;
199 public double getPerSequenceScore() {
200 return _per_sequence_score;
207 public short getTotalCount() {
212 public int hashCode() {
213 return getDomainId().getId().hashCode();
217 public String toString() {
218 return toStringBuffer().toString();
221 public StringBuffer toStringBuffer() {
222 return new StringBuffer( getDomainId().getId() );