CoordSystem.pm 10.1 KB
Newer Older
1
2
=head1 LICENSE

3
Copyright [1999-2013] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
4

5
6
7
8
9
10
11
12
13
14
15
16
17
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

=cut
18
19
20
21
22


=head1 CONTACT

  Please email comments or questions to the public Ensembl
23
  developers list at <dev@ensembl.org>.
24
25
26
27
28

  Questions may also be sent to the Ensembl help desk at
  <helpdesk@ensembl.org>.

=cut
29
30
31
32
33
34
35
36
37
38
39
40
41
42

=head1 NAME

Bio::EnsEMBL::CoordSystem

=head1 SYNOPSIS

  my $db = Bio::EnsEMBL::DBSQL::DBAdaptor->new(...);

  my $csa = $db->get_CoordSystemAdaptor();

  #
  # Get all coord systems in the database:
  #
43
44
  foreach my $cs ( @{ $csa->fetch_all() } ) {
    my $str = join ':', $cs->name(), $cs->version(), $cs->dbID();
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
    print "$str\n";
  }

=head1 DESCRIPTION

This is a simple object which contains a few coordinate system attributes:
name, internal identifier, version.  A coordinate system is uniquely defined
by its name and version.  A version of a coordinate system applies to all
sequences within a coordinate system.  This should not be confused with
individual sequence versions.

Take for example the Human assembly.  The version 'NCBI33' applies to
to all chromosomes in the NCBI33 assembly (that is the entire 'chromosome'
coordinate system).  The 'clone' coordinate system in the same database would
have no version however.  Although the clone sequences have their own sequence
versions, there is no version which applies to the entire set of clones.

Coordinate system objects are immutable. Their name and version, and other
attributes may not be altered after they are created.

=head1 METHODS

=cut


use strict;
use warnings;

package Bio::EnsEMBL::CoordSystem;

use Bio::EnsEMBL::Storable;

77
78
use Bio::EnsEMBL::Utils::Argument  qw(rearrange);
use Bio::EnsEMBL::Utils::Exception qw(throw);
79
80
81
82
83
84
85
86
87
88

use vars qw(@ISA);

@ISA = qw(Bio::EnsEMBL::Storable);


=head2 new

  Arg [..]   : List of named arguments:
               -NAME      - The name of the coordinate system
89
90
91
92
               -VERSION   - (optional) The version of the coordinate system.
                            Note that if the version passed in is undefined,
                            it will be set to the empty string in the
                            resulting CoordSystem object.
93
94
95
96
97
98
               -RANK      - The rank of the coordinate system. The highest
                            level coordinate system should have rank 1, the
                            second highest rank 2 and so on.  An example of
                            a high level coordinate system is 'chromosome' an
                            example of a lower level coordinate system is
                            'clone'.
99
               -TOP_LEVEL - (optional) Sets whether this is a top-level coord
100
101
102
                            system. Default = 0. This should only be set to
                            true if you are creating an artificial toplevel
                            coordsystem by the name of 'toplevel'
103
104
               -SEQUENCE_LEVEL - (optional) Sets whether this is a sequence
                            level coordinate system. Default = 0
105
               -DEFAULT   - (optional)
106
107
108
109
110
111
                            Whether this is the default version of the 
                            coordinate systems of this name. Default = 0
               -DBID      - (optional) The internal identifier of this
                             coordinate system
               -ADAPTOR   - (optional) The adaptor which provides database
                            interaction for this object
112
  Example    : $cs = Bio::EnsEMBL::CoordSystem->new(-NAME    => 'chromosome',
113
                                                    -VERSION => 'NCBI33',
114
                                                    -RANK    => 1,
115
116
117
                                                    -DBID    => 1,
                                                    -ADAPTOR => adaptor,
                                                    -DEFAULT => 1,
118
                                                    -SEQUENCE_LEVEL => 0);
119
120
121
122
123
  Description: Creates a new CoordSystem object representing a coordinate
               system.
  Returntype : Bio::EnsEMBL::CoordSystem
  Exceptions : none
  Caller     : general
124
  Status     : Stable
125
126
127
128
129
130
131
132
133

=cut

sub new {
  my $caller = shift;
  my $class = ref($caller) || $caller;

  my $self = $class->SUPER::new(@_);

134
135
136
137
138
  my ( $name, $version, $top_level, $sequence_level, $default, $rank ) =
    rearrange( [ 'NAME',      'VERSION',
                 'TOP_LEVEL', 'SEQUENCE_LEVEL',
                 'DEFAULT',   'RANK' ],
               @_ );
139

140
  $version = '' if ( !defined($version) );
141

142
143
144
  $top_level      = ($top_level)      ? 1 : 0;
  $sequence_level = ($sequence_level) ? 1 : 0;
  $default        = ($default)        ? 1 : 0;
145
146
  $rank ||= 0;

147
  if ( $top_level == 1 ) {
148
    if ( $rank != 0 ) {
149
150
151
      throw('RANK argument must be 0 if TOP_LEVEL is 1');
    }

152
153
154
    if ( defined($name) ) {
      if ( $name ne 'toplevel' ) {
        throw('The NAME argument must be "toplevel" if TOP_LEVEL is 1');
155
156
157
158
159
      }
    } else {
      $name = 'toplevel';
    }

160
    if ( $sequence_level == 1 ) {
161
162
163
164
165
166
      throw("SEQUENCE_LEVEL argument must be 0 if TOP_LEVEL is 1");
    }

    $default = 0;

  } else {
167
168
169

    if ( $rank == 0 ) {
      throw("RANK argument must be non-zero unless TOP_LEVEL is 1");
170
    }
171
172
173
174
175
176

    if ( !defined($name) ) {
      throw('The NAME argument is required');
    } elsif ( $name eq 'toplevel' ) {
      throw(   "Cannot name coord system 'toplevel' "
             . "unless TOP_LEVEL is 1" );
177
    }
178

179
180
  }

181
  if ( $rank !~ /^\d+$/ ) {
182
183
    throw('The RANK argument must be a positive integer');
  }
184

185
186
187
  $self->{'version'}        = $version;
  $self->{'name'}           = $name;
  $self->{'top_level'}      = $top_level;
188
  $self->{'sequence_level'} = $sequence_level;
189
190
  $self->{'default'}        = $default;
  $self->{'rank'}           = $rank;
191
192

  return $self;
193
} ## end sub new
194
195
196
197
198
199
200
201
202
203


=head2 name

  Arg [1]    : (optional) string $name
  Example    : print $coord_system->name();
  Description: Getter for the name of this coordinate system
  Returntype : string
  Exceptions : none
  Caller     : general
204
  Status     : Stable
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224

=cut

sub name {
  my $self = shift;
  return $self->{'name'};
}



=head2 version

  Arg [1]    : none
  Example    : print $coord->version();
  Description: Getter for the version of this coordinate system.  This
               will return an empty string if no version is defined for this
               coordinate system.
  Returntype : string
  Exceptions : none
  Caller     : general
225
  Status     : Stable
226
227
228
229
230
231
232
233
234
235

=cut

sub version {
  my $self = shift;
  return $self->{'version'};
}



Andrew Jenkinson's avatar
Andrew Jenkinson committed
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
=head2 species

  Arg [1]    : none
  Example    : print $coord->species();
  Description: Shortcut method to get the species this CoordSystem refers to.
  Returntype : string
  Exceptions : none
  Caller     : general
  Status     : Stable

=cut

sub species {
  my $self = shift;
  return $self->adaptor->db->species;
}


254
255
256
257
258
259
260
261
262
263
264
265

=head2 equals

  Arg [1]    : Bio::EnsEMBL::CoordSystem $cs
               The coord system to compare to for equality.
  Example    : if($coord_sys->equals($other_coord_sys)) { ... }
  Description: Compares 2 coordinate systems and returns true if they are
               equivalent.  The definition of equivalent is sharing the same
               name and version.
  Returntype : string
  Exceptions : none
  Caller     : general
266
  Status     : Stable
267
268
269
270
271
272
273
274

=cut

sub equals {
  my $self = shift;
  my $cs = shift;

  if(!$cs || !ref($cs) || !$cs->isa('Bio::EnsEMBL::CoordSystem')) {
Andrew Jenkinson's avatar
Andrew Jenkinson committed
275
276
277
278
    if ($cs->isa('Bio::EnsEMBL::ExternalData::DAS::CoordSystem')) {
      return $cs->equals($self);
    }
    throw('Argument must be a CoordSystem');
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
  }

  if($self->{'version'} eq $cs->version() && $self->{'name'} eq $cs->name()) {
    return 1;
  }

  return 0;
}




=head2 is_top_level

  Arg [1]    : none
  Example    : if($coord_sys->is_top_level()) { ... }
295
296
297
298
299
  Description: Returns true if this is the toplevel pseudo coordinate system.
               The toplevel coordinate system is not a real coordinate system
               which is stored in the database, but it is a placeholder that
               can be used to request transformations or retrievals to/from
               the highest defined coordinate system in a given region.
Kieron Taylor's avatar
Kieron Taylor committed
300
  Returntype : 1 or 0
301
302
  Exceptions : none
  Caller     : general
303
  Status     : Stable
304
305
306
307
308
309
310
311
312
313
314
315
316
317

=cut

sub is_top_level {
  my $self = shift;
  return $self->{'top_level'};
}


=head2 is_sequence_level

  Arg [1]    : none
  Example    : if($coord_sys->is_sequence_level()) { ... }
  Description: Returns true if this is a sequence level coordinate system
Kieron Taylor's avatar
Kieron Taylor committed
318
  Returntype : 1 or 0
319
320
  Exceptions : none
  Caller     : general
321
  Status     : Stable
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336

=cut

sub is_sequence_level {
  my $self = shift;
  return $self->{'sequence_level'};
}


=head2 is_default

  Arg [1]    : none
  Example    : if($coord_sys->is_default()) { ... }
  Description: Returns true if this coordinate system is the default
               version of the coordinate system of this name.
Kieron Taylor's avatar
Kieron Taylor committed
337
  Returntype : 1 or 0
338
339
  Exceptions : none
  Caller     : general
340
  Status     : Stable
341
342
343
344
345
346
347
348
349

=cut

sub is_default {
  my $self = shift;
  return $self->{'default'};
}


350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365


=head2 rank

  Arg [1]    : none
  Example    : if($cs1->rank() < $cs2->rank()) {
                 print $cs1->name(), " is a higher level coord system than",
                       $cs2->name(), "\n";
               }
  Description: Returns the rank of this coordinate system.  A lower number
               is a higher coordinate system.  The highest level coordinate
               system has a rank of 1 (e.g. 'chromosome').  The toplevel
               pseudo coordinate system has a rank of 0.
  Returntype : int
  Exceptions : none
  Caller     : general
366
  Status     : Stable
367
368
369
370
371
372
373
374

=cut

sub rank {
  my $self = shift;
  return $self->{'rank'};
}

375
1;