[Bio] / Sprout / DBQuery.pm Repository:
ViewVC logotype

Diff of /Sprout/DBQuery.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.6, Fri Oct 13 21:45:11 2006 UTC revision 1.7, Tue Apr 10 05:52:48 2007 UTC
# Line 2  Line 2 
2    
3      use strict;      use strict;
4      use DBKernel;      use DBKernel;
5      use DBObject;      use ERDBObject;
6      use DBI;      use DBI;
7      use Tracer;      use Tracer;
8    
# Line 28  Line 28 
28  participate in the feature. This would return a relationship iterator. Each position in the  participate in the feature. This would return a relationship iterator. Each position in the
29  iterator would contain a single B<IsLocatedIn> instance and a single B<Contig> instance.  iterator would contain a single B<IsLocatedIn> instance and a single B<Contig> instance.
30    
31  At each point in the result set, the iterator returns a B<DBObject>. The DBObject allows the  At each point in the result set, the iterator returns a B<ERDBObject>. The ERDBObject allows the
32  client to access the fields of the current entity or relationship instance.  client to access the fields of the current entity or relationship instance.
33    
34  It is also possible to ask for many different objects in a single iterator by chaining long  It is also possible to ask for many different objects in a single iterator by chaining long
# Line 36  Line 36 
36  B<ERDB> object's C<Get> method.  B<ERDB> object's C<Get> method.
37    
38  Finally, objects of this type should never by created directly. Instead, they are created  Finally, objects of this type should never by created directly. Instead, they are created
39  by the aforementioned C<Get> method and the B<DBObject>'s C<Cross> method.  by the aforementioned C<Get> method and the B<ERDBObject>'s C<Cross> method.
40    
41  =head2 Public Methods  =head2 Public Methods
42    
# Line 44  Line 44 
44    
45  C<< my $dbObject = $dbQuery->Fetch(); >>  C<< my $dbObject = $dbQuery->Fetch(); >>
46    
47  Retrieve a record from this query. The record returned will be a B<DBObject>, which  Retrieve a record from this query. The record returned will be a B<ERDBObject>, which
48  may represent a single entity instance or a list of entity instances joined by relationships.  may represent a single entity instance or a list of entity instances joined by relationships.
49  The first time this method is called it will return the first result from query. After that it  The first time this method is called it will return the first result from query. After that it
50  will continue sequentially. It will return an undefined value if we've reached the end of the  will continue sequentially. It will return an undefined value if we've reached the end of the
# Line 70  Line 70 
70          }          }
71      } else {      } else {
72          # Here we have a result, so we need to turn it into an instance object.          # Here we have a result, so we need to turn it into an instance object.
73          $retVal = DBObject::_new($self, @row);          $retVal = ERDBObject::_new($self, @row);
74          Trace("Row returned from query.") if T(4);          Trace("Row returned from query.") if T(4);
75      }      }
76      # Return the result.      # Return the result.
# Line 98  Line 98 
98  =item relationMap  =item relationMap
99    
100  Reference to a list of 2-tuples. Each tuple consists of an object name as used in the  Reference to a list of 2-tuples. Each tuple consists of an object name as used in the
101  query followed by the actual name of that object. This enables the B<DBObject> to  query followed by the actual name of that object. This enables the B<ERDBObject> to
102  determine the order of the tables in the query and which object name belongs to each  determine the order of the tables in the query and which object name belongs to each
103  mapped object name. Most of the time these two values are the same; however, if a  mapped object name. Most of the time these two values are the same; however, if a
104  relation occurs twice in the query, the relation name in the field list and WHERE  relation occurs twice in the query, the relation name in the field list and WHERE

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.7

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3