annotate variant_effect_predictor/Bio/Biblio/MedlineBookArticle.pm @ 0:2bc9b66ada89 draft default tip

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