| 1 | |||
| 2 | # | ||
| 3 | # This module is licensed under the same terms as Perl itself. You use, | ||
| 4 | # modify, and redistribute it under the terms of the Perl Artistic License. | ||
| 5 | # | ||
| 6 | |||
| 7 | =head1 NAME | ||
| 8 | |||
| 9 | Bio::IdCollectionI - interface for objects with multiple identifiers | ||
| 10 | |||
| 11 | =head1 SYNOPSIS | ||
| 12 | |||
| 13 | |||
| 14 | # to test this is an identifiable collection object | ||
| 15 | |||
| 16 | $obj->isa("Bio::IdCollectionI") || | ||
| 17 | $obj->throw("$obj does not implement the Bio::IdCollectionI interface"); | ||
| 18 | |||
| 19 | # accessors | ||
| 20 | @authorities = $obj->id_authorities(); | ||
| 21 | @ids = $obj->ids(); | ||
| 22 | $id = $obj->ids($authority); | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This interface describes methods expected on objects that have | ||
| 27 | multiple identifiers, each of which is controlled by a different | ||
| 28 | authority. | ||
| 29 | |||
| 30 | =head1 FEEDBACK | ||
| 31 | |||
| 32 | =head2 Mailing Lists | ||
| 33 | |||
| 34 | User feedback is an integral part of the evolution of this and other | ||
| 35 | Bioperl modules. Send your comments and suggestions preferably to one | ||
| 36 | of the Bioperl mailing lists. Your participation is much appreciated. | ||
| 37 | |||
| 38 | bioperl-l@bioperl.org - General discussion | ||
| 39 | http://bioperl.org/wiki/Mailing_lists - About the mailing lists | ||
| 40 | |||
| 41 | =head2 Support | ||
| 42 | |||
| 43 | Please direct usage questions or support issues to the mailing list: | ||
| 44 | |||
| 45 | I<bioperl-l@bioperl.org> | ||
| 46 | |||
| 47 | rather than to the module maintainer directly. Many experienced and | ||
| 48 | reponsive experts will be able look at the problem and quickly | ||
| 49 | address it. Please include a thorough description of the problem | ||
| 50 | with code and data examples if at all possible. | ||
| 51 | |||
| 52 | =head2 Reporting Bugs | ||
| 53 | |||
| 54 | Report bugs to the Bioperl bug tracking system to help us keep track | ||
| 55 | the bugs and their resolution. Bug reports can be submitted via the | ||
| 56 | web: | ||
| 57 | |||
| 58 | https://github.com/bioperl/bioperl-live/issues | ||
| 59 | |||
| 60 | =head1 AUTHOR - Lincoln Stein | ||
| 61 | |||
| 62 | Email lstein@cshl.org | ||
| 63 | |||
| 64 | =cut | ||
| 65 | |||
| 66 | package Bio::IdCollectionI; | ||
| 67 | 1 | $Bio::IdCollectionI::VERSION = '1.7.8'; | |
| 68 | 1 | ▶ | use strict; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 69 | |||
| 70 | |||
| 71 | 1 | ▶ | use base qw(Bio::Root::RootI); |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 72 | |||
| 73 | =head1 Implementation Specific Functions | ||
| 74 | |||
| 75 | These functions are the ones that a specific implementation must | ||
| 76 | define. | ||
| 77 | |||
| 78 | =head2 id_authorities | ||
| 79 | |||
| 80 | Title : id_authorities | ||
| 81 | Usage : @array = $obj->id_authorities() | ||
| 82 | Function: Return the authorities which have names for this object. | ||
| 83 | The authorities can then be used to select ids. | ||
| 84 | |||
| 85 | Returns : An array | ||
| 86 | Status : Virtual | ||
| 87 | |||
| 88 | =cut | ||
| 89 | |||
| 90 | 0 | ▶ | sub id_authorities { |
|
Subroutine
id_authorities: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 91 | 0 | my ($self) = @_; | |
| 92 | 0 | $self->throw_not_implemented(); | |
| 93 | } | ||
| 94 | |||
| 95 | =head2 ids | ||
| 96 | |||
| 97 | Title : ids | ||
| 98 | Usage : @ids = $obj->ids([$authority1,$authority2...]) | ||
| 99 | Function: return a list of Bio::IdentifiableI objects, optionally | ||
| 100 | filtered by the list of authorities. | ||
| 101 | |||
| 102 | Returns : A list of Bio::IdentifiableI objects. | ||
| 103 | Status : Virtual | ||
| 104 | |||
| 105 | =cut | ||
| 106 | |||
| 107 | 0 | ▶ | sub ids { |
|
Subroutine
ids: not called CC=1 SCAR=6.9
Pod
documented
| |||
| 108 | 0 | my ($self) = @_; | |
| 109 | 0 | my @authorities = @_; | |
| 110 | 0 | $self->throw_not_implemented(); | |
| 111 | } | ||
| 112 | |||
| 113 | 1 | 1; | |