Bio/Biblio/Journal.pm

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