Bio/Biblio/PubmedBookArticle.pm

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