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

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