Bio/Biblio/TechReport.pm

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