Bio/Biblio/MedlineBook.pm

   1 # $Id$
   2 #
   3 # BioPerl module for Bio::Biblio::MedlineBook
   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::MedlineBook - Representation of a MEDLINE book
  13
  14 =head1 SYNOPSIS
  15
  16     $obj = new Bio::Biblio::MedlineBook
  17                   (-editor => new Bio::Biblio::Person
  18                                      (-lastname => 'Loukides'),
  19                    -isbn  => '0-596-00068-5');
  20  --- OR ---
  21
  22     $obj = new Bio::Biblio::MedlineBook;
  23     $obj->isbn ('0-596-00068-5');
  24
  25 =head1 DESCRIPTION
  26
  27 A storage object for a MEDLINE book.
  28 See its place in the class hierarchy in
  29 http://industry.ebi.ac.uk/openBQS/images/bibobjects_perl.gif
  30
  31 =head2 Attributes
  32
  33 There are no specific attributes in this class
  34 (however, you can set and get all attributes defined in the parent classes).
  35 The main raison d'etre of this class is to be associated with MEDLINE book articles.
  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 AUTHORS
  72
  73 Heikki Lehvaslaiho (heikki@ebi.ac.uk),
  74 Martin Senger (senger@ebi.ac.uk)
  75
  76 =head1 COPYRIGHT
  77
  78 Copyright (c) 2002 European Bioinformatics Institute. All Rights Reserved.
  79
  80 This module is free software; you can redistribute it and/or modify
  81 it under the same terms as Perl itself.
  82
  83 =head1 DISCLAIMER
  84
  85 This software is provided "as is" without warranty of any kind.
  86
  87 =cut
  88
  89
  90 # Let the code begin...
  91
  92
  93 package Bio::Biblio::MedlineBook;
  94 use strict;
  95 use vars qw(@ISA);
  96
  97 use Bio::Biblio::Book;
  98
  99 @ISA = qw(Bio::Biblio::Book);
 100
 101 #
 102 # a closure with a list of allowed attribute names (these names
 103 # correspond with the allowed 'get' and 'set' methods); each name also
 104 # keep what type the attribute should be (use 'undef' if it is a
 105 # simple scalar)
 106 #
 107 {
 108     my %_allowed =
 109         (
 110          );
 111
 112     # return 1 if $attr is allowed to be set/get in this class
 113     sub _accessible {
 114         my ($self, $attr) = @_;
 115         exists $_allowed{$attr} or $self->SUPER::_accessible ($attr);
 116     }
 117
 118     # return an expected type of given $attr
 119     sub _attr_type {
 120         my ($self, $attr) = @_;
 121         if (exists $_allowed{$attr}) {
 122             return $_allowed{$attr};
 123         } else {
 124             return $self->SUPER::_attr_type ($attr);
 125         }
 126     }
 127 }
 128
 129
 130 1;
 131 __END__