Bio/Biblio/PubmedBookArticle.pm

   1 # $Id$
   2 #
   3 # BioPerl module for Bio::Biblio::PubmedBookArticle
   4 #
   5 # Please direct questions and support issues to <bioperl-l@bioperl.org>
   6 #
   7 # Cared for by Martin Senger <senger@ebi.ac.uk>
   8 # For copyright and disclaimer see below.
   9
  10 # POD documentation - main docs before the code
  11
  12 =head1 NAME
  13
  14 Bio::Biblio::PubmedBookArticle - Representation of a PUBMED book article
  15
  16 =head1 SYNOPSIS
  17
  18     $obj = Bio::Biblio::PubmedBookArticle->new
  19                   (-title => 'Still getting started'.
  20                    -book => Bio::Biblio::MedlineBook->new());
  21     # note that there is no specialised class PubmedBook
  22
  23   #--- OR ---
  24
  25     $obj = Bio::Biblio::PubmedBookArticle->new();
  26     $obj->title ('Still getting started');
  27
  28 =head1 DESCRIPTION
  29
  30 A storage object for a PUBMED book article.
  31 See its place in the class hierarchy in
  32 http://www.ebi.ac.uk/~senger/openbqs/images/bibobjects_perl.gif
  33
  34 =head2 Attributes
  35
  36 There are no specific attributes in this class
  37 (however, you can set and get all attributes defined in the parent classes).
  38
  39 =head1 SEE ALSO
  40
  41 =over 4
  42
  43 =item *
  44
  45 OpenBQS home page: http://www.ebi.ac.uk/~senger/openbqs/
  46
  47 =item *
  48
  49 Comments to the Perl client: http://www.ebi.ac.uk/~senger/openbqs/Client_perl.html
  50
  51 =back
  52
  53 =head1 FEEDBACK
  54
  55 =head2 Mailing Lists
  56
  57 User feedback is an integral part of the evolution of this and other
  58 Bioperl modules. Send your comments and suggestions preferably to
  59 the Bioperl mailing list.  Your participation is much appreciated.
  60
  61   bioperl-l@bioperl.org                  - General discussion
  62   http://bioperl.org/wiki/Mailing_lists  - About the mailing lists
  63
  64 =head2 Support
  65
  66 Please direct usage questions or support issues to the mailing list:
  67
  68 L<bioperl-l@bioperl.org>
  69
  70 rather than to the module maintainer directly. Many experienced and
  71 reponsive experts will be able look at the problem and quickly
  72 address it. Please include a thorough description of the problem
  73 with code and data examples if at all possible.
  74
  75 =head2 Reporting Bugs
  76
  77 Report bugs to the Bioperl bug tracking system to help us keep track
  78 of the bugs and their resolution. Bug reports can be submitted via the
  79 web:
  80
  81   http://bugzilla.open-bio.org/
  82
  83 =head1 AUTHOR
  84
  85 Martin Senger (senger@ebi.ac.uk)
  86
  87 =head1 COPYRIGHT
  88
  89 Copyright (c) 2002 European Bioinformatics Institute. All Rights Reserved.
  90
  91 This module is free software; you can redistribute it and/or modify
  92 it under the same terms as Perl itself.
  93
  94 =head1 DISCLAIMER
  95
  96 This software is provided "as is" without warranty of any kind.
  97
  98 =cut
  99
 100
 101 # Let the code begin...
 102
 103
 104 package Bio::Biblio::PubmedBookArticle;
 105 use strict;
 106 use vars qw(@ISA);
 107
 108 use base qw(Bio::Biblio::PubmedArticle Bio::Biblio::MedlineBookArticle);
 109
 110 #
 111 # a closure with a list of allowed attribute names (these names
 112 # correspond with the allowed 'get' and 'set' methods); each name also
 113 # keep what type the attribute should be (use 'undef' if it is a
 114 # simple scalar)
 115 #
 116 {
 117     my %_allowed =
 118         (
 119          );
 120
 121     # return 1 if $attr is allowed to be set/get in this class
 122     sub _accessible {
 123         my ($self, $attr) = @_;
 124         return 1 if exists $_allowed{$attr};
 125         foreach my $parent (@ISA) {
 126             return 1 if $parent->_accessible ($attr);
 127         }
 128     }
 129
 130     # return an expected type of given $attr
 131     sub _attr_type {
 132         my ($self, $attr) = @_;
 133         if (exists $_allowed{$attr}) {
 134             return $_allowed{$attr};
 135         } else {
 136             foreach my $parent (@ISA) {
 137                 if ($parent->_accessible ($attr)) {
 138                     return $parent->_attr_type ($attr);
 139                 }
 140             }
 141         }
 142         return 'unknown';
 143     }
 144 }
 145
 146
 147 1;
 148 __END__