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

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