1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
=head1 NAME
Bio::DB::GFF::Featname -- The name of a feature
=head1 SYNOPSIS
use Bio::DB::GFF;
my $db = Bio::DB::GFF->new( -adaptor => 'dbi:mysql',
-dsn => 'dbi:mysql:elegans42');
my $feature = Bio::DB::GFF::Featname->new(Locus => 'unc-19');
my $segment = $db->segment($feature);
=head1 DESCRIPTION
Bio::DB::GFF::Featname is the name of a feature. It contains two
fields: name and class. It is typically used by the Bio::DB::GFF
module to denote a group, and is accepted by
Bio::DB::Relsegment-E<gt>new() and Bio::DB::GFF-E<gt>segment() as a
replacement for the -name and -class arguments.
=head1 METHODS
=cut
package Bio::DB::GFF::Featname;
$Bio::DB::GFF::Featname::VERSION = '1.7.4';
use strict;
use base qw(Bio::Root::RootI);
use overload
'""' => 'asString',
fallback => 1;
=head2 new
Title : new
Usage : $name = Bio::DB::GFF::Featname->new($class,$name)
Function: create a new Bio::DB::GFF::Featname object
Returns : a new Bio::DB::GFF::Featname object
Args : class and ID
Status : Public
=cut
sub new {
# use a blessed array for speed
my $pack = shift;
bless [@_],$pack; # class,name
}
sub _cleanup_methods { return; }
=head2 id
Title : id
Usage : $id = $name->id
Function: return a unique ID for the combination of class and name
Returns : a string
Args : none
Status : Public
This method returns a unique combination of the name and class in the
form "class:name". Coincidentally, this is the same format used
by AceDB.
=cut
sub id {
my $self = shift;
return join ':',@$self;
}
=head2 name
Title : name
Usage : $name = $name->name
Function: return the name of the Featname
Returns : a string
Args : none
Status : Public
=cut
sub name { shift->[1] }
=head2 class
Title : class
Usage : $class = $name->class
Function: return the name of the Featname
Returns : a string
Args : none
Status : Public
=cut
sub class { shift->[0] }
=head2 asString
Title : asString
Usage : $string = $name->asString
Function: same as name()
Returns : a string
Args : none
Status : Public
This method is used to overload the "" operator. It is equivalent to
calling name().
=cut
sub asString { shift->name }
=head2 clone
Title : clone
Usage : $new_clone = $type->clone;
Function: clone this object
Returns : a new Bio::DB::GFF::Featname object
Args : none
Status : Public
This method creates an exact copy of the object.
=cut
sub clone {
my $self = shift;
return bless [@$self],ref $self;
}
=head1 BUGS
This module is still under development.
=head1 SEE ALSO
L<bioperl>, L<Bio::DB::GFF>, L<Bio::DB::RelSegment>
=head1 AUTHOR
Lincoln Stein E<lt>lstein@cshl.orgE<gt>.
Copyright (c) 2001 Cold Spring Harbor Laboratory.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
1;
|
