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

Diff of /Sprout/RHLocations.pm

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

revision 1.3, Mon Aug 20 23:21:03 2007 UTC revision 1.4, Thu Dec 6 14:58:03 2007 UTC
# Line 33  Line 33 
33    
34  =head3 new  =head3 new
35    
36  C<< my $rhelp = RHLocations->new($shelp); >>      my $rhelp = RHLocations->new($shelp);
37    
38  Construct a new RHLocations object.  Construct a new RHLocations object.
39    
# Line 59  Line 59 
59    
60  =head3 BuildLocationRecord  =head3 BuildLocationRecord
61    
62  C<< my $erdbObject = RHLocations::BuildLocationRecord($hitLocString); >>      my $erdbObject = RHLocations::BuildLocationRecord($hitLocString);
63    
64  Build an B<ERDBObject> containing data about a specified location. Unlike most  Build an B<ERDBObject> containing data about a specified location. Unlike most
65  result objects, a location does not exist in the Sprout database. This method  result objects, a location does not exist in the Sprout database. This method
# Line 111  Line 111 
111    
112  =head3 HitLocation  =head3 HitLocation
113    
114  C<< my $locString = $rhelp->HitLocation(); >>      my $locString = $rhelp->HitLocation();
115    
116  Return the hit location string for the current output line.  Return the hit location string for the current output line.
117    
# Line 128  Line 128 
128    
129  =head3 FindNearbyFeature  =head3 FindNearbyFeature
130    
131  C<< my $featureObject = $rhelp->FindNearbyFeature($hitLoc); >>      my $featureObject = $rhelp->FindNearbyFeature($hitLoc);
132    
133  Find a nearby feature for this hit location. If the hit location is a protein  Find a nearby feature for this hit location. If the hit location is a protein
134  location (i.e. inside a known feature), then the feature is returned without  location (i.e. inside a known feature), then the feature is returned without
# Line 222  Line 222 
222    
223  =head3 NearbyFeature  =head3 NearbyFeature
224    
225  C<< my $featureRecord = $rhelp->NearbyFeature($hitLoc); >>      my $featureRecord = $rhelp->NearbyFeature($hitLoc);
226    
227  Return the nearby feature. If it has already been found, we return it from the  Return the nearby feature. If it has already been found, we return it from the
228  cache. Otherwise we find it and then cache it on our way out.  cache. Otherwise we find it and then cache it on our way out.
# Line 266  Line 266 
266    
267  =head3 DefaultResultColumns  =head3 DefaultResultColumns
268    
269  C<< my @colNames = $rhelp->DefaultResultColumns(); >>      my @colNames = $rhelp->DefaultResultColumns();
270    
271  Return a list of the default columns to be used by searches with this  Return a list of the default columns to be used by searches with this
272  type of result. Note that the actual default columns are computed by  type of result. Note that the actual default columns are computed by
# Line 286  Line 286 
286    
287  =head3 compareLink  =head3 compareLink
288    
289  C<< my $colDatum = RHLocations::compareLink($type => $rhelp, $key); >>      my $colDatum = RHLocations::compareLink($type => $rhelp, $key);
290    
291  This method computes the various things we need to know into order to process  This method computes the various things we need to know into order to process
292  the compareLink column.  the compareLink column.
# Line 357  Line 357 
357    
358  =head3 nextFeature  =head3 nextFeature
359    
360  C<< my $colDatum = RHLocations::nextFeature($type => $rhelp, $key); >>      my $colDatum = RHLocations::nextFeature($type => $rhelp, $key);
361    
362  This method computes the various things we need to know into order to process  This method computes the various things we need to know into order to process
363  the nextFeature column.  the nextFeature column.
# Line 419  Line 419 
419    
420  =head3 nextFeatureFunction  =head3 nextFeatureFunction
421    
422  C<< my $colDatum = RHLocations::nextFeatureFunction($type => $rhelp, $key); >>      my $colDatum = RHLocations::nextFeatureFunction($type => $rhelp, $key);
423    
424  This method computes the various things we need to know into order to process  This method computes the various things we need to know into order to process
425  the nextFeatureFunction column.  the nextFeatureFunction column.
# Line 481  Line 481 
481    
482  =head3 nextFeatureLink  =head3 nextFeatureLink
483    
484  C<< my $colDatum = RHLocations::nextFeatureLink($type => $rhelp, $key); >>      my $colDatum = RHLocations::nextFeatureLink($type => $rhelp, $key);
485    
486  This method computes the various things we need to know into order to process  This method computes the various things we need to know into order to process
487  the nextFeatureLink column.  the nextFeatureLink column.
# Line 546  Line 546 
546    
547  =head3 orgName  =head3 orgName
548    
549  C<< my $colDatum = RHLocations::orgName($type => $rhelp, $key); >>      my $colDatum = RHLocations::orgName($type => $rhelp, $key);
550    
551  This method computes the various things we need to know into order to process  This method computes the various things we need to know into order to process
552  the orgName column.  the orgName column.

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3