DBEntry.pm 14.6 KB
Newer Older
1
=head1 LICENSE
2

3
4
  Copyright (c) 1999-2009 The European Bioinformatics Institute and
  Genome Research Limited.  All rights reserved.
5

6
7
  This software is distributed under a modified Apache license.
  For license details, please see
8

9
    http://www.ensembl.org/info/about/code_licence.html
Patrick Meidl's avatar
Patrick Meidl committed
10

11
=head1 CONTACT
12

13
14
  Please email comments or questions to the public Ensembl
  developers list at <ensembl-dev@ebi.ac.uk>.
Graham McVicker's avatar
PODs  
Graham McVicker committed
15

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

19
=cut
20

21
=head1 NAME
22

23
24
Bio::EnsEMBL::DBEntry -
Object representing an external reference (xref)
25

26
=head1 SYNOPSIS
27

28
=head1 DESCRIPTION
29

30
31
This object holds information about external references (xrefs) to
Ensembl objects.
David Barnwell's avatar
David Barnwell committed
32

33
=head1 METHODS
34

Patrick Meidl's avatar
Patrick Meidl committed
35
=cut
36

37
38
package Bio::EnsEMBL::DBEntry;

39
use strict;
Patrick Meidl's avatar
Patrick Meidl committed
40
use warnings;
Patrick Meidl's avatar
Patrick Meidl committed
41
no warnings qw(uninitialized);
42

Patrick Meidl's avatar
Patrick Meidl committed
43
44
45
46
47
use Bio::EnsEMBL::Storable;
use Bio::Annotation::DBLink;

use Bio::EnsEMBL::Utils::Argument qw(rearrange);
use Bio::EnsEMBL::Utils::Exception qw(deprecate);
48

Patrick Meidl's avatar
Patrick Meidl committed
49
our @ISA = qw(Bio::EnsEMBL::Storable Bio::Annotation::DBLink);
50

51

Graham McVicker's avatar
PODs  
Graham McVicker committed
52
53
=head2 new_fast

Patrick Meidl's avatar
Patrick Meidl committed
54
  Arg [1]    : Hashref $hashref - hash reference to bless as new DBEntry object
Graham McVicker's avatar
PODs  
Graham McVicker committed
55
56
57
58
59
  Description: A very quick constructor that requires internal knowledge of
               the class. This is used in speed critical sections of the code
               where many objects need to be created quickly.
  Returntype : Bio::EnsEMBL::DBEntry
  Exceptions : none
Patrick Meidl's avatar
Patrick Meidl committed
60
  Caller     : general
61
  Status     : Stable
Graham McVicker's avatar
PODs  
Graham McVicker committed
62
63
64

=cut

Graham McVicker's avatar
Graham McVicker committed
65
66
67
sub new_fast {
  my $class = shift;
  my $hashref = shift;
Patrick Meidl's avatar
Patrick Meidl committed
68

Brian Gibbins's avatar
Brian Gibbins committed
69
  bless $hashref, $class;
Patrick Meidl's avatar
Patrick Meidl committed
70

71
  return $hashref;
Graham McVicker's avatar
Graham McVicker committed
72
73
}

Graham McVicker's avatar
PODs  
Graham McVicker committed
74
75
76
77

=head2 new

  Args [...] : list of named parameters 
Patrick Meidl's avatar
Patrick Meidl committed
78
79
80
81
82
83
84
85
86
87
88
89
90
  Example    : my $dbentry = new Bio::EnsEMBL::DBEntry(
                    -adaptor => $adaptor,
                    -primary_id => $pid,
                    -version => $version,
                    -dbname  => $dbname,
                    -release => $release,
                    -display_id => $did,
                    -description => $description,
                    -primary_id_linkable =>$primary_id_linkable,
                    -display_id_linkable =>$display_id_linkable,
                    -priority => $priority,
                    -db_display_name => $db_display_name,
                    -info_type => $info_type,
Glenn Proctor's avatar
Glenn Proctor committed
91
                    -info_text => $info_text,
92
93
                    -type => $type,
                    -secondary_db_name => $secondary_db_name,
94
                    -secondary_db_table => $secondary_db_table
95
		    -linkage_annotation => $object_xref_text);
Graham McVicker's avatar
PODs  
Graham McVicker committed
96
97
98
99
  Description: Creates a new DBEntry object
  Returntype : Bio::EnsEMBL::DBEntry
  Exceptions : none
  Caller     : Bio::EnsEMBL::DBEntryAdaptor
100
  Status     : At Risk
101
               Due to 'PRIMARY_ID_LINKABLE','DISPLAY_ID_LINKABLE','PRIORITY',
102
103
              'INFO_TYPE', 'INFO_TEXT', ''DB_DISPLAY_NAME', 'TYPE',
              'SECONDARY_DB_NAME', 'SECONDARY_DB_TABLE'
Patrick Meidl's avatar
Patrick Meidl committed
104
105
               being under development - if you don't use any of these the
               method can be considered Stable
Graham McVicker's avatar
PODs  
Graham McVicker committed
106
107
108

=cut

109
110
sub new {
  my ($class, @args) = @_;
111
  
112
113
  my $self = bless {},$class;

Arne Stabenau's avatar
Arne Stabenau committed
114
  my ( $adaptor, $dbID, $primary_id, $version,
115
       $dbname, $release, $display_id, $description,
116
       $primary_id_linkable, $display_id_linkable, $priority,
117
       $db_display_name, $info_type, $info_text, $type,
118
       $secondary_db_name, $secondary_db_table, $link_annotation) =
119
    rearrange ( ['ADAPTOR','DBID','PRIMARY_ID','VERSION',
120
                 'DBNAME','RELEASE','DISPLAY_ID','DESCRIPTION',
Glenn Proctor's avatar
Glenn Proctor committed
121
		 'PRIMARY_ID_LINKABLE','DISPLAY_ID_LINKABLE','PRIORITY',
122
		 'DB_DISPLAY_NAME', 'INFO_TYPE', 'INFO_TEXT', 'TYPE',
123
                 'SECONDARY_DB_NAME', 'SECONDARY_DB_TABLE', 'LINKAGE_ANNOTATION'], @args );
124
125
126
127

  $self->{'adaptor'} = $adaptor;
  $self->{'dbID'}    = $dbID;

128
  if( defined $primary_id ) { $self->primary_id( $primary_id ) }
Arne Stabenau's avatar
Arne Stabenau committed
129
130
  if( defined $version ) { $self->version( $version ) } else
    { $self->version( "" ); }
131
132
  if( defined $dbname ) { $self->dbname( $dbname ) }
  if( defined $release) { $self->release( $release ) }
133
  if( defined $display_id) { $self->display_id( $display_id ) }
134
  if( defined $description) { $self->description($description) }
135
136
137
  if( defined $primary_id_linkable) { $self->primary_id_linkable($primary_id_linkable) }
  if( defined $display_id_linkable) { $self->display_id_linkable($display_id_linkable) }
  if( defined $priority) { $self->priority($priority) }
Glenn Proctor's avatar
Glenn Proctor committed
138
  if( defined $db_display_name) { $self->db_display_name($db_display_name) }
139
140
  if( defined $info_type) { $self->info_type($info_type) }
  if( defined $info_text) { $self->info_text($info_text) }
Glenn Proctor's avatar
Glenn Proctor committed
141
  if( defined $type) { $self->type($type) }
142
143
  if( defined $secondary_db_name) { $self->secondary_db_name($secondary_db_name) }
  if( defined $secondary_db_table) { $self->secondary_db_table($secondary_db_table) }
144

145
146
  $self->linkage_annotation($link_annotation) if defined $link_annotation;

147
148
149
150
151

  return $self;
}


Arne Stabenau's avatar
Arne Stabenau committed
152
153
=head2 primary_id

Patrick Meidl's avatar
Patrick Meidl committed
154
  Arg [1]    : (optional) String $arg - value to set
Arne Stabenau's avatar
Arne Stabenau committed
155
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
156
157
158
  Description: Getter/setter for attribute 'primary_id'.
               This is the object's primary id in the external database.
  Returntype : String
Arne Stabenau's avatar
Arne Stabenau committed
159
160
  Exceptions : none
  Caller     : general
161
  Status     : Stable
Arne Stabenau's avatar
Arne Stabenau committed
162
163
164

=cut

165
166
167
sub primary_id {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
168
    $self->{primary_id} = $arg;
169
  } 
170
  return $self->{primary_id};
171
172
}

173

Arne Stabenau's avatar
Arne Stabenau committed
174
=head2 display_id
175

Patrick Meidl's avatar
Patrick Meidl committed
176
  Arg [1]    : (optional) String $arg - value to set
Arne Stabenau's avatar
Arne Stabenau committed
177
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
178
179
180
181
  Description: Getter/setter for attribute 'display_id'.
               The object's preferred display name. This can be the same
               as primary_id or ensembl-specific.
  Returntype : String
Arne Stabenau's avatar
Arne Stabenau committed
182
183
  Exceptions : none
  Caller     : general
184
  Status     : Stable
185
186
187
188
189
190

=cut

sub display_id{
   my ( $self, $arg ) = @_;
   if( defined $arg ) {
191
       $self->{display_id} = $arg;
192
   } 
193
   return $self->{display_id};
194
195
196
}


Patrick Meidl's avatar
Patrick Meidl committed
197
=head2 optional_id
Graham McVicker's avatar
PODs  
Graham McVicker committed
198

Patrick Meidl's avatar
Patrick Meidl committed
199
  Args       : none
Arne Stabenau's avatar
Arne Stabenau committed
200
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
201
202
203
204
205
  Description: Additional getter for attribute 'display_id'.
               The object's preferred display name.
               Only include for BioPerl interface compliance, please use
               $self->display_id().
  Returntype : String
Arne Stabenau's avatar
Arne Stabenau committed
206
207
  Exceptions : none
  Caller     : general
208
  Status     : Stable
Arne Stabenau's avatar
Arne Stabenau committed
209
210
211

=cut

Patrick Meidl's avatar
Patrick Meidl committed
212
213
214
sub optional_id {
  my $self = shift;
  return $self->display_id;
215
216
217
}


Patrick Meidl's avatar
Patrick Meidl committed
218
=head2 dbname
Graham McVicker's avatar
PODs  
Graham McVicker committed
219

Patrick Meidl's avatar
Patrick Meidl committed
220
  Arg [1]    : (optional) String $arg - value to set
Arne Stabenau's avatar
Arne Stabenau committed
221
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
222
223
224
  Description: Getter/setter for attribute 'dbname'.
               The name of the external database.
  Returntype : String
Arne Stabenau's avatar
Arne Stabenau committed
225
226
  Exceptions : none
  Caller     : general
227
  Status     : Stable
Arne Stabenau's avatar
Arne Stabenau committed
228
229
230

=cut

Patrick Meidl's avatar
Patrick Meidl committed
231
232
233
234
235
236
sub dbname {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
    $self->{dbname} = $arg;
  } 
  return $self->{dbname};
237
238
}

Arne Stabenau's avatar
Arne Stabenau committed
239

Patrick Meidl's avatar
Patrick Meidl committed
240
=head2 database
Arne Stabenau's avatar
Arne Stabenau committed
241
242
243

  Args       : none
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
244
245
246
247
248
  Description: Additional getter for attribute 'dbname'.
               The name of the external database.
               Only include for BioPerl interface compliance, please use
               $self->dbname().
  Returntype : String
Arne Stabenau's avatar
Arne Stabenau committed
249
250
  Exceptions : none
  Caller     : general
251
  Status     : Stable
Arne Stabenau's avatar
Arne Stabenau committed
252
253
254

=cut

Patrick Meidl's avatar
Patrick Meidl committed
255
sub database {
256
  my $self = shift;
Patrick Meidl's avatar
Patrick Meidl committed
257
  return $self->dbname();
258
259
260
}


Arne Stabenau's avatar
Arne Stabenau committed
261
262
=head2 release

Patrick Meidl's avatar
Patrick Meidl committed
263
  Arg [1]    : (optional) String $arg - value to set
Arne Stabenau's avatar
Arne Stabenau committed
264
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
265
266
267
  Description: Getter/setter for attribute 'release'.
               The external database release name.
  Returntype : String
Arne Stabenau's avatar
Arne Stabenau committed
268
269
  Exceptions : none
  Caller     : general
270
  Status     : Stable
Arne Stabenau's avatar
Arne Stabenau committed
271
272
273

=cut

274
275
276
sub release {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
277
    $self->{release} = $arg;
278
  } 
279
  return $self->{release};
280
281
282
}


Arne Stabenau's avatar
Arne Stabenau committed
283
284
=head2 version

Patrick Meidl's avatar
Patrick Meidl committed
285
  Arg [1]    : (optional) String $arg - value to set
Arne Stabenau's avatar
Arne Stabenau committed
286
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
287
288
289
  Description: Getter/setter for attribute 'version'.
               The object's version in the external database.
  Returntype : String
Arne Stabenau's avatar
Arne Stabenau committed
290
291
  Exceptions : none
  Caller     : general
292
  Status     : Stable
Arne Stabenau's avatar
Arne Stabenau committed
293
294
295

=cut

296
297
298
sub version {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
299
    $self->{version} = $arg;
300
  } 
301
  return $self->{version};
302
303
304
}


Arne Stabenau's avatar
Arne Stabenau committed
305
306
=head2 description

Patrick Meidl's avatar
Patrick Meidl committed
307
  Arg [1]    : (optional) String $arg - value to set
Arne Stabenau's avatar
Arne Stabenau committed
308
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
309
  Description: Getter/setter for attribute 'description'.
310
               The object's description, from the external_db table
Patrick Meidl's avatar
Patrick Meidl committed
311
  Returntype : String
Arne Stabenau's avatar
Arne Stabenau committed
312
313
  Exceptions : none
  Caller     : general
314
  Status     : Stable
Arne Stabenau's avatar
Arne Stabenau committed
315
316
317

=cut

318
319
320
sub description {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
321
    $self->{description} = $arg;
322
  } 
323
  return $self->{description};
324
325
326
}


Patrick Meidl's avatar
Patrick Meidl committed
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
=head2 comment

  Args       : none
  Example    : none
  Description: Additional getter for attribute 'description'.
               The object's description.
               Only include for BioPerl interface compliance, please use
               $self->description().
  Returntype : String
  Exceptions : none
  Caller     : general
  Status     : Stable

=cut

sub comment {
  my $self = shift;
  return $self->description();
}


348
349
=head2 primary_id_linkable

Patrick Meidl's avatar
Patrick Meidl committed
350
  Arg [1]    : (optional) Boolean $arg - value to set
351
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
352
353
  Description: Getter/setter for attribute 'primary_id_linkable'.
  Returntype : String
354
355
  Exceptions : none
  Caller     : general
356
357
  Status     : At Risk
             : due to it being under development
358
359
360
361
362
363
364
365
366
367
368

=cut

sub primary_id_linkable {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
    $self->{primary_id_linkable} = $arg;
  } 
  return $self->{primary_id_linkable};
}

Patrick Meidl's avatar
Patrick Meidl committed
369

370
371
=head2 display_id_linkable

Patrick Meidl's avatar
Patrick Meidl committed
372
  Arg [1]    : (optional) Boolean $arg - value to set
373
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
374
375
  Description: Getter/setter for attribute 'display_id_linkable'.
  Returntype : String
376
377
  Exceptions : none
  Caller     : general
378
379
  Status     : At Risk
             : due to it being under development
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395

=cut

sub display_id_linkable {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
    $self->{display_id_linkable} = $arg;
  } 
  return $self->{display_id_linkable};
}


=head2 priority

  Arg [1]    : int $priority
  Example    : none
396
  Priority   : Getter/setter for attribute 'priority'. Note this
Glenn Proctor's avatar
Glenn Proctor committed
397
               is the priority from the external_db table.
Patrick Meidl's avatar
Patrick Meidl committed
398
  Returntype : String
399
400
  Exceptions : none
  Caller     : general
401
402
  Status     : At Risk
             : due to it being under development
403
404
405
406
407
408
409
410
411
412
413

=cut

sub priority {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
    $self->{priority} = $arg;
  } 
  return $self->{priority};
}

Glenn Proctor's avatar
Glenn Proctor committed
414
415
416
417
418

=head2 db_display_name

  Arg [1]    : String $db_display_name
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
419
420
421
422
  Description: Getter/setter for attribute 'db_display_name'.
               The preferred display name for the external database. Has
               "Projected " prepended if info_type='PROJECTION'.
  Returntype : String
Glenn Proctor's avatar
Glenn Proctor committed
423
424
425
426
427
428
429
430
431
  Exceptions : none
  Caller     : general

=cut

sub db_display_name {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
    $self->{db_display_name} = $arg;
432
433
434
  }

  my $name;
435
  if ($self->{info_type} && $self->{info_type} eq "PROJECTION") {
436
437
438
439
440
441
442
443
444
445
446
447
448
    $name = "Projected " . $self->{db_display_name};
  } else {
    $name =  $self->{db_display_name};
  }

  return $name;
}


=head2 info_type

  Arg [1]    : String $info_type
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
449
450
  Description: Getter/setter for attribute 'info_type'.
  Returntype : String
451
452
453
454
455
456
457
458
459
  Exceptions : none
  Caller     : general

=cut

sub info_type {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
    $self->{info_type} = $arg;
460
  }
461
  return $self->{info_type};
Glenn Proctor's avatar
Glenn Proctor committed
462
 }
463
464
465
466
467
468


=head2 info_text

  Arg [1]    : String $info_text
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
469
470
  Description: Getter/setter for attribute 'info_text'.
  Returntype : String
471
472
473
474
475
476
477
478
479
  Exceptions : none
  Caller     : general

=cut

sub info_text {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
    $self->{info_text} = $arg;
Glenn Proctor's avatar
Glenn Proctor committed
480
  } 
481
  return $self->{info_text};
Glenn Proctor's avatar
Glenn Proctor committed
482
483
}

484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
=head2 linkage_annotation

  Arg [1]    : String $object_xref_text
  Example    : none
  Description: Getter/setter for attribute 'linkage_annotation'.
  Returntype : String
  Exceptions : none
  Caller     : general

=cut

sub linkage_annotation {
  my ( $self, $arg ) = @_;

  $self->{linkage_annotation} = $arg if defined $arg;
  
  return $self->{linkage_annotation};
}


Glenn Proctor's avatar
Glenn Proctor committed
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
=head2 type

  Arg [1]    : String $type
  Example    : none
  Description: Getter/setter for attribute 'type'.
  Returntype : String
  Exceptions : none
  Caller     : general

=cut

sub type {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
    $self->{type} = $arg;
  }
  return $self->{type};
}

523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
=head2 secondary_db_name

  Arg [1]    : String $secondary_db_name
  Example    : none
  Description: Getter/setter for attribute 'secondary_db_name'.
  Returnsecondary_db_name : String
  Exceptions : none
  Caller     : general

=cut

sub secondary_db_name {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
    $self->{secondary_db_name} = $arg;
  }
  return $self->{secondary_db_name};
}


=head2 secondary_db_table

  Arg [1]    : String $secondary_db_table
  Example    : none
  Description: Getter/setter for attribute 'secondary_db_table'.
  Returnsecondary_db_table : String
  Exceptions : none
  Caller     : general

=cut

sub secondary_db_table {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
    $self->{secondary_db_table} = $arg;
  }
  return $self->{secondary_db_table};
}

562

Arne Stabenau's avatar
Arne Stabenau committed
563
564
=head2 add_synonym

Patrick Meidl's avatar
Patrick Meidl committed
565
  Arg [1]    : String $arg - synonym to add
Arne Stabenau's avatar
Arne Stabenau committed
566
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
567
  Description: Add a synonym for the external object.
Arne Stabenau's avatar
Arne Stabenau committed
568
569
570
  Returntype : none
  Exceptions : none
  Caller     : general
571
  Status     : Stable
Arne Stabenau's avatar
Arne Stabenau committed
572
573
574
575

=cut


576
577
578
sub add_synonym {
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
579
    push( @{$self->{synonyms}}, $arg );
580
581
582
  }
}

Arne Stabenau's avatar
Arne Stabenau committed
583

Graham McVicker's avatar
Graham McVicker committed
584
=head2 get_all_synonyms
Arne Stabenau's avatar
Arne Stabenau committed
585
586

  Args       : none
Patrick Meidl's avatar
Patrick Meidl committed
587
588
  Example    : my @synonyms = @{ $db_entry->get_all_synonyms };
  Description: Get a list of synonyms known for this object.
589
590
               Synonyms are lazy-loaded if required.
  Returntype : listref of strings. May be empty.
Arne Stabenau's avatar
Arne Stabenau committed
591
592
  Exceptions : none
  Caller     : general
593
  Status     : Stable
Arne Stabenau's avatar
Arne Stabenau committed
594
595
596

=cut

Graham McVicker's avatar
Graham McVicker committed
597
sub get_all_synonyms {
598

599
  my $self = shift;
600
601

  # lazy-load synonyms if required
Ian Longden's avatar
Ian Longden committed
602
  if (!$self->{synonyms} && $self->{adaptor}) {
603
604
605
    $self->{synonyms} = $self->{adaptor}->fetch_all_synonyms($self->dbID());
  }

606
  return $self->{synonyms};
607
608
}

Arne Stabenau's avatar
Arne Stabenau committed
609
610
611
612
613

=head2 flush_synonyms

  Args       : none
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
614
  Description: Remove all synonyms from this object.
Arne Stabenau's avatar
Arne Stabenau committed
615
616
617
  Returntype : none
  Exceptions : none
  Caller     : general
618
  Status     : Stable
Arne Stabenau's avatar
Arne Stabenau committed
619
620
621

=cut

622
623
sub flush_synonyms {
  my $self = shift;
624
  $self->{synonyms} = [];
625
626
}

Arne Stabenau's avatar
Arne Stabenau committed
627

628
629
=head2 status

Patrick Meidl's avatar
Patrick Meidl committed
630
  Arg [1]    : (optional) String $arg - value to set
Arne Stabenau's avatar
Arne Stabenau committed
631
  Example    : none
Patrick Meidl's avatar
Patrick Meidl committed
632
633
  Description: Getter/setter for attribute 'status'.
  Returntype : String
Arne Stabenau's avatar
Arne Stabenau committed
634
635
  Exceptions : none
  Caller     : general
636
  Status     : Stable
637
638
639

=cut

Arne Stabenau's avatar
Arne Stabenau committed
640

641
sub status{
Patrick Meidl's avatar
Patrick Meidl committed
642
643
644
645
646
  my ( $self, $arg ) = @_;
  if( defined $arg ) {
     $self->{status} = $arg;
  } 
  return $self->{status};
647
648
}

Graham McVicker's avatar
Graham McVicker committed
649
650
651
=head1 DEPRECATED METHODS

=cut
Graham McVicker's avatar
Graham McVicker committed
652
653
654
655
656
657
658
659
660
661

=head2 get_synonyms

  Description: DEPRECATED use get_all_synonyms instead

=cut

sub get_synonyms {
  my $self = shift;

662
  deprecate("get_synonyms has been renamed get_all_synonyms.");
Graham McVicker's avatar
Graham McVicker committed
663
664
665
  return $self->get_all_synonyms;
}

666
1;
Patrick Meidl's avatar
Patrick Meidl committed
667