annotate variant_effect_predictor/Bio/Biblio/Proceeding.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: Proceeding.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::Proceeding
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::Proceeding - Representation of a conference proceeding
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::Proceeding (-title => 'JavaONE');
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
17
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
18 --- OR ---
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
19
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20 $obj = new Bio::Biblio::Proceeding;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21 $obj->title ('JavaONE');
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25 A storage object for a conference proceeding.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26 See its place in the class hierarchy in
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27 http://industry.ebi.ac.uk/openBQS/images/bibobjects_perl.gif
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29 =head2 Attributes
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31 There are no specific attributes in this class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 (however, you can set and get all attributes defined in the parent classes).
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34 =head1 SEE ALSO
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36 =over
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38 =item *
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40 OpenBQS home page: http://industry.ebi.ac.uk/openBQS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42 =item *
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44 Comments to the Perl client: http://industry.ebi.ac.uk/openBQS/Client_perl.html
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46 =back
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48 =head1 FEEDBACK
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50 =head2 Mailing Lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52 User feedback is an integral part of the evolution of this and other
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53 Bioperl modules. Send your comments and suggestions preferably to
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 the Bioperl mailing list. Your participation is much appreciated.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 bioperl-l@bioperl.org - General discussion
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 http://bioperl.org/MailList.shtml - About the mailing lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59 =head2 Reporting Bugs
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61 Report bugs to the Bioperl bug tracking system to help us keep track
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 of the bugs and their resolution. Bug reports can be submitted via
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63 email or the web:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65 bioperl-bugs@bioperl.org
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 http://bugzilla.bioperl.org/
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68 =head1 AUTHORS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70 Heikki Lehvaslaiho (heikki@ebi.ac.uk),
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 Martin Senger (senger@ebi.ac.uk)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73 =head1 COPYRIGHT
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75 Copyright (c) 2002 European Bioinformatics Institute. All Rights Reserved.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77 This module is free software; you can redistribute it and/or modify
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 it under the same terms as Perl itself.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80 =head1 DISCLAIMER
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 This software is provided "as is" without warranty of any kind.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 =head1 BUGS AND LIMITATIONS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86 This class should be probably somewhere else in the class hierarchy
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87 because a proceeding is actrually a collection of resources. Perhaps
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88 this will be changed in the future.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93 # Let the code begin...
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96 package Bio::Biblio::Proceeding;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98 use vars qw(@ISA);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100 use Bio::Biblio::Ref;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102 @ISA = qw( Bio::Biblio::Ref);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105 # a closure with a list of allowed attribute names (these names
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106 # correspond with the allowed 'get' and 'set' methods); each name also
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107 # keep what type the attribute should be (use 'undef' if it is a
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108 # simple scalar)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111 my %_allowed = (
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114 # return 1 if $attr is allowed to be set/get in this class
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115 sub _accessible {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116 my ($self, $attr) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 exists $_allowed{$attr} or $self->SUPER::_accessible ($attr);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120 # return an expected type of given $attr
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121 sub _attr_type {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122 my ($self, $attr) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123 if (exists $_allowed{$attr}) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124 return $_allowed{$attr};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125 } else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126 return $self->SUPER::_attr_type ($attr);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
129 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
130
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
131
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
132 1;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
133 __END__