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

Diff of /Sprout/SearchHelper.pm

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

revision 1.3, Fri Sep 29 15:10:05 2006 UTC revision 1.11, Mon Oct 16 07:44:13 2006 UTC
# Line 214  Line 214 
214                      }                      }
215                  }                  }
216              }              }
         }  
217          # Close the session file.          # Close the session file.
218          $self->CloseSession();          $self->CloseSession();
219            }
220          # Return the result count.          # Return the result count.
221          return $retVal;          return $retVal;
222      }      }
# Line 237  Line 237 
237  by calling L</SetMessage>. If the parameters are valid, then the method must return  by calling L</SetMessage>. If the parameters are valid, then the method must return
238  the number of items found.  the number of items found.
239    
 =head2 Virtual Methods  
   
 =head3 Form  
   
 C<< my $html = $shelp->Form(); >>  
   
 Generate the HTML for a form to request a new search.  
   
 =head3 Find  
   
 C<< my $resultCount = $shelp->Find(); >>  
   
 Conduct a search based on the current CGI query parameters. The search results will  
 be written to the session cache file and the number of results will be  
 returned. If the search parameters are invalid, a result count of C<undef> will be  
 returned and a result message will be stored in this object describing the problem.  
   
 =head3 Description  
   
 C<< my $htmlText = $shelp->Description(); >>  
   
 Return a description of this search. The description is used for the table of contents  
 on the main search tools page. It may contain HTML, but it should be character-level,  
 not block-level, since the description is going to appear in a list.  
   
240  =cut  =cut
241    
242  # This counter is used to insure every form on the page has a unique name.  # This counter is used to insure every form on the page has a unique name.
# Line 341  Line 316 
316      return $self->{query};      return $self->{query};
317  }  }
318    
319    
320    
321  =head3 DB  =head3 DB
322    
323  C<< my $sprout = $shelp->DB(); >>  C<< my $sprout = $shelp->DB(); >>
# Line 632  Line 609 
609    
610  =head3 PutFeature  =head3 PutFeature
611    
612  C<< $shelp->PutFeature($fquery); >>  C<< $shelp->PutFeature($fdata); >>
613    
614  Store a feature in the result cache. This is the workhorse method for most  Store a feature in the result cache. This is the workhorse method for most
615  searches, since the primary data item in the database is features.  searches, since the primary data item in the database is features.
# Line 643  Line 620 
620  the feature query object using the B<AddExtraColumns> method. For example, the following  the feature query object using the B<AddExtraColumns> method. For example, the following
621  code adds columns for essentiality and virulence.  code adds columns for essentiality and virulence.
622    
623      $fq->AddExtraColumns(essential => $essentialFlag, virulence => $vfactor);      $fd->AddExtraColumns(essential => $essentialFlag, virulence => $vfactor);
624      $shelp->PutFeature($fq);      $shelp->PutFeature($fd);
625    
626  For correct results, all values should be specified for all extra columns in all calls to  For correct results, all values should be specified for all extra columns in all calls to
627  B<PutFeature>. (In particular, the column header names are computed on the first  B<PutFeature>. (In particular, the column header names are computed on the first
# Line 654  Line 631 
631      if (! $essentialFlag) {      if (! $essentialFlag) {
632          $essentialFlag = undef;          $essentialFlag = undef;
633      }      }
634      $fq->AddExtraColumns(essential => $essentialFlag, virulence => $vfactor);      $fd->AddExtraColumns(essential => $essentialFlag, virulence => $vfactor);
635      $shelp->PutFeature($fq);      $shelp->PutFeature($fd);
636    
637  =over 4  =over 4
638    
639  =item fquery  =item fdata
640    
641  FeatureQuery object containing the current feature data.  B<FeatureData> object containing the current feature data.
642    
643  =back  =back
644    
# Line 669  Line 646 
646    
647  sub PutFeature {  sub PutFeature {
648      # Get the parameters.      # Get the parameters.
649      my ($self, $fq) = @_;      my ($self, $fd) = @_;
650      # Get the CGI query object.      # Get the CGI query object.
651      my $cgi = $self->Q();      my $cgi = $self->Q();
652      # Get the feature data.      # Get the feature data.
653      my $record = $fq->Feature();      my $record = $fd->Feature();
654      my $extraCols = $fq->ExtraCols();      my $extraCols = $fd->ExtraCols();
655      # Check for a first-call situation.      # Check for a first-call situation.
656      if (! defined $self->{cols}) {      if (! defined $self->{cols}) {
657          # Here we need to set up the column information. Start with the defaults.          # Here we need to set up the column information. Start with the defaults.
658          $self->{cols} = $self->DefaultFeatureColumns();          $self->{cols} = $self->DefaultFeatureColumns();
659          # Add the externals if they were requested.          # Add any additional columns requested by the feature filter.
660          if ($cgi->param('ShowAliases')) {          push @{$self->{cols}}, FeatureQuery::AdditionalColumns($self);
             push @{$self->{cols}}, 'alias';  
         }  
661          # Append the extras, sorted by column name.          # Append the extras, sorted by column name.
662          for my $col (sort keys %{$extraCols}) {          for my $col (sort keys %{$extraCols}) {
663              push @{$self->{cols}}, "X=$col";              push @{$self->{cols}}, "X=$col";
# Line 692  Line 667 
667          $self->WriteColumnHeaders(map { $self->FeatureColumnTitle($_) } @{$self->{cols}});          $self->WriteColumnHeaders(map { $self->FeatureColumnTitle($_) } @{$self->{cols}});
668      }      }
669      # Get the feature ID.      # Get the feature ID.
670      my ($fid) = $record->Value('Feature(id)');      my $fid = $fd->FID();
671      # Loop through the column headers, producing the desired data.      # Loop through the column headers, producing the desired data.
672      my @output = ();      my @output = ();
673      for my $colName (@{$self->{cols}}) {      for my $colName (@{$self->{cols}}) {
674          push @output, $self->FeatureColumnValue($colName, $record, $extraCols);          push @output, $self->FeatureColumnValue($colName, $record, $extraCols);
675      }      }
676      # Compute the sort key. The sort key floats NMPDR organism features to the      # Compute the sort key. The sort key usually floats NMPDR organism features to the
677      # top of the return list.      # top of the return list.
678      my $group = $self->FeatureGroup($fid);      my $key = $self->SortKey($fd);
     my $key = ($group ? "A$group" : "ZZ");  
679      # Write the feature data.      # Write the feature data.
680      $self->WriteColumnData($key, @output);      $self->WriteColumnData($key, @output);
681  }  }
# Line 782  Line 756 
756      # Check for an open session file.      # Check for an open session file.
757      if (defined $self->{fileHandle}) {      if (defined $self->{fileHandle}) {
758          # We found one, so close it.          # We found one, so close it.
759            Trace("Closing session file.") if T(2);
760          close $self->{fileHandle};          close $self->{fileHandle};
761      }      }
762  }  }
# Line 799  Line 774 
774      my $retVal;      my $retVal;
775      # Get a digest encoder.      # Get a digest encoder.
776      my $md5 = Digest::MD5->new();      my $md5 = Digest::MD5->new();
777      # If we have a randomization file, use it to seed the digester.      # Add the PID, the IP, and the time stamp. Note that the time stamp is
778      if (open(R, "/dev/urandom")) {      # actually two numbers, and we get them both because we're in list
779          my $b;      # context.
780          read(R, $b, 1024);      $md5->add($$, $ENV{REMOTE_ADDR}, $ENV{REMOTE_PORT}, gettimeofday());
781          $md5->add($b);      # Hash up all this identifying data.
782      }      $retVal = $md5->hexdigest();
783      # Add the PID and the time stamp.      # Return the result.
     $md5->add($$, gettimeofday);  
     # Hash it up and clean the result so that it works as a file name.  
     $retVal = $md5->b64digest();  
     $retVal =~ s,/,\$,g;  
     $retVal =~ s,\+,@,g;  
     # Return it.  
784      return $retVal;      return $retVal;
785  }  }
786    
# Line 855  Line 824 
824                                                      ['Genome(genus)', 'Genome(species)',                                                      ['Genome(genus)', 'Genome(species)',
825                                                       'Genome(unique-characterization)',                                                       'Genome(unique-characterization)',
826                                                       'Genome(primary-group)']);                                                       'Genome(primary-group)']);
827          # Null out the supporting group.          # Format and cache the name and display group.
828          $group = "" if ($group eq $FIG_Config::otherGroup);          ($orgName, $group) = $self->SaveOrganismData($group, $genomeID, $genus, $species,
829          # If the organism does not exist, format an unknown name.                                                              $strain);
         if (! defined($genus)) {  
             $orgName = "Unknown Genome $genomeID";  
         } else {  
             # It does exist, so format the organism name.  
             $orgName = "$genus $species";  
             if ($strain) {  
                 $orgName .= " $strain";  
             }  
         }  
         # Save this organism in the cache.  
         $cache->{$genomeID} = [$orgName, $group];  
830      }      }
831      # Return the result.      # Return the result.
832      return ($orgName, $group);      return ($orgName, $group);
# Line 970  Line 928 
928      } else {      } else {
929          # Here we can get its genome data.          # Here we can get its genome data.
930          $retVal = $self->Organism($genomeID);          $retVal = $self->Organism($genomeID);
931          # Append the type and number.          # Append the FIG ID.
932          $retVal .= " [$type $num]";          $retVal .= " [$fid]";
933      }      }
934      # Return the result.      # Return the result.
935      return $retVal;      return $retVal;
# Line 1019  Line 977 
977      my ($self, $incomingType, $desiredType, $sequence) = @_;      my ($self, $incomingType, $desiredType, $sequence) = @_;
978      # Declare the return variable. If an error occurs, it will remain undefined.      # Declare the return variable. If an error occurs, it will remain undefined.
979      my $retVal;      my $retVal;
980        # This variable will be cleared if an error is detected.
981        my $okFlag = 1;
982      # Create variables to hold the FASTA label and data.      # Create variables to hold the FASTA label and data.
983      my ($fastaLabel, $fastaData);      my ($fastaLabel, $fastaData);
984        Trace("FASTA incoming type is $incomingType, desired type is $desiredType.") if T(4);
985      # Check for a feature specification.      # Check for a feature specification.
986      if ($sequence =~ /^\s*(\w+\|\S+)\s*$/) {      if ($sequence =~ /^\s*(\w+\|\S+)\s*$/) {
987          # Here we have a feature ID in $1. We'll need the Sprout object to process          # Here we have a feature ID in $1. We'll need the Sprout object to process
988          # it.          # it.
989          my $fid = $1;          my $fid = $1;
990            Trace("Feature ID for fasta is $fid.") if T(3);
991          my $sprout = $self->DB();          my $sprout = $self->DB();
992          # Get the FIG ID. Note that we only use the first feature found. We are not          # Get the FIG ID. Note that we only use the first feature found. We are not
993          # supposed to have redundant aliases, though we may have an ID that doesn't          # supposed to have redundant aliases, though we may have an ID that doesn't
# Line 1033  Line 995 
995          my ($figID) = $sprout->FeaturesByAlias($fid);          my ($figID) = $sprout->FeaturesByAlias($fid);
996          if (! $figID) {          if (! $figID) {
997              $self->SetMessage("No feature found with the ID \"$fid\".");              $self->SetMessage("No feature found with the ID \"$fid\".");
998                $okFlag = 0;
999          } else {          } else {
1000              # Set the FASTA label.              # Set the FASTA label.
1001              my $fastaLabel = $fid;              my $fastaLabel = $fid;
1002              # Now proceed according to the sequence type.              # Now proceed according to the sequence type.
1003              if ($desiredType =~ /prot/i) {              if ($desiredType eq 'prot') {
1004                  # We want protein, so get the translation.                  # We want protein, so get the translation.
1005                  $fastaData = $sprout->FeatureTranslation($figID);                  $fastaData = $sprout->FeatureTranslation($figID);
1006                    Trace(length $fastaData . " characters returned for translation of $fastaLabel.") if T(3);
1007              } else {              } else {
1008                  # We want DNA, so get the DNA sequence. This is a two-step process.                  # We want DNA, so get the DNA sequence. This is a two-step process.
1009                  my @locList = $sprout->FeatureLocation($figID);                  my @locList = $sprout->FeatureLocation($figID);
1010                  $fastaData = $sprout->DNASeq(\@locList);                  $fastaData = $sprout->DNASeq(\@locList);
1011                    Trace(length $fastaData . " characters returned for DNA of $fastaLabel.") if T(3);
1012              }              }
1013          }          }
1014      } elsif ($incomingType =~ /prot/ && $desiredType =~ /dna/) {      } elsif ($incomingType eq 'prot' && $desiredType eq 'dna') {
1015          # Here we're being asked to do an impossible conversion.          # Here we're being asked to do an impossible conversion.
1016          $self->SetMessage("Cannot convert a protein sequence to DNA.");          $self->SetMessage("Cannot convert a protein sequence to DNA.");
1017            $okFlag = 0;
1018      } else {      } else {
1019            Trace("Analyzing FASTA sequence.") if T(4);
1020          # Here we are expecting a FASTA. We need to see if there's a label.          # Here we are expecting a FASTA. We need to see if there's a label.
1021          if ($sequence =~ /^>\s*(\S.*)\s*\n(.+)$/) {          if ($sequence =~ /^>[\n\s]*(\S[^\n]*)\n(.+)$/s) {
1022                Trace("Label \"$1\" found in match to sequence:\n$sequence") if T(4);
1023              # Here we have a label, so we split it from the data.              # Here we have a label, so we split it from the data.
1024              $fastaLabel = $1;              $fastaLabel = $1;
1025              $fastaData = $2;              $fastaData = $2;
1026          } else {          } else {
1027                Trace("No label found in match to sequence:\n$sequence") if T(4);
1028              # Here we have no label, so we create one and use the entire sequence              # Here we have no label, so we create one and use the entire sequence
1029              # as data.              # as data.
1030              $fastaLabel = "User-specified $incomingType sequence";              $fastaLabel = "User-specified $incomingType sequence";
# Line 1068  Line 1037 
1037          # we've already prevented a conversion from protein to DNA.          # we've already prevented a conversion from protein to DNA.
1038          if ($incomingType ne $desiredType) {          if ($incomingType ne $desiredType) {
1039              $fastaData = Sprout::Protein($fastaData);              $fastaData = Sprout::Protein($fastaData);
1040                # Check for bad characters.
1041                if ($fastaData =~ /X/) {
1042                    $self->SetMessage("Invalid characters detected. Is the input really of type $incomingType?");
1043                    $okFlag = 0;
1044                }
1045            } elsif ($desiredType eq 'dna' && $fastaData =~ /[^agct]/i) {
1046                $self->SetMessage("Invaid characters detected. Is the input really a DNA sequence?");
1047                $okFlag = 0;
1048          }          }
1049      }      }
1050      # At this point, either "$fastaLabel" and "$fastaData" have values or an error is      Trace("FASTA data sequence: $fastaData") if T(4);
1051      # in progress.      # Only proceed if no error was detected.
1052      if (defined $fastaLabel) {      if ($okFlag) {
1053          # We need to format the sequence into 60-byte chunks. We use the infamous          # We need to format the sequence into 60-byte chunks. We use the infamous
1054          # grep-split trick. The split, because of the presence of the parentheses,          # grep-split trick. The split, because of the presence of the parentheses,
1055          # includes the matched delimiters in the output list. The grep strips out          # includes the matched delimiters in the output list. The grep strips out
1056          # the empty list items that appear between the so-called delimiters, since          # the empty list items that appear between the so-called delimiters, since
1057          # the delimiters are what we want.          # the delimiters are what we want.
1058          my @chunks = grep { $_ } split /(.{1,60})/, $fastaData;          my @chunks = grep { $_ } split /(.{1,60})/, $fastaData;
1059          my $retVal = join("\n", ">$fastaLabel", @chunks, "");          $retVal = join("\n", ">$fastaLabel", @chunks, "");
1060      }      }
1061      # Return the result.      # Return the result.
1062      return $retVal;      return $retVal;
# Line 1114  Line 1091 
1091  Number of rows to display. If omitted, the default is 1 for a single-select list  Number of rows to display. If omitted, the default is 1 for a single-select list
1092  and 10 for a multi-select list.  and 10 for a multi-select list.
1093    
1094    =item crossMenu (optional)
1095    
1096    If specified, is presumed to be the name of another genome menu whose contents
1097    are to be mutually exclusive with the contents of this menu. As a result, instead
1098    of the standard onChange event, the onChange event will deselect any entries in
1099    the other menu.
1100    
1101  =item RETURN  =item RETURN
1102    
1103  Returns the HTML text to generate a C<SELECT> menu inside a form.  Returns the HTML text to generate a C<SELECT> menu inside a form.
# Line 1124  Line 1108 
1108    
1109  sub NmpdrGenomeMenu {  sub NmpdrGenomeMenu {
1110      # Get the parameters.      # Get the parameters.
1111      my ($self, $menuName, $multiple, $selected, $rows) = @_;      my ($self, $menuName, $multiple, $selected, $rows, $cross) = @_;
1112      # Get the Sprout and CGI objects.      # Get the Sprout and CGI objects.
1113      my $sprout = $self->DB();      my $sprout = $self->DB();
1114      my $cgi = $self->Q();      my $cgi = $self->Q();
# Line 1158  Line 1142 
1142          for my $genome (@genomeList) {          for my $genome (@genomeList) {
1143              # Get the genome data.              # Get the genome data.
1144              my ($group, $genomeID, $genus, $species, $strain) = @{$genome};              my ($group, $genomeID, $genus, $species, $strain) = @{$genome};
1145              # Form the genome name.              # Compute and cache its name and display group.
1146              my $name = "$genus $species";              my ($name, $displayGroup) = $self->SaveOrganismData($group, $genomeID, $genus, $species,
1147              if ($strain) {                                                                  $strain);
1148                  $name .= " $strain";              # Push the genome into the group's list. Note that we use the real group
1149              }              # name here, not the display group name.
             # Push the genome into the group's list.  
1150              push @{$gHash{$group}}, [$genomeID, $name];              push @{$gHash{$group}}, [$genomeID, $name];
1151          }          }
1152          # Save the genome list for future use.          # Save the genome list for future use.
# Line 1189  Line 1172 
1172      my $showSelect = "showSelected($menuName, '$divID', 1000);";      my $showSelect = "showSelected($menuName, '$divID', 1000);";
1173      # If multiple selection is supported, create an onChange event.      # If multiple selection is supported, create an onChange event.
1174      my $onChange = "";      my $onChange = "";
1175      if ($multiple) {      if ($cross) {
1176            $onChange = " onChange=\"crossUnSelect($menuName, '$divID', $cross, '${formName}_${cross}_status', 1000)\"";
1177        } elsif ($multiple) {
1178          $onChange = " onChange=\"$showSelect\"";          $onChange = " onChange=\"$showSelect\"";
1179      }      }
1180      # Create the SELECT tag and stuff it into the output array.      # Create the SELECT tag and stuff it into the output array.
# Line 1370  Line 1355 
1355      # Create the row.      # Create the row.
1356      my $retVal = $cgi->Tr($cgi->td("Results/Page"),      my $retVal = $cgi->Tr($cgi->td("Results/Page"),
1357                            $cgi->td($cgi->popup_menu(-name => 'PageSize',                            $cgi->td($cgi->popup_menu(-name => 'PageSize',
1358                                                      -values => [10, 25, 45, 100, 1000],                                                      -values => [10, 25, 50, 100, 1000],
1359                                                      -default => $pageSize) . " " .                                                      -default => $pageSize) . " " .
                                    $cgi->checkbox(-name => 'ShowAliases',  
                                                   -value => 1,  
                                                   -label => 'Show Alias Links',  
                                                   -default => $aliases),  
1360                                     $cgi->checkbox(-name => 'ShowURL',                                     $cgi->checkbox(-name => 'ShowURL',
1361                                                    -value => 1,                                                    -value => 1,
1362                                                    -label => 'Show URL')),                                                    -label => 'Show URL')),
# Line 1390  Line 1371 
1371    
1372  C<< my $htmlText = $shelp->FeatureFilterRows(); >>  C<< my $htmlText = $shelp->FeatureFilterRows(); >>
1373    
1374  This method creates table rows that can be used to filter features. There are  This method creates table rows that can be used to filter features. The form
1375  two rows returned, and the values can be used to select features by genome  values can be used to select features by genome using the B<FeatureQuery>
1376  using the B<FeatureQuery> object.  object.
1377    
1378  =cut  =cut
1379    
# Line 1442  Line 1423 
1423          # Get the feature location string.          # Get the feature location string.
1424          my $loc = $sprout->FeatureLocation($feat);          my $loc = $sprout->FeatureLocation($feat);
1425          # Compute the contig, start, and stop points.          # Compute the contig, start, and stop points.
1426          my($start, $stop, $contig) = BasicLocation::Parse($loc);          my($contig, $start, $stop) = BasicLocation::Parse($loc);
1427            Trace("Start and stop are ($start,$stop) on contig $contig.") if T(3);
1428          # Now we need to do some goofiness to insure that the location is not too          # Now we need to do some goofiness to insure that the location is not too
1429          # big and that we get some surrounding stuff.          # big and that we get some surrounding stuff.
1430          my $mid = int(($start + $stop) / 2);          my $mid = int(($start + $stop) / 2);
# Line 1472  Line 1454 
1454          }          }
1455          my $seg_id = $contig;          my $seg_id = $contig;
1456          $seg_id =~ s/:/--/g;          $seg_id =~ s/:/--/g;
1457            Trace("Show limits are ($show_start,$show_stop) in genome $genomeID with ref $seg_id.") if T(3);
1458          # Assemble all the pieces.          # Assemble all the pieces.
1459          $retVal = "gbrowse.cgi/GB_$genomeID?ref=$seg_id&start=$show_start&stop=$show_stop";          $retVal = "gbrowse.cgi/GB_$genomeID?ref=$seg_id&start=$show_start&stop=$show_stop";
1460      }      }
# Line 1683  Line 1666 
1666      return $retVal;      return $retVal;
1667  }  }
1668    
1669    =head3 FeatureTypeMap
1670    
1671    C<< my %features = SearchHelper::FeatureTypeMap(); >>
1672    
1673    Return a map of feature types to descriptions. The feature type data is stored
1674    in the B<FIG_Config> file. Currently, it only contains a space-delimited list of
1675    feature types. The map returned by this method is a hash mapping the type codes to
1676    descriptive names.
1677    
1678    The reason we have to convert the list from a string is that the B<NMPDRSetup.pl>
1679    script is only able to insert strings into the generated B<FIG_Config> file.
1680    
1681    =cut
1682    
1683    sub FeatureTypeMap {
1684        my @list = split /\s+/, $FIG_Config::feature_types;
1685        my %retVal = map { $_ => $_ } @list;
1686        return %retVal;
1687    }
1688    
1689    =head3 AdvancedClassList
1690    
1691    C<< my @classes = SearchHelper::AdvancedClassList(); >>
1692    
1693    Return a list of advanced class names. This list is used to generate the directory
1694    of available searches on the search page.
1695    
1696    The reason we have to convert the list from a string is that the B<NMPDRSetup.pl>
1697    script is only able to insert strings into the generated B<FIG_Config> file.
1698    
1699    =cut
1700    
1701    sub AdvancedClassList {
1702        return split /\s+/, $FIG_Config::advanced_classes;
1703    }
1704    
1705  =head2 Feature Column Methods  =head2 Feature Column Methods
1706    
1707  The methods in this column manage feature column data. If you want to provide the  The methods in this column manage feature column data. If you want to provide the
# Line 1715  Line 1734 
1734      # Get the parameters.      # Get the parameters.
1735      my ($self) = @_;      my ($self) = @_;
1736      # Return the result.      # Return the result.
1737      return ['orgName', 'function', 'gblink', 'protlink'];      return ['orgName', 'function', 'gblink', 'protlink',
1738                FeatureQuery::AdditionalColumns($self)];
1739  }  }
1740    
1741  =head3 FeatureColumnTitle  =head3 FeatureColumnTitle
# Line 1909  Line 1929 
1929      return $retVal;      return $retVal;
1930  }  }
1931    
1932    =head3 SaveOrganismData
1933    
1934    C<< my ($name, $displayGroup) = $shelp->SaveOrganismData($group, $genomeID, $genus, $species, $strain); >>
1935    
1936    Format the name of an organism and the display version of its group name. The incoming
1937    data should be the relevant fields from the B<Genome> record in the database. The
1938    data will also be stored in the genome cache for later use in posting search results.
1939    
1940    =over 4
1941    
1942    =item group
1943    
1944    Name of the genome's group as it appears in the database.
1945    
1946    =item genomeID
1947    
1948    ID of the relevant genome.
1949    
1950    =item genus
1951    
1952    Genus of the genome's organism. If undefined or null, it will be assumed the genome is not
1953    in the database. In this case, the organism name is derived from the genomeID and the group
1954    is automatically the supporting-genomes group.
1955    
1956    =item species
1957    
1958    Species of the genome's organism.
1959    
1960    =item strain
1961    
1962    Strain of the species represented by the genome.
1963    
1964    =item RETURN
1965    
1966    Returns a two-element list. The first element is the formatted genome name. The second
1967    element is the display name of the genome's group.
1968    
1969    =back
1970    
1971    =cut
1972    
1973    sub SaveOrganismData {
1974        # Get the parameters.
1975        my ($self, $group, $genomeID, $genus, $species, $strain) = @_;
1976        # Declare the return values.
1977        my ($name, $displayGroup);
1978        # If the organism does not exist, format an unknown name and a blank group.
1979        if (! defined($genus)) {
1980            $name = "Unknown Genome $genomeID";
1981            $displayGroup = "";
1982        } else {
1983            # It does exist, so format the organism name.
1984            $name = "$genus $species";
1985            if ($strain) {
1986                $name .= " $strain";
1987            }
1988            # Compute the display group. This is currently the same as the incoming group
1989            # name unless it's the supporting group, which is nulled out.
1990            $displayGroup = ($group eq $FIG_Config::otherGroup ? "" : $group);
1991        }
1992        # Cache the group and organism data.
1993        my $cache = $self->{orgs};
1994        $cache->{$genomeID} = [$name, $displayGroup];
1995        # Return the result.
1996        return ($name, $displayGroup);
1997    }
1998    
1999    =head2 Virtual Methods
2000    
2001    =head3 Form
2002    
2003    C<< my $html = $shelp->Form(); >>
2004    
2005    Generate the HTML for a form to request a new search.
2006    
2007    =head3 Find
2008    
2009    C<< my $resultCount = $shelp->Find(); >>
2010    
2011    Conduct a search based on the current CGI query parameters. The search results will
2012    be written to the session cache file and the number of results will be
2013    returned. If the search parameters are invalid, a result count of C<undef> will be
2014    returned and a result message will be stored in this object describing the problem.
2015    
2016    =head3 Description
2017    
2018    C<< my $htmlText = $shelp->Description(); >>
2019    
2020    Return a description of this search. The description is used for the table of contents
2021    on the main search tools page. It may contain HTML, but it should be character-level,
2022    not block-level, since the description is going to appear in a list.
2023    
2024    =head3 SortKey
2025    
2026    C<< my $key = $shelp->SortKey($fdata); >>
2027    
2028    Return the sort key for the specified feature data. The default is to sort by feature name,
2029    floating NMPDR organisms to the top. If a full-text search is used, then the default
2030    sort is by relevance followed by feature name. This sort may be overridden by the
2031    search class to provide fancier functionality. This method is called by
2032    B<PutFeature>, so it is only used for feature searches. A non-feature search
2033    would presumably have its own sort logic.
2034    
2035    =over 4
2036    
2037    =item record
2038    
2039    The C<FeatureData> containing the current feature.
2040    
2041    =item RETURN
2042    
2043    Returns a key field that can be used to sort this row in among the results.
2044    
2045    =back
2046    
2047    =cut
2048    
2049    sub SortKey {
2050        # Get the parameters.
2051        my ($self, $fdata) = @_;
2052        # Get the feature ID from the record.
2053        my $fid = $fdata->FID();
2054        # Get the group from the feature ID.
2055        my $group = $self->FeatureGroup($fid);
2056        # Ask the feature query object to form the sort key.
2057        my $retVal = $fdata->SortKey($self, $group);
2058        # Return the result.
2059        return $retVal;
2060    }
2061    
2062  1;  1;

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3