[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.7, Tue Oct 3 11:05:45 2006 UTC revision 1.15, Fri Nov 10 22:01:36 2006 UTC
# Line 113  Line 113 
113    
114  =item 4  =item 4
115    
116  In the C<SearchSkeleton.cgi> script, add a C<use> statement for your search tool  In the C<SearchSkeleton.cgi> script and add a C<use> statement for your search tool.
 and then put the class name in the C<@advancedClasses> list.  
117    
118  =back  =back
119    
# Line 177  Line 176 
176    
177  =back  =back
178    
179    If you are doing a feature search, you can also change the list of feature
180    columns displayed and their display order by overriding
181    L</DefaultFeatureColumns>.
182    
183  Finally, when generating the code for your controls, be sure to use any incoming  Finally, when generating the code for your controls, be sure to use any incoming
184  query parameters as default values so that the search request is persistent.  query parameters as default values so that the search request is persistent.
185    
# Line 214  Line 217 
217                      }                      }
218                  }                  }
219              }              }
         }  
220          # Close the session file.          # Close the session file.
221          $self->CloseSession();          $self->CloseSession();
222            }
223          # Return the result count.          # Return the result count.
224          return $retVal;          return $retVal;
225      }      }
226    
227  A Find method is of course much more complicated than generating a form, and there  A Find method is of course much more complicated than generating a form, and there
228  are variations on the above them. For example, you could eschew feature filtering  are variations on the above theme. For example, you could eschew feature filtering
229  entirely in favor of your own custom filtering, you could include extra columns  entirely in favor of your own custom filtering, you could include extra columns
230  in the output, or you could search for something that's not a feature at all. The  in the output, or you could search for something that's not a feature at all. The
231  above code is just a loose framework.  above code is just a loose framework.
# Line 316  Line 319 
319      return $self->{query};      return $self->{query};
320  }  }
321    
322    
323    
324  =head3 DB  =head3 DB
325    
326  C<< my $sprout = $shelp->DB(); >>  C<< my $sprout = $shelp->DB(); >>
# Line 607  Line 612 
612    
613  =head3 PutFeature  =head3 PutFeature
614    
615  C<< $shelp->PutFeature($fquery); >>  C<< $shelp->PutFeature($fdata); >>
616    
617  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
618  searches, since the primary data item in the database is features.  searches, since the primary data item in the database is features.
# Line 618  Line 623 
623  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
624  code adds columns for essentiality and virulence.  code adds columns for essentiality and virulence.
625    
626      $fq->AddExtraColumns(essential => $essentialFlag, virulence => $vfactor);      $fd->AddExtraColumns(essential => $essentialFlag, virulence => $vfactor);
627      $shelp->PutFeature($fq);      $shelp->PutFeature($fd);
628    
629  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
630  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 629  Line 634 
634      if (! $essentialFlag) {      if (! $essentialFlag) {
635          $essentialFlag = undef;          $essentialFlag = undef;
636      }      }
637      $fq->AddExtraColumns(essential => $essentialFlag, virulence => $vfactor);      $fd->AddExtraColumns(essential => $essentialFlag, virulence => $vfactor);
638      $shelp->PutFeature($fq);      $shelp->PutFeature($fd);
639    
640  =over 4  =over 4
641    
642  =item fquery  =item fdata
643    
644  FeatureQuery object containing the current feature data.  B<FeatureData> object containing the current feature data.
645    
646  =back  =back
647    
# Line 644  Line 649 
649    
650  sub PutFeature {  sub PutFeature {
651      # Get the parameters.      # Get the parameters.
652      my ($self, $fq) = @_;      my ($self, $fd) = @_;
653      # Get the CGI query object.      # Get the CGI query object.
654      my $cgi = $self->Q();      my $cgi = $self->Q();
655      # Get the feature data.      # Get the feature data.
656      my $record = $fq->Feature();      my $record = $fd->Feature();
657      my $extraCols = $fq->ExtraCols();      my $extraCols = $fd->ExtraCols();
658      # Check for a first-call situation.      # Check for a first-call situation.
659      if (! defined $self->{cols}) {      if (! defined $self->{cols}) {
660          # Here we need to set up the column information. Start with the defaults.          Trace("Setting up the columns.") if T(3);
661          $self->{cols} = $self->DefaultFeatureColumns();          # Here we need to set up the column information. Start with the extras,
662          # Add the externals if they were requested.          # sorted by column name.
663          if ($cgi->param('ShowAliases')) {          my @colNames = ();
             push @{$self->{cols}}, 'alias';  
         }  
         # Append the extras, sorted by column name.  
664          for my $col (sort keys %{$extraCols}) {          for my $col (sort keys %{$extraCols}) {
665              push @{$self->{cols}}, "X=$col";              push @colNames, "X=$col";
666          }          }
667            # Add the default columns.
668            push @colNames, $self->DefaultFeatureColumns();
669            # Add any additional columns requested by the feature filter.
670            push @colNames, FeatureQuery::AdditionalColumns($self);
671            # Save the full list.
672            $self->{cols} = \@colNames;
673          # Write out the column headers. This also prepares the cache file to receive          # Write out the column headers. This also prepares the cache file to receive
674          # output.          # output.
675          $self->WriteColumnHeaders(map { $self->FeatureColumnTitle($_) } @{$self->{cols}});          $self->WriteColumnHeaders(map { $self->FeatureColumnTitle($_) } @{$self->{cols}});
676      }      }
677      # Get the feature ID.      # Get the feature ID.
678      my ($fid) = $record->Value('Feature(id)');      my $fid = $fd->FID();
679      # Loop through the column headers, producing the desired data.      # Loop through the column headers, producing the desired data.
680      my @output = ();      my @output = ();
681      for my $colName (@{$self->{cols}}) {      for my $colName (@{$self->{cols}}) {
682          push @output, $self->FeatureColumnValue($colName, $record, $extraCols);          push @output, $self->FeatureColumnValue($colName, $record, $extraCols);
683      }      }
684      # 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
685      # top of the return list.      # top of the return list.
686      my $key = $self->SortKey($record);      my $key = $self->SortKey($fd);
687      # Write the feature data.      # Write the feature data.
688      $self->WriteColumnData($key, @output);      $self->WriteColumnData($key, @output);
689  }  }
# Line 756  Line 764 
764      # Check for an open session file.      # Check for an open session file.
765      if (defined $self->{fileHandle}) {      if (defined $self->{fileHandle}) {
766          # We found one, so close it.          # We found one, so close it.
767            Trace("Closing session file.") if T(2);
768          close $self->{fileHandle};          close $self->{fileHandle};
769      }      }
770  }  }
# Line 823  Line 832 
832                                                      ['Genome(genus)', 'Genome(species)',                                                      ['Genome(genus)', 'Genome(species)',
833                                                       'Genome(unique-characterization)',                                                       'Genome(unique-characterization)',
834                                                       'Genome(primary-group)']);                                                       'Genome(primary-group)']);
835          # Null out the supporting group.          # Format and cache the name and display group.
836          $group = "" if ($group eq $FIG_Config::otherGroup);          ($orgName, $group) = $self->SaveOrganismData($group, $genomeID, $genus, $species,
837          # 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];  
838      }      }
839      # Return the result.      # Return the result.
840      return ($orgName, $group);      return ($orgName, $group);
# Line 987  Line 985 
985      my ($self, $incomingType, $desiredType, $sequence) = @_;      my ($self, $incomingType, $desiredType, $sequence) = @_;
986      # Declare the return variable. If an error occurs, it will remain undefined.      # Declare the return variable. If an error occurs, it will remain undefined.
987      my $retVal;      my $retVal;
988        # This variable will be cleared if an error is detected.
989        my $okFlag = 1;
990      # Create variables to hold the FASTA label and data.      # Create variables to hold the FASTA label and data.
991      my ($fastaLabel, $fastaData);      my ($fastaLabel, $fastaData);
992        Trace("FASTA incoming type is $incomingType, desired type is $desiredType.") if T(4);
993      # Check for a feature specification.      # Check for a feature specification.
994      if ($sequence =~ /^\s*(\w+\|\S+)\s*$/) {      if ($sequence =~ /^\s*(\w+\|\S+)\s*$/) {
995          # 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
996          # it.          # it.
997          my $fid = $1;          my $fid = $1;
998            Trace("Feature ID for fasta is $fid.") if T(3);
999          my $sprout = $self->DB();          my $sprout = $self->DB();
1000          # 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
1001          # 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 1001  Line 1003 
1003          my ($figID) = $sprout->FeaturesByAlias($fid);          my ($figID) = $sprout->FeaturesByAlias($fid);
1004          if (! $figID) {          if (! $figID) {
1005              $self->SetMessage("No feature found with the ID \"$fid\".");              $self->SetMessage("No feature found with the ID \"$fid\".");
1006                $okFlag = 0;
1007          } else {          } else {
1008              # Set the FASTA label.              # Set the FASTA label.
1009              my $fastaLabel = $fid;              my $fastaLabel = $fid;
1010              # Now proceed according to the sequence type.              # Now proceed according to the sequence type.
1011              if ($desiredType =~ /prot/i) {              if ($desiredType eq 'prot') {
1012                  # We want protein, so get the translation.                  # We want protein, so get the translation.
1013                  $fastaData = $sprout->FeatureTranslation($figID);                  $fastaData = $sprout->FeatureTranslation($figID);
1014                    Trace(length $fastaData . " characters returned for translation of $fastaLabel.") if T(3);
1015              } else {              } else {
1016                  # 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.
1017                  my @locList = $sprout->FeatureLocation($figID);                  my @locList = $sprout->FeatureLocation($figID);
1018                  $fastaData = $sprout->DNASeq(\@locList);                  $fastaData = $sprout->DNASeq(\@locList);
1019                    Trace(length $fastaData . " characters returned for DNA of $fastaLabel.") if T(3);
1020              }              }
1021          }          }
1022      } elsif ($incomingType =~ /prot/ && $desiredType =~ /dna/) {      } elsif ($incomingType eq 'prot' && $desiredType eq 'dna') {
1023          # Here we're being asked to do an impossible conversion.          # Here we're being asked to do an impossible conversion.
1024          $self->SetMessage("Cannot convert a protein sequence to DNA.");          $self->SetMessage("Cannot convert a protein sequence to DNA.");
1025            $okFlag = 0;
1026      } else {      } else {
1027            Trace("Analyzing FASTA sequence.") if T(4);
1028          # 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.
1029          if ($sequence =~ /^>\s*(\S.*)\s*\n(.+)$/) {          if ($sequence =~ /^>[\n\s]*(\S[^\n]*)\n(.+)$/s) {
1030                Trace("Label \"$1\" found in match to sequence:\n$sequence") if T(4);
1031              # Here we have a label, so we split it from the data.              # Here we have a label, so we split it from the data.
1032              $fastaLabel = $1;              $fastaLabel = $1;
1033              $fastaData = $2;              $fastaData = $2;
1034          } else {          } else {
1035                Trace("No label found in match to sequence:\n$sequence") if T(4);
1036              # 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
1037              # as data.              # as data.
1038              $fastaLabel = "User-specified $incomingType sequence";              $fastaLabel = "User-specified $incomingType sequence";
# Line 1036  Line 1045 
1045          # we've already prevented a conversion from protein to DNA.          # we've already prevented a conversion from protein to DNA.
1046          if ($incomingType ne $desiredType) {          if ($incomingType ne $desiredType) {
1047              $fastaData = Sprout::Protein($fastaData);              $fastaData = Sprout::Protein($fastaData);
1048                # Check for bad characters.
1049                if ($fastaData =~ /X/) {
1050                    $self->SetMessage("Invalid characters detected. Is the input really of type $incomingType?");
1051                    $okFlag = 0;
1052                }
1053            } elsif ($desiredType eq 'dna' && $fastaData =~ /[^agct]/i) {
1054                $self->SetMessage("Invaid characters detected. Is the input really a DNA sequence?");
1055                $okFlag = 0;
1056          }          }
1057      }      }
1058      # At this point, either "$fastaLabel" and "$fastaData" have values or an error is      Trace("FASTA data sequence: $fastaData") if T(4);
1059      # in progress.      # Only proceed if no error was detected.
1060      if (defined $fastaLabel) {      if ($okFlag) {
1061          # 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
1062          # grep-split trick. The split, because of the presence of the parentheses,          # grep-split trick. The split, because of the presence of the parentheses,
1063          # includes the matched delimiters in the output list. The grep strips out          # includes the matched delimiters in the output list. The grep strips out
1064          # the empty list items that appear between the so-called delimiters, since          # the empty list items that appear between the so-called delimiters, since
1065          # the delimiters are what we want.          # the delimiters are what we want.
1066          my @chunks = grep { $_ } split /(.{1,60})/, $fastaData;          my @chunks = grep { $_ } split /(.{1,60})/, $fastaData;
1067          my $retVal = join("\n", ">$fastaLabel", @chunks, "");          $retVal = join("\n", ">$fastaLabel", @chunks, "");
1068      }      }
1069      # Return the result.      # Return the result.
1070      return $retVal;      return $retVal;
# Line 1082  Line 1099 
1099  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
1100  and 10 for a multi-select list.  and 10 for a multi-select list.
1101    
1102    =item crossMenu (optional)
1103    
1104    If specified, is presumed to be the name of another genome menu whose contents
1105    are to be mutually exclusive with the contents of this menu. As a result, instead
1106    of the standard onChange event, the onChange event will deselect any entries in
1107    the other menu.
1108    
1109  =item RETURN  =item RETURN
1110    
1111  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 1092  Line 1116 
1116    
1117  sub NmpdrGenomeMenu {  sub NmpdrGenomeMenu {
1118      # Get the parameters.      # Get the parameters.
1119      my ($self, $menuName, $multiple, $selected, $rows) = @_;      my ($self, $menuName, $multiple, $selected, $rows, $cross) = @_;
1120      # Get the Sprout and CGI objects.      # Get the Sprout and CGI objects.
1121      my $sprout = $self->DB();      my $sprout = $self->DB();
1122      my $cgi = $self->Q();      my $cgi = $self->Q();
# Line 1126  Line 1150 
1150          for my $genome (@genomeList) {          for my $genome (@genomeList) {
1151              # Get the genome data.              # Get the genome data.
1152              my ($group, $genomeID, $genus, $species, $strain) = @{$genome};              my ($group, $genomeID, $genus, $species, $strain) = @{$genome};
1153              # Form the genome name.              # Compute and cache its name and display group.
1154              my $name = "$genus $species";              my ($name, $displayGroup) = $self->SaveOrganismData($group, $genomeID, $genus, $species,
1155              if ($strain) {                                                                  $strain);
1156                  $name .= " $strain";              # Push the genome into the group's list. Note that we use the real group
1157              }              # name here, not the display group name.
             # Push the genome into the group's list.  
1158              push @{$gHash{$group}}, [$genomeID, $name];              push @{$gHash{$group}}, [$genomeID, $name];
1159          }          }
1160          # Save the genome list for future use.          # Save the genome list for future use.
# Line 1148  Line 1171 
1171      if (defined $selected) {      if (defined $selected) {
1172          %selectedHash = map { $_ => 1 } grep { defined($_) } @{$selected};          %selectedHash = map { $_ => 1 } grep { defined($_) } @{$selected};
1173      }      }
1174      # Now it gets complicated. We need a way to mark all the NMPDR genomes.      # Now it gets complicated. We need a way to mark all the NMPDR genomes. We take advantage
1175        # of the fact they come first in the list. We'll accumulate a count of the NMPDR genomes
1176        # and use that to make the selections.
1177        my $nmpdrCount = 0;
1178      # Create the type counters.      # Create the type counters.
1179      my $groupCount = 1;      my $groupCount = 1;
1180      # Compute the ID for the status display.      # Compute the ID for the status display.
# Line 1157  Line 1183 
1183      my $showSelect = "showSelected($menuName, '$divID', 1000);";      my $showSelect = "showSelected($menuName, '$divID', 1000);";
1184      # If multiple selection is supported, create an onChange event.      # If multiple selection is supported, create an onChange event.
1185      my $onChange = "";      my $onChange = "";
1186      if ($multiple) {      if ($cross) {
1187            # Here we have a paired menu. Selecting something in our menu unselects it in the
1188            # other and redisplays the status of both.
1189            $onChange = " onChange=\"crossUnSelect($menuName, '$divID', $cross, '${formName}_${cross}_status', 1000)\"";
1190        } elsif ($multiple) {
1191            # This is an unpaired menu, so all we do is redisplay our status.
1192          $onChange = " onChange=\"$showSelect\"";          $onChange = " onChange=\"$showSelect\"";
1193      }      }
1194      # Create the SELECT tag and stuff it into the output array.      # Create the SELECT tag and stuff it into the output array.
1195      my $select = "<SELECT name=\"$menuName\"$onChange$multipleTag size=\"$rows\">";      my @lines = ("<SELECT name=\"$menuName\"$onChange$multipleTag size=\"$rows\">");
     my @lines = ($select);  
1196      # Loop through the groups.      # Loop through the groups.
1197      for my $group (@groups) {      for my $group (@groups) {
1198          # Create the option group tag.          # Create the option group tag.
1199          my $tag = "<OPTGROUP label=\"$group\">";          my $tag = "<OPTGROUP label=\"$group\">";
1200          push @lines, "  $tag";          push @lines, "  $tag";
         # Compute the label for this group's options. This is seriously dirty stuff, as the  
         # label option may have functionality in future browsers. If that happens, we'll need  
         # to modify the genome text so that the "selectSome" method can tell which are NMPDR  
         # organisms and which aren't. Sadly, the OPTGROUP tag is invisible in the DOM Javascript  
         # hierarchy, so we can't use it.  
         my $label = ($group eq $FIG_Config::otherGroup ? "other" : "nmpdr");  
1201          # Get the genomes in the group.          # Get the genomes in the group.
1202          for my $genome (@{$groupHash->{$group}}) {          for my $genome (@{$groupHash->{$group}}) {
1203                # Count this organism if it's NMPDR.
1204                if ($group ne $FIG_Config::otherGroup) {
1205                    $nmpdrCount++;
1206                }
1207                # Get the organism ID and name.
1208              my ($genomeID, $name) = @{$genome};              my ($genomeID, $name) = @{$genome};
1209              # See if it's selected.              # See if it's selected.
1210              my $select = ($selectedHash{$genomeID} ? " selected" : "");              my $select = ($selectedHash{$genomeID} ? " selected" : "");
1211              # Generate the option tag.              # Generate the option tag.
1212              my $optionTag = "<OPTION value=\"$genomeID\" label=\"$label\"$select>$name <em>($genomeID)</em></OPTION>";              my $optionTag = "<OPTION value=\"$genomeID\"$select>$name <em>($genomeID)</em></OPTION>";
1213              push @lines, "    $optionTag";              push @lines, "    $optionTag";
1214          }          }
1215          # Close the option group.          # Close the option group.
# Line 1190  Line 1219 
1219      push @lines, "</SELECT>";      push @lines, "</SELECT>";
1220      # Check for multiple selection.      # Check for multiple selection.
1221      if ($multiple) {      if ($multiple) {
1222          # Since multi-select is on, we set up some buttons to set and clear selections.          # Multi-select is on, so we need to add some selection helpers. First is
1223          push @lines, "<br />";          # the search box. This allows the user to type text and have all genomes containing
         push @lines, "<INPUT type=\"button\" name=\"SelectAll\" class=\"bigButton\" value=\"Select All\" onClick=\"selectAll($menuName); $showSelect\" />";  
         push @lines, "<INPUT type=\"button\" name=\"ClearAll\" class=\"bigButton\"  value=\"Clear All\" onClick=\"clearAll($menuName); $showSelect\" />";  
         push @lines, "<INPUT type=\"button\" name=\"NMPDROnly\" class=\"bigButton\"  value=\"Select NMPDR\" onClick=\"selectSome($menuName, 'nmpdr'); $showSelect\" />";  
         push @lines, "<INPUT type=\"button\" name=\"OtherOnly\" class=\"bigButton\" value=\"Select Supporting\" onClick=\"selectSome($menuName, 'other'); $showSelect\" />";  
         # Now add the search box. This allows the user to type text and have all genomes containing  
1224          # the text selected automatically.          # the text selected automatically.
1225          my $searchThingName = "${menuName}_SearchThing";          my $searchThingName = "${menuName}_SearchThing";
1226          push @lines, "<br>Select genomes containing <INPUT type=\"text\" name=\"$searchThingName\" size=\"30\" />&nbsp;" .          push @lines, "<br>Select genomes containing <INPUT type=\"text\" name=\"$searchThingName\" " .
1227                       "<INPUT type=\"button\" name=\"Select\" class=\"button\" value=\"Search\" onClick=\"selectViaSearch($menuName, $searchThingName); $showSelect\" />";                       "size=\"30\" onBlur=\"selectViaSearch($menuName, $searchThingName); $showSelect\" />";
1228            # Next are the buttons to set and clear selections.
1229            push @lines, "<br />";
1230            push @lines, "<INPUT type=\"button\" name=\"ClearAll\" class=\"bigButton\"  value=\"Clear All\" onClick=\"clearAll($menuName); $showSelect\" />";
1231            push @lines, "<INPUT type=\"button\" name=\"SelectAll\" class=\"bigButton\" value=\"Select All\" onClick=\"selectAll($menuName); $showSelect\" />";
1232            push @lines, "<INPUT type=\"button\" name=\"NMPDROnly\" class=\"bigButton\"  value=\"Select NMPDR\" onClick=\"selectSome($menuName, $nmpdrCount, true); $showSelect\" />";
1233            push @lines, "<INPUT type=\"button\" name=\"OtherOnly\" class=\"bigButton\" value=\"Select Supporting\" onClick=\"selectSome($menuName, $nmpdrCount, false); $showSelect\" />";
1234          # Add the status display, too.          # Add the status display, too.
1235          push @lines, "<DIV id=\"$divID\" class=\"selectStatus\"></DIV>";          push @lines, "<DIV id=\"$divID\" class=\"selectStatus\"></DIV>";
1236          # Queue to update the status display when the form loads. We need to modify the show statement          # Queue to update the status display when the form loads. We need to modify the show statement
# Line 1354  Line 1384 
1384    
1385  C<< my $htmlText = $shelp->FeatureFilterRows(); >>  C<< my $htmlText = $shelp->FeatureFilterRows(); >>
1386    
1387  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
1388  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>
1389  using the B<FeatureQuery> object.  object.
1390    
1391  =cut  =cut
1392    
# Line 1573  Line 1603 
1603          # a singleton list, but that's okay.          # a singleton list, but that's okay.
1604          my @values = split (/\0/, $parms{$parmKey});          my @values = split (/\0/, $parms{$parmKey});
1605          # Check for special cases.          # Check for special cases.
1606          if ($parmKey eq 'featureTypes') {          if (grep { $_ eq $parmKey } qw(SessionID ResultCount Page PageSize Trace TF ShowURL)) {
             # Here we need to see if the user wants all the feature types. If he  
             # does, we erase all the values so that the parameter is not output.  
             my %valueCheck = map { $_ => 1 } @values;  
             my @list = FeatureQuery::AllFeatureTypes();  
             my $okFlag = 1;  
             for (my $i = 0; $okFlag && $i <= $#list; $i++) {  
                 if (! $valueCheck{$list[$i]}) {  
                     $okFlag = 0;  
                 }  
             }  
             if ($okFlag) {  
                 @values = ();  
             }  
         } elsif (grep { $_ eq $parmKey } qw(SessionID ResultCount Page PageSize Trace TF ShowURL)) {  
1607              # These are bookkeeping parameters we don't need to start a search.              # These are bookkeeping parameters we don't need to start a search.
1608              @values = ();              @values = ();
1609          } elsif ($parmKey =~ /_SearchThing$/) {          } elsif ($parmKey =~ /_SearchThing$/) {
# Line 1649  Line 1665 
1665      return $retVal;      return $retVal;
1666  }  }
1667    
1668    =head3 AdvancedClassList
1669    
1670    C<< my @classes = SearchHelper::AdvancedClassList(); >>
1671    
1672    Return a list of advanced class names. This list is used to generate the directory
1673    of available searches on the search page.
1674    
1675    We use the %INC variable to accomplish this.
1676    
1677    =cut
1678    
1679    sub AdvancedClassList {
1680        my @retVal = map { $_ =~ /^SH(\w+)\.pm/; $1 } grep { $_ =~ /^SH/ } keys %INC;
1681        return @retVal;
1682    }
1683    
1684  =head2 Feature Column Methods  =head2 Feature Column Methods
1685    
1686  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 1669  Line 1701 
1701    
1702  =head3 DefaultFeatureColumns  =head3 DefaultFeatureColumns
1703    
1704  C<< my $colNames = $shelp->DefaultFeatureColumns(); >>  C<< my @colNames = $shelp->DefaultFeatureColumns(); >>
1705    
1706  Return a reference to a list of the default feature column identifiers. These  Return a list of the default feature column identifiers. These identifiers can
1707  identifiers can be passed to L</FeatureColumnTitle> and L</FeatureColumnValue> in  be passed to L</FeatureColumnTitle> and L</FeatureColumnValue> in order to
1708  order to produce the column titles and row values.  produce the column titles and row values.
1709    
1710  =cut  =cut
1711    
# Line 1681  Line 1713 
1713      # Get the parameters.      # Get the parameters.
1714      my ($self) = @_;      my ($self) = @_;
1715      # Return the result.      # Return the result.
1716      return ['orgName', 'function', 'gblink', 'protlink',      return qw(orgName function gblink protlink);
             FeatureQuery::AdditionalColumns($self)];  
1717  }  }
1718    
1719  =head3 FeatureColumnTitle  =head3 FeatureColumnTitle
# Line 1714  Line 1745 
1745      if ($colName =~ /^X=(.+)$/) {      if ($colName =~ /^X=(.+)$/) {
1746          # Here we have an extra column.          # Here we have an extra column.
1747          $retVal = $1;          $retVal = $1;
     } elsif ($colName eq 'orgName') {  
         $retVal = "Name";  
     } elsif ($colName eq 'fid') {  
         $retVal = "FIG ID";  
1748      } elsif ($colName eq 'alias') {      } elsif ($colName eq 'alias') {
1749          $retVal = "External Aliases";          $retVal = "External Aliases";
1750        } elsif ($colName eq 'fid') {
1751            $retVal = "FIG ID";
1752      } elsif ($colName eq 'function') {      } elsif ($colName eq 'function') {
1753          $retVal = "Functional Assignment";          $retVal = "Functional Assignment";
1754      } elsif ($colName eq 'gblink') {      } elsif ($colName eq 'gblink') {
1755          $retVal = "GBrowse";          $retVal = "GBrowse";
     } elsif ($colName eq 'protlink') {  
         $retVal = "NMPDR Protein Page";  
1756      } elsif ($colName eq 'group') {      } elsif ($colName eq 'group') {
1757          $retVal = "NMDPR Group";          $retVal = "NMDPR Group";
1758        } elsif ($colName =~ /^keyword:(.+)$/) {
1759            $retVal = ucfirst $1;
1760        } elsif ($colName eq 'orgName') {
1761            $retVal = "Feature Name";
1762        } elsif ($colName eq 'protlink') {
1763            $retVal = "NMPDR Protein Page";
1764        } elsif ($colName eq 'subsystem') {
1765            $retVal = "Subsystems";
1766      }      }
1767      # Return the result.      # Return the result.
1768      return $retVal;      return $retVal;
1769  }  }
1770    
1771    
1772  =head3 FeatureColumnValue  =head3 FeatureColumnValue
1773    
1774  C<< my $value = $shelp->FeatureColumnValue($colName, $fid, \%extraCols); >>  C<< my $value = $shelp->FeatureColumnValue($colName, $fid, \%extraCols); >>
# Line 1783  Line 1819 
1819          if (defined $extraCols->{$1}) {          if (defined $extraCols->{$1}) {
1820              $retVal = $extraCols->{$1};              $retVal = $extraCols->{$1};
1821          }          }
     } elsif ($colName eq 'orgName') {  
         # Here we want the formatted organism name and feature number.  
         $retVal = $self->FeatureName($fid);  
     } elsif ($colName eq 'fid') {  
         # Here we have the raw feature ID. We hyperlink it to the protein page.  
         $retVal = HTML::set_prot_links($fid);  
1822      } elsif ($colName eq 'alias') {      } elsif ($colName eq 'alias') {
1823          # In this case, the user wants a list of external aliases for the feature.          # In this case, the user wants a list of external aliases for the feature.
1824          # These are very expensive, so we compute them when the row is displayed.          # These are very expensive, so we compute them when the row is displayed.
1825          $retVal = "%%aliases=$fid";          $retVal = "%%alias=$fid";
1826        } elsif ($colName eq 'fid') {
1827            # Here we have the raw feature ID. We hyperlink it to the protein page.
1828            $retVal = HTML::set_prot_links($fid);
1829      } elsif ($colName eq 'function') {      } elsif ($colName eq 'function') {
1830          # The functional assignment is just a matter of getting some text.          # The functional assignment is just a matter of getting some text.
1831          ($retVal) = $record->Value('Feature(assignment)');          ($retVal) = $record->Value('Feature(assignment)');
# Line 1803  Line 1836 
1836                            $cgi->img({ src => "../images/button-gbrowse.png",                            $cgi->img({ src => "../images/button-gbrowse.png",
1837                                        border => 0 })                                        border => 0 })
1838                           );                           );
     } elsif ($colName eq 'protlink') {  
         # Here we want a link to the protein page using the official NMPDR button.  
         my $hurl = HTML::fid_link($cgi, $fid, 0, 1);  
         $retVal = $cgi->a({ href => $hurl, title => "Protein page for $fid" },  
                           $cgi->img({ src => "../images/button-nmpdr.png",  
                                      border => 0 })  
                          );  
1839      } elsif ($colName eq 'group') {      } elsif ($colName eq 'group') {
1840          # Get the NMPDR group name.          # Get the NMPDR group name.
1841          my (undef, $group) = $self->OrganismData($fid);          my (undef, $group) = $self->OrganismData($fid);
# Line 1817  Line 1843 
1843          my $nurl = $sprout->GroupPageName($group);          my $nurl = $sprout->GroupPageName($group);
1844          $retVal = $cgi->a({ href => $nurl, title => "$group summary" },          $retVal = $cgi->a({ href => $nurl, title => "$group summary" },
1845                            $group);                            $group);
1846        } elsif ($colName =~ /^keyword:(.+)$/) {
1847            # Here we want keyword-related values. This is also expensive, so
1848            # we compute them when the row is displayed.
1849            $retVal = "%%$colName=$fid";
1850        } elsif ($colName eq 'orgName') {
1851            # Here we want the formatted organism name and feature number.
1852            $retVal = $self->FeatureName($fid);
1853        } elsif ($colName eq 'protlink') {
1854            # Here we want a link to the protein page using the official NMPDR button.
1855            my $hurl = HTML::fid_link($cgi, $fid, 0, 1);
1856            $retVal = $cgi->a({ href => $hurl, title => "Protein page for $fid" },
1857                              $cgi->img({ src => "../images/button-nmpdr.png",
1858                                         border => 0 })
1859                             );
1860        }elsif ($colName eq 'subsystem') {
1861            # Another run-time column: subsystem list.
1862            $retVal = "%%subsystem=$fid";
1863      }      }
1864      # Return the result.      # Return the result.
1865      return $retVal;      return $retVal;
# Line 1855  Line 1898 
1898      # Get the Sprout and CGI objects.      # Get the Sprout and CGI objects.
1899      my $sprout = $self->DB();      my $sprout = $self->DB();
1900      my $cgi = $self->Q();      my $cgi = $self->Q();
1901        Trace("Runtime column $type with text \"$text\" found.") if T(4);
1902      # Separate the text into a type and data.      # Separate the text into a type and data.
1903      if ($type eq 'aliases') {      if ($type eq 'alias') {
1904          # Here the caller wants external alias links for a feature. The text          # Here the caller wants external alias links for a feature. The text
1905          # is the feature ID.          # is the feature ID.
1906          my $fid = $text;          my $fid = $text;
# Line 1871  Line 1915 
1915              # Ask the HTML processor to hyperlink them.              # Ask the HTML processor to hyperlink them.
1916              $retVal = HTML::set_prot_links($cgi, $aliasList);              $retVal = HTML::set_prot_links($cgi, $aliasList);
1917          }          }
1918        } elsif ($type eq 'subsystem') {
1919            # Here the caller wants the subsystems in which this feature participates.
1920            # The text is the feature ID. We will list the subsystem names with links
1921            # to the subsystem's summary page.
1922            my $fid = $text;
1923            # Get the subsystems.
1924            Trace("Generating subsystems for feature $fid.") if T(4);
1925            my %subs = $sprout->SubsystemsOf($fid);
1926            # Convert them to links.
1927            my @links = map { HTML::sub_link($cgi, $_) } sort keys %subs;
1928            # String them into a list.
1929            $retVal = join(", ", @links);
1930        } elsif ($type =~ /^keyword:(.+)$/) {
1931            # Here the caller wants the value of the named keyword. The text is the
1932            # feature ID.
1933            my $keywordName = $1;
1934            my $fid = $text;
1935            # Get the attribute values.
1936            Trace("Getting $keywordName values for feature $fid.") if T(4);
1937            my @values = $sprout->GetFlat(['Feature'], "Feature(id) = ?", [$fid],
1938                                          "Feature($keywordName)");
1939            # String them into a list.
1940            $retVal = join(", ", @values);
1941      }      }
1942      # Return the result.      # Return the result.
1943      return $retVal;      return $retVal;
1944  }  }
1945    
1946    =head3 SaveOrganismData
1947    
1948    C<< my ($name, $displayGroup) = $shelp->SaveOrganismData($group, $genomeID, $genus, $species, $strain); >>
1949    
1950    Format the name of an organism and the display version of its group name. The incoming
1951    data should be the relevant fields from the B<Genome> record in the database. The
1952    data will also be stored in the genome cache for later use in posting search results.
1953    
1954    =over 4
1955    
1956    =item group
1957    
1958    Name of the genome's group as it appears in the database.
1959    
1960    =item genomeID
1961    
1962    ID of the relevant genome.
1963    
1964    =item genus
1965    
1966    Genus of the genome's organism. If undefined or null, it will be assumed the genome is not
1967    in the database. In this case, the organism name is derived from the genomeID and the group
1968    is automatically the supporting-genomes group.
1969    
1970    =item species
1971    
1972    Species of the genome's organism.
1973    
1974    =item strain
1975    
1976    Strain of the species represented by the genome.
1977    
1978    =item RETURN
1979    
1980    Returns a two-element list. The first element is the formatted genome name. The second
1981    element is the display name of the genome's group.
1982    
1983    =back
1984    
1985    =cut
1986    
1987    sub SaveOrganismData {
1988        # Get the parameters.
1989        my ($self, $group, $genomeID, $genus, $species, $strain) = @_;
1990        # Declare the return values.
1991        my ($name, $displayGroup);
1992        # If the organism does not exist, format an unknown name and a blank group.
1993        if (! defined($genus)) {
1994            $name = "Unknown Genome $genomeID";
1995            $displayGroup = "";
1996        } else {
1997            # It does exist, so format the organism name.
1998            $name = "$genus $species";
1999            if ($strain) {
2000                $name .= " $strain";
2001            }
2002            # Compute the display group. This is currently the same as the incoming group
2003            # name unless it's the supporting group, which is nulled out.
2004            $displayGroup = ($group eq $FIG_Config::otherGroup ? "" : $group);
2005        }
2006        # Cache the group and organism data.
2007        my $cache = $self->{orgs};
2008        $cache->{$genomeID} = [$name, $displayGroup];
2009        # Return the result.
2010        return ($name, $displayGroup);
2011    }
2012    
2013  =head2 Virtual Methods  =head2 Virtual Methods
2014    
2015  =head3 Form  =head3 Form
# Line 1903  Line 2037 
2037    
2038  =head3 SortKey  =head3 SortKey
2039    
2040  C<< my $key = $shelp->SortKey($record); >>  C<< my $key = $shelp->SortKey($fdata); >>
2041    
2042  Return the sort key for the specified record. The default is to sort by feature name,  Return the sort key for the specified feature data. The default is to sort by feature name,
2043  floating NMPDR organisms to the top. This sort may be overridden by the search class  floating NMPDR organisms to the top. If a full-text search is used, then the default
2044  to provide fancier functionality. This method is called by B<PutFeature>, so it  sort is by relevance followed by feature name. This sort may be overridden by the
2045  is only used for feature searches. A non-feature search would presumably have its  search class to provide fancier functionality. This method is called by
2046  own sort logic.  B<PutFeature>, so it is only used for feature searches. A non-feature search
2047    would presumably have its own sort logic.
2048    
2049  =over 4  =over 4
2050    
2051  =item record  =item record
2052    
2053  The C<DBObject> from which the current row of data is derived.  The C<FeatureData> containing the current feature.
2054    
2055  =item RETURN  =item RETURN
2056    
# Line 1927  Line 2062 
2062    
2063  sub SortKey {  sub SortKey {
2064      # Get the parameters.      # Get the parameters.
2065      my ($self, $record) = @_;      my ($self, $fdata) = @_;
2066      # Get the feature ID from the record.      # Get the feature ID from the record.
2067      my ($fid) = $record->Value('Feature(id)');      my $fid = $fdata->FID();
2068      # Get the group from the feature ID.      # Get the group from the feature ID.
2069      my $group = $self->FeatureGroup($fid);      my $group = $self->FeatureGroup($fid);
2070      # Ask the feature query object to form the sort key.      # Ask the feature query object to form the sort key.
2071      my $retVal = FeatureQuery::SortKey($self, $group, $record);      my $retVal = $fdata->SortKey($self, $group);
2072      # Return the result.      # Return the result.
2073      return $retVal;      return $retVal;
2074  }  }
2075    
2076  1;  1;

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3