annotate variant_effect_predictor/Bio/Biblio/TechReport.pm @ 0:21066c0abaf5 draft

Uploaded
author willmclaren
date Fri, 03 Aug 2012 10:04:48 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
1 # $Id: TechReport.pm,v 1.6 2002/10/22 07:45:11 lapp Exp $
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
2 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
3 # BioPerl module for Bio::Biblio::TechReport
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
4 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
5 # Cared for by Martin Senger <senger@ebi.ac.uk>
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
6 # For copyright and disclaimer see below.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
7
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
8 # POD documentation - main docs before the code
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
9
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
10 =head1 NAME
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
11
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
12 Bio::Biblio::TechReport - Representation of a technical report
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
13
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
14 =head1 SYNOPSIS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
15
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
16 $obj = new Bio::Biblio::TechReport
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
17 (-authors => [
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
18 new Bio::Biblio::Person (-lastname => 'Hasek'),
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
19 new Bio::Biblio::Person (-lastname => 'Jagr'),
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20 new Bio::Biblio::Organisation (-name => 'NHL'),
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21 ]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22 -title => 'Pinned in the corner');
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26 A storage object for a technical report.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27 See its place in the class hierarchy in
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28 http://industry.ebi.ac.uk/openBQS/images/bibobjects_perl.gif
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30 =head2 Attributes
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 There are no specific attributes in this class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33 (however, you can set and get all attributes defined in the parent classes).
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35 =head1 SEE ALSO
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37 =over
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39 =item *
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 OpenBQS home page: http://industry.ebi.ac.uk/openBQS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43 =item *
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45 Comments to the Perl client: http://industry.ebi.ac.uk/openBQS/Client_perl.html
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 =back
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 =head1 FEEDBACK
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51 =head2 Mailing Lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53 User feedback is an integral part of the evolution of this and other
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 Bioperl modules. Send your comments and suggestions preferably to
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55 the Bioperl mailing list. Your participation is much appreciated.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 bioperl-l@bioperl.org - General discussion
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58 http://bioperl.org/MailList.shtml - About the mailing lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60 =head2 Reporting Bugs
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 Report bugs to the Bioperl bug tracking system to help us keep track
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63 of the bugs and their resolution. Bug reports can be submitted via
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 email or the web:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 bioperl-bugs@bioperl.org
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67 http://bugzilla.bioperl.org/
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69 =head1 AUTHORS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 Heikki Lehvaslaiho (heikki@ebi.ac.uk),
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 Martin Senger (senger@ebi.ac.uk)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74 =head1 COPYRIGHT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76 Copyright (c) 2002 European Bioinformatics Institute. All Rights Reserved.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 This module is free software; you can redistribute it and/or modify
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79 it under the same terms as Perl itself.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 =head1 DISCLAIMER
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83 This software is provided "as is" without warranty of any kind.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88 # Let the code begin...
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 package Bio::Biblio::TechReport;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93 use vars qw(@ISA);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95 use Bio::Biblio::Ref;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 @ISA = qw( Bio::Biblio::Ref);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100 # a closure with a list of allowed attribute names (these names
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101 # correspond with the allowed 'get' and 'set' methods); each name also
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102 # keep what type the attribute should be (use 'undef' if it is a
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 # simple scalar)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105 {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106 my %_allowed = (
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 # return 1 if $attr is allowed to be set/get in this class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 sub _accessible {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111 my ($self, $attr) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 exists $_allowed{$attr} or $self->SUPER::_accessible ($attr);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115 # return an expected type of given $attr
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116 sub _attr_type {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 my ($self, $attr) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118 if (exists $_allowed{$attr}) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119 return $_allowed{$attr};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120 } else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121 return $self->SUPER::_attr_type ($attr);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127 1;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128 __END__