annotate variant_effect_predictor/Bio/Ontology/OntologyI.pm @ 1:d6778b5d8382 draft default tip

Deleted selected files
author willmclaren
date Fri, 03 Aug 2012 10:05:43 -0400
parents 21066c0abaf5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
1 # $Id: OntologyI.pm,v 1.2.2.4 2003/03/27 10:07:56 lapp Exp $
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
2 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
3 # BioPerl module for Bio::Ontology::OntologyI
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
4 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
5 # Cared for by Hilmar Lapp <hlapp at gmx.net>
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
6 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
7 # Copyright Hilmar Lapp
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
8 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
9 # You may distribute this module under the same terms as perl itself
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
10
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
11 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
12 # (c) Hilmar Lapp, hlapp at gmx.net, 2003.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
13 # (c) GNF, Genomics Institute of the Novartis Research Foundation, 2003.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
14 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
15 # You may distribute this module under the same terms as perl itself.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
16 # Refer to the Perl Artistic License (see the license accompanying this
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
17 # software package, or see http://www.perl.com/language/misc/Artistic.html)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
18 # for the terms under which you may use, modify, and redistribute this module.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
19 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
20 # THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
21 # WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
22 # MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
23 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
24
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
25 # POD documentation - main docs before the code
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
26
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
27 =head1 NAME
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29 Bio::Ontology::OntologyI - Interface for an ontology implementation
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31 =head1 SYNOPSIS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33 # see method documentation
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37 This describes the minimal interface an ontology implementation must
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38 provide. In essence, it represents a namespace with description on top
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39 of the query interface OntologyEngineI.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 This interface inherits from L<Bio::Ontology::OntologyEngineI>.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43 =head1 FEEDBACK
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45 =head2 Mailing Lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 User feedback is an integral part of the evolution of this and other
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48 Bioperl modules. Send your comments and suggestions preferably to
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 the Bioperl mailing list. Your participation is much appreciated.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51 bioperl-l@bioperl.org - General discussion
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52 http://bioperl.org/MailList.shtml - About the mailing lists
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 =head2 Reporting Bugs
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 Report bugs to the Bioperl bug tracking system to help us keep track
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 of the bugs and their resolution. Bug reports can be submitted via
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58 email or the web:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60 http://bugzilla.bioperl.org/
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 =head1 AUTHOR - Hilmar Lapp
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 Email hlapp at gmx.net
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 =head1 CONTRIBUTORS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68 Additional contributors names and emails here
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70 =head1 APPENDIX
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 The rest of the documentation details each of the object methods.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73 Internal methods are usually preceded with a _
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 # Let the code begin...
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 package Bio::Ontology::OntologyI;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 use vars qw(@ISA);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 use Bio::Ontology::OntologyEngineI;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87 @ISA = qw( Bio::Ontology::OntologyEngineI );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89 =head1 Methods defined in this interface.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93 =head2 name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95 Title : name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96 Usage : $obj->name($newval)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 Function: Get/set the name of this ontology.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99 Returns : value of name (a scalar)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105 sub name{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106 shift->throw_not_implemented();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 =head2 authority
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111 Title : authority
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 Usage : $auth = $obj->authority()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113 Function: Get/set the authority for this ontology, for instance the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114 DNS base for the organization granting the name of the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115 ontology and identifiers for the terms.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 This attribute is optional and should not generally
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118 expected by applications to have been set. It is here to
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119 follow the rules for namespaces, which ontologies serve as
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120 for terms.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123 Returns : value of authority (a scalar)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
129 sub authority{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
130 shift->throw_not_implemented();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
131 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
132
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
133 =head2 identifier
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
134
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
135 Title : identifier
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
136 Usage : $id = $obj->identifier()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
137 Function: Get an identifier for this ontology.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
138
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
139 This is primarily intended for look-up purposes. Clients
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
140 should not expect the value to be modifiable, and it may
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
141 not be allowed to set its value from outside. Also, the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
142 identifier's uniqueness may only hold within the scope of a
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
143 particular application's run time, i.e., it may be a memory
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
144 location.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
145
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
146 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
147 Returns : value of identifier (a scalar)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
148 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
149
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
150
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
151 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
152
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
153 sub identifier{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
154 shift->throw_not_implemented();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
155 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
156
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
157 =head2 definition
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
158
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
159 Title : definition
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
160 Usage : $def = $obj->definition()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
161 Function: Get a descriptive definition for this ontology.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
162 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
163 Returns : value of definition (a scalar)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
164 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
165
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
166
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
167 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
168
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
169 sub definition{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
170 shift->throw_not_implemented();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
171 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
172
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
173 =head2 close
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
174
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
175 Title : close
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
176 Usage :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
177 Function: Release any resources this ontology may occupy. In order
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
178 to efficiently release used memory or file handles, you
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
179 should call this method once you are finished with an
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
180 ontology.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
181
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
182 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
183 Returns : TRUE on success and FALSE otherwise
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
184 Args : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
185
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
186
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
187 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
188
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
189 sub close{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
190 shift->throw_not_implemented();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
191 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
192
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
193 =head1 Methods inherited from L<Bio::Ontology::OntologyEngineI>
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
194
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
195 Their documentations are copied here for completeness. In most use
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
196 cases, you will want to access the query methods of an ontology, not
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
197 just the name and description ...
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
198
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
199 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
200
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
201 =head2 add_term
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
202
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
203 Title : add_term
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
204 Usage : add_term(TermI term): TermI
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
205 Function: Adds TermI object to the ontology engine term store.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
206
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
207 For ease of use, if the ontology property of the term
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
208 object was not set, an implementation is encouraged to set
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
209 it to itself upon adding the term.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
210
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
211 Example : $oe->add_term($term)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
212 Returns : its argument.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
213 Args : object of class TermI.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
214
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
215
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
216 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
217
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
218 =head2 add_relationship
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
219
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
220 Title : add_relationship
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
221 Usage : add_relationship(RelationshipI relationship): RelationshipI
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
222 Function: Adds a relationship object to the ontology engine.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
223 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
224 Returns : Its argument.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
225 Args : A RelationshipI object.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
226
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
227
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
228 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
229
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
230 =head2 get_relationships
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
231
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
232 Title : get_relationships
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
233 Usage : get_relationships(TermI term): RelationshipI[]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
234 Function: Retrieves all relationship objects from this ontology engine,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
235 or all relationships of a term if a term is supplied.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
236 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
237 Returns : Array of Bio::Ontology::RelationshipI objects
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
238 Args : None, or a Bio::Ontology::TermI compliant object for which
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
239 to retrieve the relationships.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
240
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
241
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
242 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
243
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
244 =head2 get_predicate_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
245
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
246 Title : get_predicate_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
247 Usage : get_predicate_terms(): TermI[]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
248 Function:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
249 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
250 Returns :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
251 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
252
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
253
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
254 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
255
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
256 =head2 get_child_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
257
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
258 Title : get_child_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
259 Usage : get_child_terms(TermI term, TermI[] predicate_terms): TermI[]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
260 Function: Retrieves all child terms of a given term, that satisfy a
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
261 relationship among those that are specified in the second
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
262 argument or undef otherwise. get_child_terms is a special
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
263 case of get_descendant_terms, limiting the search to the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
264 direct descendants.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
265
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
266 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
267 Returns : Array of TermI objects.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
268 Args : First argument is the term of interest, second is the list
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
269 of relationship type terms.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
270
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
271
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
272 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
273
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
274 =head2 get_descendant_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
275
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
276 Title : get_descendant_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
277 Usage : get_descendant_terms(TermI term, TermI[] rel_types): TermI[]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
278 Function: Retrieves all descendant terms of a given term, that
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
279 satisfy a relationship among those that are specified in
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
280 the second argument or undef otherwise.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
281 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
282 Returns : Array of TermI objects.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
283 Args : First argument is the term of interest, second is the list
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
284 of relationship type terms.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
285
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
286
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
287 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
288
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
289 =head2 get_parent_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
290
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
291 Title : get_parent_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
292 Usage : get_parent_terms(TermI term, TermI[] predicate_terms): TermI[]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
293 Function: Retrieves all parent terms of a given term, that satisfy a
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
294 relationship among those that are specified in the second
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
295 argument or undef otherwise. get_parent_terms is a special
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
296 case of get_ancestor_terms, limiting the search to the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
297 direct ancestors.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
298
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
299 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
300 Returns : Array of TermI objects.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
301 Args : First argument is the term of interest, second is the list
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
302 of relationship type terms.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
303
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
304
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
305 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
306
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
307 =head2 get_ancestor_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
308
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
309 Title : get_ancestor_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
310 Usage : get_ancestor_terms(TermI term, TermI[] predicate_terms): TermI[]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
311 Function: Retrieves all ancestor terms of a given term, that satisfy
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
312 a relationship among those that are specified in the second
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
313 argument or undef otherwise.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
314
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
315 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
316 Returns : Array of TermI objects.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
317 Args : First argument is the term of interest, second is the list
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
318 of relationship type terms.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
319
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
320
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
321 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
322
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
323 =head2 get_leaf_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
324
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
325 Title : get_leaf_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
326 Usage : get_leaf_terms(): TermI[]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
327 Function: Retrieves all leaf terms from the ontology. Leaf term is a
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
328 term w/o descendants.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
329
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
330 Example : @leaf_terms = $obj->get_leaf_terms()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
331 Returns : Array of TermI objects.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
332 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
333
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
334
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
335 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
336
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
337 =head2 get_root_terms()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
338
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
339 Title : get_root_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
340 Usage : get_root_terms(): TermI[]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
341 Function: Retrieves all root terms from the ontology. Root term is a
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
342 term w/o descendants.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
343
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
344 Example : @root_terms = $obj->get_root_terms()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
345 Returns : Array of TermI objects.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
346 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
347
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
348
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
349 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
350
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
351 =head2 get_all_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
352
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
353 Title : get_all_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
354 Usage : get_all_terms: TermI[]
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
355 Function: Retrieves all terms from the ontology.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
356
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
357 We do not mandate an order here in which the terms are
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
358 returned. In fact, the default implementation will return
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
359 them in unpredictable order.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
360
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
361 Example : @terms = $obj->get_all_terms()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
362 Returns : Array of TermI objects.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
363 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
364
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
365
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
366 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
367
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
368
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
369 =head2 find_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
370
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
371 Title : find_terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
372 Usage : ($term) = $oe->find_terms(-identifier => "SO:0000263");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
373 Function: Find term instances matching queries for their attributes.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
374
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
375 An implementation may not support querying for arbitrary
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
376 attributes, but can generally be expected to accept
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
377 -identifier and -name as queries. If both are provided,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
378 they are implicitly intersected.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
379
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
380 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
381 Returns : an array of zero or more Bio::Ontology::TermI objects
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
382 Args : Named parameters. The following parameters should be recognized
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
383 by any implementation:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
384
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
385 -identifier query by the given identifier
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
386 -name query by the given name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
387
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
388
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
389 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
390
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
391 =head1 Factory for relationships and terms
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
392
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
393 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
394
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
395 =head2 relationship_factory
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
396
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
397 Title : relationship_factory
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
398 Usage : $fact = $obj->relationship_factory()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
399 Function: Get (and set, if the implementation supports it) the object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
400 factory to be used when relationship objects are created by
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
401 the implementation on-the-fly.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
402
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
403 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
404 Returns : value of relationship_factory (a Bio::Factory::ObjectFactoryI
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
405 compliant object)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
406 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
407
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
408
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
409 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
410
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
411 sub relationship_factory{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
412 return shift->throw_not_implemented();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
413 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
414
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
415 =head2 term_factory
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
416
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
417 Title : term_factory
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
418 Usage : $fact = $obj->term_factory()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
419 Function: Get (and set, if the implementation supports it) the object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
420 factory to be used when term objects are created by
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
421 the implementation on-the-fly.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
422
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
423 Example :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
424 Returns : value of term_factory (a Bio::Factory::ObjectFactoryI
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
425 compliant object)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
426 Args :
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
427
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
428
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
429 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
430
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
431 sub term_factory{
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
432 return shift->throw_not_implemented();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
433 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
434
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
435 1;