Bio/Biblio/Journal.pm

   1 #
   2 # BioPerl module for Bio::Biblio::Journal
   3 #
   4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
   5 #
   6 # Cared for by Martin Senger <senger@ebi.ac.uk>
   7 # For copyright and disclaimer see below.
   8
   9 # POD documentation - main docs before the code
  10
  11 =head1 NAME
  12
  13 Bio::Biblio::Journal - Representation of a journal
  14
  15 =head1 SYNOPSIS
  16
  17     $obj = Bio::Biblio::Journal->new(-name => 'The Perl Journal',
  18                                      -issn  => '1087-903X');
  19   #--- OR ---
  20
  21     $obj = Bio::Biblio::Journal->new();
  22     $obj->issn ('1087-903X');
  23
  24 =head1 DESCRIPTION
  25
  26 A storage object for a journal.
  27 See its place in the class hierarchy in
  28 http://www.ebi.ac.uk/~senger/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   abbreviation
  36   issn
  37   name
  38   provider       type: Bio::Biblio::Provider
  39
  40 =head1 SEE ALSO
  41
  42 =over 4
  43
  44 =item *
  45
  46 OpenBQS home page: http://www.ebi.ac.uk/~senger/openbqs/
  47
  48 =item *
  49
  50 Comments to the Perl client: http://www.ebi.ac.uk/~senger/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/wiki/Mailing_lists  - About the mailing lists
  64
  65 =head2 Support
  66
  67 Please direct usage questions or support issues to the mailing list:
  68
  69 I<bioperl-l@bioperl.org>
  70
  71 rather than to the module maintainer directly. Many experienced and
  72 reponsive experts will be able look at the problem and quickly
  73 address it. Please include a thorough description of the problem
  74 with code and data examples if at all possible.
  75
  76 =head2 Reporting Bugs
  77
  78 Report bugs to the Bioperl bug tracking system to help us keep track
  79 of the bugs and their resolution. Bug reports can be submitted via the
  80 web:
  81
  82   http://bugzilla.open-bio.org/
  83
  84 =head1 AUTHORS
  85
  86 Heikki Lehvaslaiho (heikki-at-bioperl-dot-org),
  87 Martin Senger (senger@ebi.ac.uk)
  88
  89 =head1 COPYRIGHT
  90
  91 Copyright (c) 2002 European Bioinformatics Institute. All Rights Reserved.
  92
  93 This module is free software; you can redistribute it and/or modify
  94 it under the same terms as Perl itself.
  95
  96 =head1 DISCLAIMER
  97
  98 This software is provided "as is" without warranty of any kind.
  99
 100 =cut
 101
 102
 103 # Let the code begin...
 104
 105 package Bio::Biblio::Journal;
 106 use strict;
 107
 108
 109 use base qw(Bio::Biblio::BiblioBase);
 110
 111 #
 112 # a closure with a list of allowed attribute names (these names
 113 # correspond with the allowed 'get' and 'set' methods); each name also
 114 # keep what type the attribute should be (use 'undef' if it is a
 115 # simple scalar)
 116 #
 117 {
 118     my %_allowed =
 119         (
 120          _abbreviation => undef,
 121          _issn => undef,
 122          _name => undef,
 123          _provider => 'Bio::Biblio::Provider',
 124          );
 125
 126     # return 1 if $attr is allowed to be set/get in this class
 127     sub _accessible {
 128         my ($self, $attr) = @_;
 129         exists $_allowed{$attr};
 130     }
 131
 132     # return an expected type of given $attr
 133     sub _attr_type {
 134         my ($self, $attr) = @_;
 135         $_allowed{$attr};
 136     }
 137 }
 138
 139 1;
 140 __END__