annotate variant_effect_predictor/Bio/Tools/ECnumber.pm @ 1:d6778b5d8382 draft default tip

Deleted selected files
author willmclaren
date Fri, 03 Aug 2012 10:05:43 -0400
parents 21066c0abaf5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
1 # $Id: ECnumber.pm,v 1.7 2002/12/12 18:27:02 czmasek Exp $
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
2 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
3 # BioPerl module for Bio::Tools::ECnumber
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
4 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
5 # Cared for by Christian M. Zmasek <czmasek@gnf.org> or <cmzmasek@yahoo.com>
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
6 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
7 # (c) Christian M. Zmasek, czmasek@gnf.org, 2002.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
8 # (c) GNF, Genomics Institute of the Novartis Research Foundation, 2002.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
9 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
10 # You may distribute this module under the same terms as perl itself.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
11 # Refer to the Perl Artistic License (see the license accompanying this
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
12 # software package, or see http://www.perl.com/language/misc/Artistic.html)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
13 # for the terms under which you may use, modify, and redistribute this module.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
14 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
15 # THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
16 # WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
17 # MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
18 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
19
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20 # POD documentation - main docs before the code
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23 =head1 NAME
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25 ECnumber - representation of EC numbers
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27 =head1 SYNOPSIS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29 use Bio::Tools::ECnumber;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 # Creation of ECnumber objects
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33 # ----------------------------
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35 my $EC1 = Bio::Tools::ECnumber->new( -ec_string => "4.3.2.1" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36 my $EC2 = Bio::Tools::ECnumber->new( -ec_string => "EC 1.1.1.1" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37 my $EC3 = Bio::Tools::ECnumber->new();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40 # Copying
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 # -------
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43 my $EC4 = $EC1->copy();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46 # Modification of ECnumber objects
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 # --------------------------------
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 print $EC3->EC_string( "1.01.01.001" ); # Prints "1.1.1.1".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52 # To string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53 # ---------
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55 print $EC3->EC_string();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 # or:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59 print $EC3->to_string();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63 # Test for equality
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 # -----------------
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 # Against ECnumber object:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67 if ( $EC3->is_equal( $EC2 ) ) { # Prints "equal".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68 print "equal";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 # Against string representation of EC number:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 if ( ! $EC3->is_equal( "1.1.1.-" ) ) { # Prints "not equal".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73 print "not equal";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77 # Test for membership
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 # -------------------
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80 my $EC5 = Bio::Tools::ECnumber->new( -ec_string => "4.3.2.-" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 # Against ECnumber object.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83 if ( $EC1->is_member( $EC5 ) ) { # Prints "member".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 print "member";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88 # Against string representation of EC number.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89 if ( ! $EC1->is_member( "4.3.1.-" ) ) { # Prints "not member".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90 print "not member";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 ECnumber is a representation of EC numbers [http://www.chem.qmul.ac.uk/iubmb/enzyme/].
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99 =head1 FEEDBACK
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101 =head2 Mailing Lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 User feedback is an integral part of the evolution of this and other
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104 Bioperl modules. Send your comments and suggestions preferably to one
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105 of the Bioperl mailing lists. Your participation is much appreciated.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107 bioperl-l@bioperl.org - General discussion
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108 http://bio.perl.org/MailList.html - About the mailing lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 =head2 Reporting Bugs
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 Report bugs to the Bioperl bug tracking system to help us keep track
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113 the bugs and their resolution. Bug reports can be submitted via email
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114 or the web:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116 bioperl-bugs@bio.perl.org
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 http://bugzilla.bioperl.org/
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119 =head1 AUTHOR
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121 Christian M. Zmasek
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123 Email: czmasek@gnf.org or cmzmasek@yahoo.com
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125 WWW: http://www.genetics.wustl.edu/eddy/people/zmasek/
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127 Address:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
129 Genomics Institute of the Novartis Research Foundation
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
130 10675 John Jay Hopkins Drive
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
131 San Diego, CA 92121
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
132
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
133 =head1 APPENDIX
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
134
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
135 The rest of the documentation details each of the object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
136 methods. Internal methods are usually preceded with a _
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
137
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
138 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
139
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
140
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
141 # Let the code begin...
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
142
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
143 package Bio::Tools::ECnumber;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
144 use vars qw( @ISA );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
145 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
146 use Bio::Root::Object;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
147
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
148 use constant DEFAULT => "-";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
149 use constant TRUE => 1;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
150 use constant FALSE => 0;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
151
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
152 @ISA = qw( Bio::Root::Root );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
153
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
154
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
155
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
156
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
157
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
158 =head2 new
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
159
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
160 Title : new
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
161 Usage : $EC1 = Bio::Tools::ECnumber->new( -ec_string => "4.3.2.1" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
162 or
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
163 $EC2 = Bio::Tools::ECnumber->new( -ec_string => "4.3.2.2",
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
164 -comment => "Is EC 4.3.2.2" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
165 or
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
166 $EC3 = Bio::Tools::ECnumber->new(); # EC3 is now "-.-.-.-"
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
167 Function: Creates a new ECnumber object.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
168 Parses a EC number from "x.x.x.x", "EC x.x.x.x",
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
169 "ECx.x.x.x", or "EC:x.x.x.x";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
170 x being either a positive integer or a "-".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
171 Returns : A new Ecnumber object.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
172 Args : A string representing a EC number, e.g. "4.3.2.1"
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
173 or "EC 4.3.2.1" or "1.-.-.-".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
174
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
175 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
176
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
177 sub new {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
178 my( $class, @args ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
179
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
180 my $self = $class->SUPER::new( @args );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
181
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
182 my ( $EC_string, $comment )
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
183 = $self->_rearrange( [ qw( EC_STRING COMMENT ) ], @args );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
184
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
185 $self->init();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
186
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
187 $EC_string && $self->EC_string( $EC_string );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
188 $comment && $self->comment( $comment );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
189
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
190 return $self;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
191
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
192 } # new
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
193
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
194
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
195
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
196 =head2 init
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
197
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
198 Title : init()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
199 Usage : $EC1->init(); # EC1 is now "-.-.-.-"
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
200 Function: Initializes this ECnumber to default values.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
201 Returns :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
202 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
203
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
204 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
205
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
206 sub init {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
207 my( $self ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
208
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
209 $self->enzyme_class( DEFAULT );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
210 $self->sub_class( DEFAULT );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
211 $self->sub_sub_class( DEFAULT );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
212 $self->serial_number( DEFAULT );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
213 $self->comment( "" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
214
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
215 } # init
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
216
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
217
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
218
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
219 =head2 copy
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
220
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
221 Title : copy()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
222 Usage : $EC2 = $EC1->copy();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
223 Function: Creates a new ECnumber object which is an exact copy
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
224 of this ECnumber.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
225 Returns : A copy of this ECnumber.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
226 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
227
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
228 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
229
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
230 sub copy {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
231 my( $self ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
232
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
233 my $new_ec = $self->new();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
234 $new_ec->enzyme_class( $self->enzyme_class() );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
235 $new_ec->sub_class( $self->sub_class() );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
236 $new_ec->sub_sub_class( $self->sub_sub_class() );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
237 $new_ec->serial_number( $self->serial_number() );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
238 $new_ec->comment( $self->comment() );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
239 return $new_ec;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
240
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
241 } # copy
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
242
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
243
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
244
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
245 =head2 EC_string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
246
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
247 Title : EC_string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
248 Usage : $EC3->EC_string( "1.1.1.-" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
249 or
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
250 print $EC3->EC_string();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
251 Function: Set/get for string representations of EC numbers.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
252 Parses a EC number from "x.x.x.x", "EC x.x.x.x",
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
253 "ECx.x.x.x", or "EC:x.x.x.x";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
254 x being either a positive integer or a "-".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
255 Returns : A string representations of a EC number.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
256 Args : A string representations of a EC number.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
257
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
258 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
259
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
260 sub EC_string {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
261 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
262
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
263 if ( defined $value) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
264 $value =~ s/\s+//g; # Removes white space.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
265 $value =~ s/^EC//i; # Removes "EC".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
266 $value =~ s/^://; # Removes ":".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
267
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
268 if ( $value =~ /^([\d-]*)\.([\d-]*)\.([\d-]*)\.([\d-]*)$/ ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
269 $self->enzyme_class( $1 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
270 $self->sub_class( $2 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
271 $self->sub_sub_class( $3 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
272 $self->serial_number( $4 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
273 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
274 else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
275 $self->throw( "Illegal format error [$value]" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
276 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
277 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
278
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
279 return $self->to_string();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
280
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
281 } # EC_string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
282
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
283
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
284
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
285 =head2 to_string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
286
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
287 Title : to_string()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
288 Usage : print $EC3->to_string();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
289 Function: To string method for EC numbers
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
290 (equals the "get" functionality of "EC_string").
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
291 Returns : A string representations of a EC number.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
292 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
293
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
294 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
295
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
296 sub to_string {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
297 my ( $self ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
298
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
299 my $s = $self->enzyme_class() . ".";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
300 $s .= $self->sub_class() . ".";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
301 $s .= $self->sub_sub_class() . ".";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
302 $s .= $self->serial_number();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
303 return $s;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
304
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
305 } # to_string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
306
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
307
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
308
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
309 =head2 is_equal
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
310
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
311 Title : is_equal
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
312 Usage : if ( $EC3->is_equal( $EC2 ) )
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
313 or
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
314 if ( $EC3->is_equal( "1.1.1.-" ) )
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
315 Function: Checks whether this ECnumber is equal to the argument
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
316 EC number (please note: "1.1.1.1" != "1.1.1.-").
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
317 Returns : True (1) or false (0).
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
318 Args : A ECnumber object or a string representation of a EC number.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
319
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
320 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
321
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
322 sub is_equal {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
323 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
324
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
325 if ( $self->_is_not_reference( $value ) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
326 $value = $self->new( -ec_string => $value );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
327 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
328 else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
329 $self->_is_ECnumber_object( $value );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
330 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
331
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
332 unless ( $self->enzyme_class() eq $value->enzyme_class() ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
333 return FALSE;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
334 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
335 unless ( $self->sub_class() eq $value->sub_class() ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
336 return FALSE;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
337 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
338 unless ( $self->sub_sub_class() eq $value->sub_sub_class() ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
339 return FALSE;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
340 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
341 unless ( $self->serial_number() eq $value->serial_number() ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
342 return FALSE;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
343 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
344 return TRUE;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
345
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
346 } # is_equal
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
347
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
348
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
349
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
350 =head2 is_member
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
351
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
352 Title : is_member
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
353 Usage : if ( $EC1->is_member( $EC5 ) )
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
354 or
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
355 if ( $EC1->is_member( "4.3.-.-" ) )
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
356 Function: Checks whether this ECnumber is a member of the (incomplete)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
357 argument EC number (e.g. "1.1.1.1" is a member of "1.1.1.-"
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
358 but not of "1.1.1.2").
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
359 Returns : True (1) or false (0).
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
360 Args : A ECnumber object or a string representation of a EC number.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
361
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
362 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
363
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
364 sub is_member {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
365 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
366
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
367 if ( $self->_is_not_reference( $value ) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
368 $value = $self->new( -ec_string => $value );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
369 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
370 else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
371 $self->_is_ECnumber_object( $value );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
372 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
373 $self->_check_for_illegal_defaults();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
374 $value->_check_for_illegal_defaults();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
375
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
376 unless ( $value->enzyme_class() eq DEFAULT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
377 || $self->enzyme_class() eq $value->enzyme_class() ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
378 return FALSE;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
379 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
380 unless ( $value->sub_class() eq DEFAULT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
381 || $self->sub_class() eq $value->sub_class() ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
382 return FALSE;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
383 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
384 unless ( $value->sub_sub_class() eq DEFAULT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
385 || $self->sub_sub_class() eq $value->sub_sub_class() ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
386 return FALSE;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
387 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
388 unless ( $value->serial_number() eq DEFAULT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
389 || $self->serial_number() eq $value->serial_number() ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
390 return FALSE;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
391 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
392 return TRUE;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
393
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
394 } # is_member
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
395
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
396
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
397
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
398 =head2 enzyme_class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
399
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
400 Title : enzyme_class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
401 Usage : $EC1->enzyme_class( 1 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
402 or
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
403 print $EC1->enzyme_class();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
404 Function: Set/get for the enzyme class number of ECnumbers.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
405 Returns : The enzyme class number of this ECnumber.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
406 Args : A positive integer or "-".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
407
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
408 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
409
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
410 sub enzyme_class {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
411 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
412
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
413 if ( defined $value) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
414 $self->{ "_enzyme_class" } = $self->_check_number( $value );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
415 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
416
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
417 return $self->{ "_enzyme_class" };
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
418
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
419 } # enzyme_class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
420
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
421
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
422
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
423 =head2 sub_class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
424
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
425 Title : sub_class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
426 Usage : $EC1->sub_class( 4 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
427 or
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
428 print $EC1->sub_class();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
429 Function: Set/get for the enzyme sub class number of ECnumbers.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
430 Returns : The enzyme sub class number of this ECnumber.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
431 Args : A positive integer or "-".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
432
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
433 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
434
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
435 sub sub_class {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
436 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
437
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
438 if ( defined $value) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
439 $self->{ "_sub_class" } = $self->_check_number( $value );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
440 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
441
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
442 return $self->{ "_sub_class" };
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
443
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
444 } # sub_class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
445
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
446
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
447
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
448 =head2 sub_sub_class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
449
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
450 Title : sub_sub_class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
451 Usage : $EC1->sub_sub_class( 12 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
452 or
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
453 print $EC1->sub_sub_class();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
454 Function: Set/get for the enzyme sub sub class number of ECnumbers.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
455 Returns : The enzyme sub sub class number of this ECnumber.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
456 Args : A positive integer or "-".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
457
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
458 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
459
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
460 sub sub_sub_class {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
461 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
462
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
463 if ( defined $value) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
464 $self->{ "_sub_sub_class" } = $self->_check_number( $value );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
465 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
466
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
467 return $self->{ "_sub_sub_class" };
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
468
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
469 } # sub_sub_class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
470
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
471
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
472
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
473 =head2 serial_number
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
474
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
475 Title : serial_number
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
476 Usage : $EC1->serial_number( 482 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
477 or
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
478 print $EC1->serial_number();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
479 Function: Set/get for the serial number of ECnumbers.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
480 Returns : The serial number of this ECnumber.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
481 Args : A positive integer or "-".
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
482
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
483 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
484
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
485 sub serial_number {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
486 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
487
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
488 if ( defined $value) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
489 $self->{ "_serial_number" } = $self->_check_number( $value );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
490 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
491
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
492 return $self->{ "_serial_number" };
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
493
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
494 } # serial_number
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
495
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
496
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
497
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
498 =head2 comment
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
499
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
500 Title : comment
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
501 Usage : $EC1->comment( "deprecated" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
502 or
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
503 print $EC1->comment();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
504 Function: Set/get for a arbitrary comment.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
505 Returns : A comment [scalar].
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
506 Args : A comment [scalar].
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
507
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
508 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
509
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
510 sub comment {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
511 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
512
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
513 if ( defined $value) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
514 $self->{ "_comment" } = $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
515 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
516
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
517 return $self->{ "_comment" };
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
518
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
519 } # comment
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
520
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
521
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
522
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
523 # Title : _check_number
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
524 # Function: Checks and standardizes the individual numbers of a EC number
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
525 # (removes leading zeros, removes white spaces).
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
526 # Returns : A standardized number.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
527 # Args : A string representing a number in a EC number.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
528 sub _check_number {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
529 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
530
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
531 my $original_value = $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
532 $value =~ s/\s+//g; # Removes white space.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
533 if ( $value eq "" ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
534 $value = DEFAULT;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
535 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
536 $value =~ s/^0+//; # Removes leading zeros.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
537 if ( $value eq "" ) { # If it was "0" (or "00"), it would be "" now.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
538 $value = "0";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
539 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
540 elsif ( $value ne DEFAULT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
541 && $value =~ /\D/ ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
542 $self->throw( "Illegal format error [$original_value]" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
543 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
544 return $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
545
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
546 } # _check_number
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
547
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
548
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
549
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
550 # Title : _check_for_illegal_defaults()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
551 # Function: Checks for situations like "1.-.1.1", which
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
552 # are illegal in membership tests.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
553 # Returns :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
554 # Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
555 sub _check_for_illegal_defaults {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
556 my ( $self ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
557
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
558 if ( ( $self->sub_sub_class() eq DEFAULT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
559 && $self->serial_number() ne DEFAULT ) ||
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
560 ( $self->sub_class() eq DEFAULT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
561 && $self->sub_sub_class() ne DEFAULT ) ||
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
562 ( $self->enzyme_class() eq DEFAULT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
563 && $self->sub_class() ne DEFAULT ) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
564 $self->throw( "Illegal format error for comparison ["
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
565 . $self->to_string() . "]" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
566 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
567
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
568 } # _check_for_illegal_defaults
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
569
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
570
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
571
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
572 # Title : _is_not_reference
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
573 # Function: Checks whether the argument is not a reference.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
574 # Returns : True or false.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
575 # Args : A scalar.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
576 sub _is_not_reference {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
577 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
578
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
579 return ( ! ref( $value ) );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
580
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
581 } # _is_not_reference
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
582
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
583
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
584
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
585 # Title : _is_ECnumber_object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
586 # Function: Checks whether the arument is a ECnumber.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
587 # Returns :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
588 # Args : A reference.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
589 sub _is_ECnumber_object {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
590 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
591
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
592 unless( $value->isa( "Bio::Tools::ECnumber" ) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
593 $self->throw( "Found [". ref( $value )
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
594 ."] where [Bio::Tools::ECnumber] expected" );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
595 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
596
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
597 } # _is_ECnumber_object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
598
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
599
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
600
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
601 1;