|
0
|
1 # $Id: BookArticle.pm,v 1.6 2002/10/22 07:45:11 lapp Exp $
|
|
|
2 #
|
|
|
3 # BioPerl module for Bio::Biblio::BookArticle
|
|
|
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::BookArticle - Representation of a book article
|
|
|
13
|
|
|
14 =head1 SYNOPSIS
|
|
|
15
|
|
|
16 $obj = new Bio::Biblio::BookArticle (-identifier => '123abc',
|
|
|
17 -book => new Bio::Biblio::Book);
|
|
|
18 --- OR ---
|
|
|
19
|
|
|
20 $obj = new Bio::Biblio::BookArticle;
|
|
|
21 $obj->book (new Bio::Biblio::Book);
|
|
|
22
|
|
|
23
|
|
|
24 =head1 DESCRIPTION
|
|
|
25
|
|
|
26 A storage object for a book article.
|
|
|
27 See its place in the class hierarchy in
|
|
|
28 http://industry.ebi.ac.uk/openBQS/images/bibobjects_perl.gif
|
|
|
29
|
|
|
30 =head2 Attributes
|
|
|
31
|
|
|
32 The following attributes are specific to this class
|
|
|
33 (however, you can also set and get all attributes defined in the parent classes):
|
|
|
34
|
|
|
35 book type: Bio::Biblio::Book
|
|
|
36
|
|
|
37 =head1 SEE ALSO
|
|
|
38
|
|
|
39 =over
|
|
|
40
|
|
|
41 =item *
|
|
|
42
|
|
|
43 OpenBQS home page: http://industry.ebi.ac.uk/openBQS
|
|
|
44
|
|
|
45 =item *
|
|
|
46
|
|
|
47 Comments to the Perl client: http://industry.ebi.ac.uk/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/MailList.shtml - About the mailing lists
|
|
|
61
|
|
|
62 =head2 Reporting Bugs
|
|
|
63
|
|
|
64 Report bugs to the Bioperl bug tracking system to help us keep track
|
|
|
65 of the bugs and their resolution. Bug reports can be submitted via
|
|
|
66 email or the web:
|
|
|
67
|
|
|
68 bioperl-bugs@bioperl.org
|
|
|
69 http://bugzilla.bioperl.org/
|
|
|
70
|
|
|
71 =head1 AUTHORS
|
|
|
72
|
|
|
73 Heikki Lehvaslaiho (heikki@ebi.ac.uk),
|
|
|
74 Martin Senger (senger@ebi.ac.uk)
|
|
|
75
|
|
|
76 =head1 COPYRIGHT
|
|
|
77
|
|
|
78 Copyright (c) 2002 European Bioinformatics Institute. All Rights Reserved.
|
|
|
79
|
|
|
80 This module is free software; you can redistribute it and/or modify
|
|
|
81 it under the same terms as Perl itself.
|
|
|
82
|
|
|
83 =head1 DISCLAIMER
|
|
|
84
|
|
|
85 This software is provided "as is" without warranty of any kind.
|
|
|
86
|
|
|
87 =cut
|
|
|
88
|
|
|
89
|
|
|
90 # Let the code begin...
|
|
|
91
|
|
|
92
|
|
|
93 package Bio::Biblio::BookArticle;
|
|
|
94 use strict;
|
|
|
95 use vars qw(@ISA);
|
|
|
96
|
|
|
97 use Bio::Biblio::Article;
|
|
|
98
|
|
|
99 @ISA = qw(Bio::Biblio::Article);
|
|
|
100
|
|
|
101 #
|
|
|
102 # a closure with a list of allowed attribute names (these names
|
|
|
103 # correspond with the allowed 'get' and 'set' methods); each name also
|
|
|
104 # keep what type the attribute should be (use 'undef' if it is a
|
|
|
105 # simple scalar)
|
|
|
106 #
|
|
|
107 {
|
|
|
108 my %_allowed =
|
|
|
109 (
|
|
|
110 _book => 'Bio::Biblio::Book',
|
|
|
111 );
|
|
|
112
|
|
|
113 # return 1 if $attr is allowed to be set/get in this class
|
|
|
114 sub _accessible {
|
|
|
115 my ($self, $attr) = @_;
|
|
|
116 exists $_allowed{$attr} or $self->SUPER::_accessible ($attr);
|
|
|
117 }
|
|
|
118
|
|
|
119 # return an expected type of given $attr
|
|
|
120 sub _attr_type {
|
|
|
121 my ($self, $attr) = @_;
|
|
|
122 if (exists $_allowed{$attr}) {
|
|
|
123 return $_allowed{$attr};
|
|
|
124 } else {
|
|
|
125 return $self->SUPER::_attr_type ($attr);
|
|
|
126 }
|
|
|
127 }
|
|
|
128 }
|
|
|
129
|
|
|
130
|
|
|
131 1;
|
|
|
132 __END__
|
