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

Diff of /Sprout/ERDBFinder.pm

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

revision 1.1, Mon Jan 19 21:41:55 2009 UTC revision 1.2, Tue Jun 30 19:53:01 2009 UTC
# Line 40  Line 40 
40  constructor. For each criterion name, the hash specifies an I<object name string>  constructor. For each criterion name, the hash specifies an I<object name string>
41  and a I<filter string>. The type of the desired entity objects is put in front of the  and a I<filter string>. The type of the desired entity objects is put in front of the
42  object name string, and the object name string, filter string, and criteria parameters  object name string, and the object name string, filter string, and criteria parameters
43  are all passed into the [[ErdbPm#Get]] function to return the desired objects. For  are all passed into the L<ERDB/Get> function to return the desired objects. For
44  example, consider a search for C<Feature> objects, and we want to be able to search  example, consider a search for C<Feature> objects, and we want to be able to search
45  on EC number. The criterion definition for C<EC number> would be something like this:  on EC number. The criterion definition for C<EC number> would be something like this:
46    
# Line 70  Line 70 
70    
71  =item erdb  =item erdb
72    
73  [[ErdbPm]] database object to be used to get the data.  L<ERDB> database object to be used to get the data.
74    
75  =item fieldHash  =item fieldHash
76    
# Line 78  Line 78 
78  sub-hash with two string fields: C<objects> contains the object name string and  sub-hash with two string fields: C<objects> contains the object name string and
79  C<filter> contains the filter clause string. The object name string and the  C<filter> contains the filter clause string. The object name string and the
80  filter clause string are combined with incoming parameters to create an  filter clause string are combined with incoming parameters to create an
81  [[ErdbPm#Get]] query that returns the desired objects.  L<ERDB/Get> query that returns the desired objects.
82    
83  =back  =back
84    
# Line 117  Line 117 
117    
118      my %results = $ff->Find($criteria);      my %results = $ff->Find($criteria);
119    
120  Use the incoming criteria to return a hash of [[ERDBObjectPm]] objects  Use the incoming criteria to return a hash of L<ERDBObject> objects
121  for the desired data.  for the desired data.
122    
123  =over 4  =over 4
# Line 133  Line 133 
133    
134  =item RETURN  =item RETURN
135    
136  Returns a hash of [[ERDBObjectPm]] objects for this finder's entity type, keyed  Returns a hash of L<ERDBObject> objects for this finder's entity type, keyed
137  on the entity ID. All of the objects must satisfy the incoming criteria.  on the entity ID. All of the objects must satisfy the incoming criteria.
138    
139  =back  =back
# Line 193  Line 193 
193  =item buffer  =item buffer
194    
195  A hash into which the results of the query will be stored. The hash will be keyed  A hash into which the results of the query will be stored. The hash will be keyed
196  on object ID and the value will be an [[ERDBObjectPm]] object for the entity of this  on object ID and the value will be an L<ERDBObject> object for the entity of this
197  finder's target type with the specified ID.  finder's target type with the specified ID.
198    
199  =item RETURN  =item RETURN

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3