Bio/Biblio/JournalArticle.pm

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