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

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