annotate variant_effect_predictor/Bio/Biblio/PubmedJournalArticle.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: PubmedJournalArticle.pm,v 1.4 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::PubmedJournalArticle
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::PubmedJournalArticle - Representation of a PUBMED journal 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::PubmedJournalArticle (
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
17
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
18 # some attributes from MedlineJournalArticle
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
19 -title => 'Thermal adaptation analyzed by comparison of protein sequences from mesophilic and extremely thermophilic Methanococcus species.',
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
20 -journal => new Bio::Biblio::MedlineJournal (-issn => '0027-8424'),
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
21 -volume => 96,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
22 -issue => 7,
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
23
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
24 # and some from PubmedArticle
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
25 -pubmed_history_list =>
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
26 [ { 'pub_status' => 'pubmed',
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
27 'date' => '2001-12-1T10:0:00Z' },
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
28 { 'pub_status' => 'medline',
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
29 'date' => '2002-1-5T10:1:00Z' } ],
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
30 -pubmed_status => 'ppublish');
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
31 --- OR ---
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
32
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
33 $obj = new Bio::Biblio::PubmedJournalArticle;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
34 $obj->title ('...');
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
35 $obj->journal (new Bio::Biblio::MedlineJournal (-issn => '0027-8424'));
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
36 $obj->pubmed_status ('ppublish');
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
37
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
38
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
39 =head1 DESCRIPTION
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
40
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
41 A storage object for a PUBMED journal article.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
42 See its place in the class hierarchy in
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
43 http://industry.ebi.ac.uk/openBQS/images/bibobjects_perl.gif
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
44
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
45 =head2 Attributes
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
46
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
47 There are no specific attributes in this class
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
48 (however, you can set and get all attributes defined in the parent classes).
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
49
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
50 =head1 SEE ALSO
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
51
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
52 =over
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
53
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
54 =item *
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
55
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
56 OpenBQS home page: http://industry.ebi.ac.uk/openBQS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
57
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
58 =item *
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
59
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
60 Comments to the Perl client: http://industry.ebi.ac.uk/openBQS/Client_perl.html
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
61
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
62 =back
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
63
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
64 =head1 FEEDBACK
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
65
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
66 =head2 Mailing Lists
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
67
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
68 User feedback is an integral part of the evolution of this and other
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
69 Bioperl modules. Send your comments and suggestions preferably to
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
70 the Bioperl mailing list. Your participation is much appreciated.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
71
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
72 bioperl-l@bioperl.org - General discussion
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
73 http://bioperl.org/MailList.shtml - About the mailing lists
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
74
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
75 =head2 Reporting Bugs
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
76
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
77 Report bugs to the Bioperl bug tracking system to help us keep track
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
78 of the bugs and their resolution. Bug reports can be submitted via
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
79 email or the web:
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
80
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
81 bioperl-bugs@bioperl.org
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
82 http://bugzilla.bioperl.org/
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
83
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
84 =head1 AUTHOR
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
85
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
86 Martin Senger (senger@ebi.ac.uk)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
87
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
88 =head1 COPYRIGHT
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
89
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
90 Copyright (c) 2002 European Bioinformatics Institute. All Rights Reserved.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
91
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
92 This module is free software; you can redistribute it and/or modify
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
93 it under the same terms as Perl itself.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
94
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
95 =head1 DISCLAIMER
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
96
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
97 This software is provided "as is" without warranty of any kind.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
98
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
99 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
100
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
101
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
102 # Let the code begin...
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
103
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
104
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
105 package Bio::Biblio::PubmedJournalArticle;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
106 use strict;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
107 use vars qw(@ISA);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
108
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
109 use Bio::Biblio::PubmedArticle;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
110 use Bio::Biblio::MedlineJournalArticle;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
111 @ISA = qw(Bio::Biblio::PubmedArticle Bio::Biblio::MedlineJournalArticle);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
112
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
113 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
114 # a closure with a list of allowed attribute names (these names
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
115 # correspond with the allowed 'get' and 'set' methods); each name also
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
116 # keep what type the attribute should be (use 'undef' if it is a
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
117 # simple scalar)
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
118 #
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
119 {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
120 my %_allowed =
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 1 if $attr is allowed to be set/get in this class
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
125 sub _accessible {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
126 my ($self, $attr) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
127 return 1 if exists $_allowed{$attr};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
128 foreach my $parent (@ISA) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
129 return 1 if $parent->_accessible ($attr);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
130 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
131 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
132
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
133 # return an expected type of given $attr
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
134 sub _attr_type {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
135 my ($self, $attr) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
136 if (exists $_allowed{$attr}) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
137 return $_allowed{$attr};
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
138 } else {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
139 foreach my $parent (@ISA) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
140 if ($parent->_accessible ($attr)) {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
141 return $parent->_attr_type ($attr);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
142 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
143 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
144 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
145 return 'unknown';
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
146 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
147 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
148
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
149
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
150 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
151 __END__