Bio/Biblio/Service.pm

   1 #
   2 # BioPerl module for Bio::Biblio::Service
   3 #
   4 # Please direct questions and support issues to <bioperl-l@bioperl.org>
   5 #
   6 # Cared for by Martin Senger <senger@ebi.ac.uk>
   7 # For copyright and disclaimer see below.
   8
   9 # POD documentation - main docs before the code
  10
  11 =head1 NAME
  12
  13 Bio::Biblio::Service - Representation of a provider of type service
  14
  15 =head1 SYNOPSIS
  16
  17     $obj = Bio::Biblio::Service->new(-name => 'Report generator');
  18
  19   #--- OR ---
  20
  21     $obj = Bio::Biblio::Service->new();
  22     $obj->name ('Report generator');
  23
  24 =head1 DESCRIPTION
  25
  26 A storage object for a service (such a computer service) related to a bibliographic resource.
  27
  28 =head2 Attributes
  29
  30 The following attributes are specific to this class
  31 (however, you can also set and get all attributes defined in the parent classes):
  32
  33   name
  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 Support
  61
  62 Please direct usage questions or support issues to the mailing list:
  63
  64 I<bioperl-l@bioperl.org>
  65
  66 rather than to the module maintainer directly. Many experienced and
  67 reponsive experts will be able look at the problem and quickly
  68 address it. Please include a thorough description of the problem
  69 with code and data examples if at all possible.
  70
  71 =head2 Reporting Bugs
  72
  73 Report bugs to the Bioperl bug tracking system to help us keep track
  74 of the bugs and their resolution. Bug reports can be submitted via the
  75 web:
  76
  77   http://bugzilla.open-bio.org/
  78
  79 =head1 AUTHORS
  80
  81 Heikki Lehvaslaiho (heikki-at-bioperl-dot-org),
  82 Martin Senger (senger@ebi.ac.uk)
  83
  84 =head1 COPYRIGHT
  85
  86 Copyright (c) 2002 European Bioinformatics Institute. All Rights Reserved.
  87
  88 This module is free software; you can redistribute it and/or modify
  89 it under the same terms as Perl itself.
  90
  91 =head1 DISCLAIMER
  92
  93 This software is provided "as is" without warranty of any kind.
  94
  95 =cut
  96
  97
  98 # Let the code begin...
  99
 100
 101 package Bio::Biblio::Service;
 102 use strict;
 103
 104
 105 use base qw(Bio::Biblio::Provider);
 106
 107 #
 108 # a closure with a list of allowed attribute names (these names
 109 # correspond with the allowed 'get' and 'set' methods); each name also
 110 # keep what type the attribute should be (use 'undef' if it is a
 111 # simple scalar)
 112 #
 113 {
 114     my %_allowed = (
 115         _name => undef,
 116     );
 117
 118     # return 1 if $attr is allowed to be set/get in this class
 119     sub _accessible {
 120         my ($self, $attr) = @_;
 121         exists $_allowed{$attr} or $self->SUPER::_accessible ($attr);
 122     }
 123
 124     # return an expected type of given $attr
 125     sub _attr_type {
 126         my ($self, $attr) = @_;
 127         if (exists $_allowed{$attr}) {
 128             return $_allowed{$attr};
 129         } else {
 130             return $self->SUPER::_attr_type ($attr);
 131         }
 132     }
 133 }
 134
 135
 136 1;
 137 __END__