/
ObjectRelMapperI.pm
200 lines (138 loc) · 4.94 KB
/
ObjectRelMapperI.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# $Id$
#
# BioPerl module for Bio::DB::Persistent::ObjectRelMapperI
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Hilmar Lapp <hlapp at gmx.net>
#
# Copyright Hilmar Lapp
#
# You may distribute this module under the same terms as perl itself
#
# (c) Hilmar Lapp, hlapp at gmx.net, 2002.
# (c) GNF, Genomics Institute of the Novartis Research Foundation, 2002.
#
# You may distribute this module under the same terms as perl itself.
# Refer to the Perl Artistic License (see the license accompanying this
# software package, or see http://www.perl.com/language/misc/Artistic.html)
# for the terms under which you may use, modify, and redistribute this module.
#
# THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
# WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
# MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
#
# POD documentation - main docs before the code
=head1 NAME
Bio::DB::Persistent::ObjectRelMapperI - DESCRIPTION of Interface
=head1 SYNOPSIS
Give standard usage here
=head1 DESCRIPTION
Describe the interface here
=head1 FEEDBACK
=head2 Mailing Lists
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list. Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
=head2 Support
Please direct usage questions or support issues to the mailing list:
I<bioperl-l@bioperl.org>
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
=head2 Reporting Bugs
Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via
the web:
http://redmine.open-bio.org/projects/bioperl/
=head1 AUTHOR - Hilmar Lapp
Email hlapp at gmx.net
Describe contact details here
=head1 CONTRIBUTORS
Additional contributors names and emails here
=head1 APPENDIX
The rest of the documentation details each of the object methods.
Internal methods are usually preceded with a _
=cut
# Let the code begin...
package Bio::DB::Persistent::ObjectRellMapperI;
use vars qw(@ISA);
use strict;
use Carp;
use Bio::Root::RootI;
@ISA = qw( Bio::Root::RootI );
=head2 table_name
Title : table_name
Usage :
Function: Obtain the name of the table in the relational schema corresponding
to the given class name, object, or persistence adaptor.
Example :
Returns : the name of the table (a string), or undef if the table cannot be
determined
Args : The referenced object, class name, or the persistence adaptor for
it.
=cut
sub table_name{
shift->throw_not_implemented();
}
=head2 association_table_name
Title : association_table_name
Usage :
Function: Obtain the name of the table in the relational schema corresponding
to the association of entities as represented by their
corresponding class names, objects, or persistence adaptors.
Example :
Returns : the name of the table (a string)
Args : A reference to an array of objects, class names, or persistence
adaptors. The array may freely mix types.
=cut
sub association_table_name{
shift->throw_not_implemented();
}
=head2 primary_key_name
Title : primary_key_name
Usage :
Function: Obtain the name of the primary key attribute for the given table in
the relational schema.
Example :
Returns : The name of the primary key (a string)
Args : The name of the table (a string)
=cut
sub primary_key_name{
shift->throw_not_implemented();
}
=head2 foreign_key_name
Title : foreign_key_name
Usage :
Function: Obtain the foreign key name for referencing an object, as
represented by object, class name, or the persistence adaptor.
Example :
Returns : the name of the foreign key (a string)
Args : The referenced object, class name, or the persistence adaptor for
it.
=cut
sub foreign_key_name{
shift->throw_not_implemented();
}
=head2 slot_attribute_map
Title : slot_attribute_map
Usage :
Function: Get/set the mapping for each entity from object slot names to column
names.
Example :
Returns : A reference to a hash map with entity names being the keys, if no
key (entity name, object, or adaptor) was provided. Otherwise,
a hash reference with the slot names being keys to their
corresponding column names.
Args : Optionally, the object, adaptor, or entity for which to obtain
the map.
Optionally, on set a reference to a hash map satisfying the features
of the returned value.
=cut
sub slot_attribute_map{
shift->throw_not_implemented();
}
1;