branch-1-6/Bio/Biblio/Journal.pm

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