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

Diff of /Sprout/Sprout.pm

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

revision 1.2, Sun Jan 23 22:31:29 2005 UTC revision 1.46, Thu Oct 20 11:52:36 2005 UTC
# Line 11  Line 11 
11          use Tracer;          use Tracer;
12          use FIGRules;          use FIGRules;
13          use Stats;          use Stats;
14        use POSIX qw(strftime);
15    
16    
17  =head1 Sprout Database Manipulation Object  =head1 Sprout Database Manipulation Object
# Line 33  Line 34 
34    
35  =cut  =cut
36    
37  #  #: Constructor SFXlate->new_sprout_only();
38    
39  =head2 Public Methods  =head2 Public Methods
40    
# Line 69  Line 70 
70    
71  * B<maxSequenceLength> maximum number of residues per sequence, (default C<8000>)  * B<maxSequenceLength> maximum number of residues per sequence, (default C<8000>)
72    
73    * B<noDBOpen> suppresses the connection to the database if TRUE, else FALSE
74    
75  =back  =back
76    
77  For example, the following constructor call specifies a database named I<Sprout> and a user name of  For example, the following constructor call specifies a database named I<Sprout> and a user name of
# Line 85  Line 88 
88          # Compute the options. We do this by starting with a table of defaults and overwriting with          # Compute the options. We do this by starting with a table of defaults and overwriting with
89          # the incoming data.          # the incoming data.
90          my $optionTable = Tracer::GetOptions({          my $optionTable = Tracer::GetOptions({
91                                             dbType               => 'mysql',                     # database type                         dbType       => $FIG_Config::dbms,
92                                             dataDir              => 'Data',                      # data file directory                                                          # database type
93                                             xmlFileName  => 'SproutDBD.xml', # database definition file name                         dataDir      => $FIG_Config::sproutData,
94                                             userData             => 'root/',                     # user name and password                                                          # data file directory
95                                             port                 => 0,                           # database connection port                         xmlFileName  => "$FIG_Config::sproutData/SproutDBD.xml",
96                                                            # database definition file name
97                           userData     => "$FIG_Config::dbuser/$FIG_Config::dbpass",
98                                                            # user name and password
99                           port         => $FIG_Config::dbport,
100                                                            # database connection port
101                                             maxSegmentLength => 4500,            # maximum feature segment length                                             maxSegmentLength => 4500,            # maximum feature segment length
102                                             maxSequenceLength => 8000,           # maximum contig sequence length                                             maxSequenceLength => 8000,           # maximum contig sequence length
103                           noDBOpen     => 0,               # 1 to suppress the database open
104                                            }, $options);                                            }, $options);
105          # Get the data directory.          # Get the data directory.
106          my $dataDir = $optionTable->{dataDir};          my $dataDir = $optionTable->{dataDir};
# Line 99  Line 108 
108          $optionTable->{userData} =~ m!([^/]*)/(.*)$!;          $optionTable->{userData} =~ m!([^/]*)/(.*)$!;
109          my ($userName, $password) = ($1, $2);          my ($userName, $password) = ($1, $2);
110          # Connect to the database.          # Connect to the database.
111          my $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName, $password, $optionTable->{port});      my $dbh;
112        if (! $optionTable->{noDBOpen}) {
113            $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName,
114                                    $password, $optionTable->{port});
115        }
116          # Create the ERDB object.          # Create the ERDB object.
117          my $xmlFileName = "$optionTable->{xmlFileName}";          my $xmlFileName = "$optionTable->{xmlFileName}";
118          my $erdb = ERDB->new($dbh, $xmlFileName);          my $erdb = ERDB->new($dbh, $xmlFileName);
# Line 121  Line 134 
134  and 10999.  and 10999.
135    
136  =cut  =cut
137    #: Return Type $;
138  sub MaxSegment {  sub MaxSegment {
139          my $self = shift @_;      my ($self) = @_;
140          return $self->{_options}->{maxSegmentLength};          return $self->{_options}->{maxSegmentLength};
141  }  }
142    
# Line 136  Line 149 
149  we generally only need a few sequences in memory rather than the entire contig.  we generally only need a few sequences in memory rather than the entire contig.
150    
151  =cut  =cut
152    #: Return Type $;
153  sub MaxSequence {  sub MaxSequence {
154          my $self = shift @_;      my ($self) = @_;
155          return $self->{_options}->{maxSequenceLength};          return $self->{_options}->{maxSequenceLength};
156  }  }
157    
# Line 231  Line 244 
244    
245  sub Get {  sub Get {
246          # Get the parameters.          # Get the parameters.
247          my $self = shift @_;      my ($self, $objectNames, $filterClause, $parameterList) = @_;
         my ($objectNames, $filterClause, $parameterList) = @_;  
248          # We differ from the ERDB Get method in that the parameter list is passed in as a list reference          # We differ from the ERDB Get method in that the parameter list is passed in as a list reference
249          # rather than a list of parameters. The next step is to convert the parameters from a reference          # rather than a list of parameters. The next step is to convert the parameters from a reference
250          # to a real list. We can only do this if the parameters have been specified.          # to a real list. We can only do this if the parameters have been specified.
# Line 268  Line 280 
280    
281  sub GetEntity {  sub GetEntity {
282          # Get the parameters.          # Get the parameters.
283          my $self = shift @_;      my ($self, $entityType, $ID) = @_;
284          my ($entityType, $ID) = @_;      # Call the ERDB method.
285          # Create a query.      return $self->{_erdb}->GetEntity($entityType, $ID);
         my $query = $self->Get([$entityType], "$entityType(id) = ?", [$ID]);  
         # Get the first (and only) object.  
         my $retVal = $query->Fetch();  
         # Return the result.  
         return $retVal;  
286  }  }
287    
288  =head3 GetEntityValues  =head3 GetEntityValues
# Line 305  Line 312 
312  =back  =back
313    
314  =cut  =cut
315    #: Return Type @;
316  sub GetEntityValues {  sub GetEntityValues {
317          # Get the parameters.          # Get the parameters.
318          my $self = shift @_;      my ($self, $entityType, $ID, $fields) = @_;
319          my ($entityType, $ID, $fields) = @_;      # Call the ERDB method.
320          # Get the specified entity.      return $self->{_erdb}->GetEntityValues($entityType, $ID, $fields);
         my $entity = $self->GetEntity($entityType, $ID);  
         # Declare the return list.  
         my @retVal = ();  
         # If we found the entity, push the values into the return list.  
         if ($entity) {  
                 push @retVal, $entity->Values($fields);  
         }  
         # Return the result.  
         return @retVal;  
321  }  }
322    
323  =head3 ShowMetaData  =head3 ShowMetaData
# Line 340  Line 338 
338    
339  sub ShowMetaData {  sub ShowMetaData {
340          # Get the parameters.          # Get the parameters.
341          my $self = shift @_;      my ($self, $fileName) = @_;
         my ($fileName) = @_;  
342          # Compute the file name.          # Compute the file name.
343          my $options = $self->{_options};          my $options = $self->{_options};
344          # Call the show method on the underlying ERDB object.          # Call the show method on the underlying ERDB object.
# Line 378  Line 375 
375  =back  =back
376    
377  =cut  =cut
378    #: Return Type %;
379  sub Load {  sub Load {
380          # Get the parameters.          # Get the parameters.
381          my $self = shift @_;      my ($self, $rebuild) = @_;
         my ($rebuild) = @_;  
382          # Get the database object.          # Get the database object.
383          my $erdb = $self->{_erdb};          my $erdb = $self->{_erdb};
384          # Load the tables from the data directory.          # Load the tables from the data directory.
# Line 393  Line 389 
389    
390  =head3 LoadUpdate  =head3 LoadUpdate
391    
392  C<< my %stats = $sprout->LoadUpdate($truncateFlag, \@tableList); >>  C<< my $stats = $sprout->LoadUpdate($truncateFlag, \@tableList); >>
393    
394  Load updates to one or more database tables. This method enables the client to make changes to one  Load updates to one or more database tables. This method enables the client to make changes to one
395  or two tables without reloading the whole database. For each table, there must be a corresponding  or two tables without reloading the whole database. For each table, there must be a corresponding
# Line 422  Line 418 
418  =back  =back
419    
420  =cut  =cut
421    #: Return Type $%;
422  sub LoadUpdate {  sub LoadUpdate {
423          # Get the parameters.          # Get the parameters.
424          my $self = shift @_;      my ($self, $truncateFlag, $tableList) = @_;
         my ($truncateFlag, $tableList) = @_;  
425          # Get the database object.          # Get the database object.
426          my $erdb = $self->{_erdb};          my $erdb = $self->{_erdb};
427          # Declare the return value.          # Declare the return value.
# Line 437  Line 432 
432          # Loop through the incoming table names.          # Loop through the incoming table names.
433          for my $tableName (@{$tableList}) {          for my $tableName (@{$tableList}) {
434                  # Find the table's file.                  # Find the table's file.
435                  my $fileName = "$dataDir/$tableName";          my $fileName = LoadFileName($dataDir, $tableName);
436                  if (! -e $fileName) {          if (! $fileName) {
437                          $fileName = "$fileName.dtx";              Trace("No load file found for $tableName in $dataDir.") if T(0);
438                  }          } else {
439                  # Attempt to load this table.                  # Attempt to load this table.
440                  my $result = $erdb->LoadTable($fileName, $tableName, $truncateFlag);                  my $result = $erdb->LoadTable($fileName, $tableName, $truncateFlag);
441                  # Accumulate the resulting statistics.                  # Accumulate the resulting statistics.
442                  $retVal->Accumulate($result);                  $retVal->Accumulate($result);
443          }          }
444        }
445          # Return the statistics.          # Return the statistics.
446          return $retVal;          return $retVal;
447  }  }
# Line 459  Line 455 
455  changed.  changed.
456    
457  =cut  =cut
458    #: Return Type ;
459  sub Build {  sub Build {
460          # Get the parameters.          # Get the parameters.
461          my $self = shift @_;      my ($self) = @_;
462          # Create the tables.          # Create the tables.
463          $self->{_erdb}->CreateTables;          $self->{_erdb}->CreateTables;
464  }  }
# Line 474  Line 470 
470  Return a list of all the genome IDs.  Return a list of all the genome IDs.
471    
472  =cut  =cut
473    #: Return Type @;
474  sub Genomes {  sub Genomes {
475          # Get the parameters.          # Get the parameters.
476          my $self = shift @_;      my ($self) = @_;
477          # Get all the genomes.          # Get all the genomes.
478          my @retVal = $self->GetFlat(['Genome'], "", [], 'Genome(id)');          my @retVal = $self->GetFlat(['Genome'], "", [], 'Genome(id)');
479          # Return the list of IDs.          # Return the list of IDs.
# Line 504  Line 500 
500  =back  =back
501    
502  =cut  =cut
503    #: Return Type $;
504  sub GenusSpecies {  sub GenusSpecies {
505          # Get the parameters.          # Get the parameters.
506          my $self = shift @_;      my ($self, $genomeID) = @_;
         my ($genomeID) = @_;  
507          # Get the data for the specified genome.          # Get the data for the specified genome.
508          my @values = $self->GetEntityValues('Genome', $genomeID, ['Genome(genus)', 'Genome(species)',          my @values = $self->GetEntityValues('Genome', $genomeID, ['Genome(genus)', 'Genome(species)',
509                                                                                                                            'Genome(unique-characterization)']);                                                                                                                            'Genome(unique-characterization)']);
# Line 541  Line 536 
536  =back  =back
537    
538  =cut  =cut
539    #: Return Type @;
540  sub FeaturesOf {  sub FeaturesOf {
541          # Get the parameters.          # Get the parameters.
542          my $self = shift @_;      my ($self, $genomeID,$ftype) = @_;
         my ($genomeID,$ftype) = @_;  
543          # Get the features we want.          # Get the features we want.
544          my @features;          my @features;
545          if (!$ftype) {          if (!$ftype) {
# Line 589  Line 583 
583  =item RETURN  =item RETURN
584    
585  Returns a list of the feature's contig segments. The locations are returned as a list in a list  Returns a list of the feature's contig segments. The locations are returned as a list in a list
586  context and as a space-delimited string in a scalar context.  context and as a comma-delimited string in a scalar context.
587    
588  =back  =back
589    
590  =cut  =cut
591    #: Return Type @;
592    #: Return Type $;
593  sub FeatureLocation {  sub FeatureLocation {
594          # Get the parameters.          # Get the parameters.
595          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
596          # Create a query for the feature locations.          # Create a query for the feature locations.
597          my $query = $self->Get(['IsLocatedIn'], "IsLocatedIn(from-link) = ? ORDER BY IsLocatedIn(locN)",          my $query = $self->Get(['IsLocatedIn'], "IsLocatedIn(from-link) = ? ORDER BY IsLocatedIn(locN)",
598                                                     [$featureID]);                                                     [$featureID]);
# Line 616  Line 610 
610                  if ($prevContig eq $contigID && $dir eq $prevDir) {                  if ($prevContig eq $contigID && $dir eq $prevDir) {
611                          # Here the new segment is in the same direction on the same contig. Insure the                          # Here the new segment is in the same direction on the same contig. Insure the
612                          # new segment's beginning is next to the old segment's end.                          # new segment's beginning is next to the old segment's end.
613                          if (($dir eq "-" && $beg == $prevBeg - $prevLen) ||              if ($dir eq "-" && $beg + $len == $prevBeg) {
614                                  ($dir eq "+" && $beg == $prevBeg + $prevLen)) {                  # Here we're merging two backward blocks, so we keep the new begin point
615                                  # Here we need to merge two segments. Adjust the beginning and length values                  # and adjust the length.
616                                  # to include both segments.                  $len += $prevLen;
617                    # Pop the old segment off. The new one will replace it later.
618                    pop @retVal;
619                } elsif ($dir eq "+" && $beg == $prevBeg + $prevLen) {
620                    # Here we need to merge two forward blocks. Adjust the beginning and
621                    # length values to include both segments.
622                                  $beg = $prevBeg;                                  $beg = $prevBeg;
623                                  $len += $prevLen;                                  $len += $prevLen;
624                                  # Pop the old segment off. The new one will replace it later.                                  # Pop the old segment off. The new one will replace it later.
# Line 628  Line 627 
627                  }                  }
628                  # Remember this specifier for the adjacent-segment test the next time through.                  # Remember this specifier for the adjacent-segment test the next time through.
629                  ($prevContig, $prevBeg, $prevDir, $prevLen) = ($contigID, $beg, $dir, $len);                  ($prevContig, $prevBeg, $prevDir, $prevLen) = ($contigID, $beg, $dir, $len);
630            # Compute the initial base pair.
631            my $start = ($dir eq "+" ? $beg : $beg + $len - 1);
632                  # Add the specifier to the list.                  # Add the specifier to the list.
633                  push @retVal, "${contigID}_$beg$dir$len";          push @retVal, "${contigID}_$start$dir$len";
634          }          }
635          # Return the list in the format indicated by the context.          # Return the list in the format indicated by the context.
636          return (wantarray ? @retVal : join(' ', @retVal));      return (wantarray ? @retVal : join(',', @retVal));
637  }  }
638    
639  =head3 ParseLocation  =head3 ParseLocation
# Line 656  Line 657 
657  =back  =back
658    
659  =cut  =cut
660    #: Return Type @;
661  sub ParseLocation {  sub ParseLocation {
662          # Get the parameter.      # Get the parameter. Note that if we're called as an instance method, we ignore
663        # the first parameter.
664        shift if UNIVERSAL::isa($_[0],__PACKAGE__);
665          my ($location) = @_;          my ($location) = @_;
666          # Parse it into segments.          # Parse it into segments.
667          $location =~ /^(.*)_(\d*)([+-_])(\d*)$/;      $location =~ /^(.+)_(\d+)([+\-_])(\d+)$/;
668          my ($contigID, $start, $dir, $len) = ($1, $2, $3, $4);          my ($contigID, $start, $dir, $len) = ($1, $2, $3, $4);
669          # If the direction is an underscore, convert it to a + or -.          # If the direction is an underscore, convert it to a + or -.
670          if ($dir eq "_") {          if ($dir eq "_") {
# Line 677  Line 680 
680          return ($contigID, $start, $dir, $len);          return ($contigID, $start, $dir, $len);
681  }  }
682    
683    =head3 PointLocation
684    
685    C<< my $found = Sprout::PointLocation($location, $point); >>
686    
687    Return the offset into the specified location of the specified point on the contig. If
688    the specified point is before the location, a negative value will be returned. If it is
689    beyond the location, an undefined value will be returned. It is assumed that the offset
690    is for the location's contig. The location can either be new-style (using a C<+> or C<->
691    and a length) or old-style (using C<_> and start and end positions.
692    
693    =over 4
694    
695    =item location
696    
697    A location specifier (see L</FeatureLocation> for a description).
698    
699    =item point
700    
701    The offset into the contig of the point in which we're interested.
702    
703    =item RETURN
704    
705    Returns the offset inside the specified location of the specified point, a negative
706    number if the point is before the location, or an undefined value if the point is past
707    the location. If the length of the location is 0, this method will B<always> denote
708    that it is outside the location. The offset will always be relative to the left-most
709    position in the location.
710    
711    =back
712    
713    =cut
714    #: Return Type $;
715    sub PointLocation {
716        # Get the parameter. Note that if we're called as an instance method, we ignore
717        # the first parameter.
718        shift if UNIVERSAL::isa($_[0],__PACKAGE__);
719        my ($location, $point) = @_;
720        # Parse out the location elements. Note that this works on both old-style and new-style
721        # locations.
722        my ($contigID, $start, $dir, $len) = ParseLocation($location);
723        # Declare the return variable.
724        my $retVal;
725        # Compute the offset. The computation is dependent on the direction of the location.
726        my $offset = (($dir == '+') ? $point - $start : $point - ($start - $len + 1));
727        # Return the offset if it's valid.
728        if ($offset < $len) {
729            $retVal = $offset;
730        }
731        # Return the offset found.
732        return $retVal;
733    }
734    
735  =head3 DNASeq  =head3 DNASeq
736    
737  C<< my $sequence = $sprout->DNASeq(\@locationList); >>  C<< my $sequence = $sprout->DNASeq(\@locationList); >>
# Line 699  Line 754 
754  =back  =back
755    
756  =cut  =cut
757    #: Return Type $;
758  sub DNASeq {  sub DNASeq {
759          # Get the parameters.          # Get the parameters.
760          my $self = shift @_;      my ($self, $locationList) = @_;
         my ($locationList) = @_;  
761          # Create the return string.          # Create the return string.
762          my $retVal = "";          my $retVal = "";
763          # Loop through the locations.          # Loop through the locations.
# Line 718  Line 772 
772                  # the start point is the ending. Note that in the latter case we must reverse the DNA string                  # the start point is the ending. Note that in the latter case we must reverse the DNA string
773                  # before putting it in the return value.                  # before putting it in the return value.
774                  my ($start, $stop);                  my ($start, $stop);
775            Trace("Parse of \"$location\" is $beg$dir$len.") if T(SDNA => 4);
776                  if ($dir eq "+") {                  if ($dir eq "+") {
777                          $start = $beg;                          $start = $beg;
778                          $stop = $beg + $len - 1;                          $stop = $beg + $len - 1;
779                  } else {                  } else {
780                          $start = $beg + $len + 1;              $start = $beg - $len + 1;
781                          $stop = $beg;                          $stop = $beg;
782                  }                  }
783            Trace("Looking for sequences containing $start through $stop.") if T(SDNA => 4);
784                  my $query = $self->Get(['IsMadeUpOf','Sequence'],                  my $query = $self->Get(['IsMadeUpOf','Sequence'],
785                          "IsMadeUpOf(from-link) = ? AND IsMadeUpOf(start-position) + IsMadeUpOf(len) > ? AND " .                          "IsMadeUpOf(from-link) = ? AND IsMadeUpOf(start-position) + IsMadeUpOf(len) > ? AND " .
786                          " IsMadeUpOf(start-position) <= ? ORDER BY IsMadeUpOf(start-position)",                          " IsMadeUpOf(start-position) <= ? ORDER BY IsMadeUpOf(start-position)",
# Line 736  Line 792 
792                                  $sequence->Values(['IsMadeUpOf(start-position)', 'Sequence(sequence)',                                  $sequence->Values(['IsMadeUpOf(start-position)', 'Sequence(sequence)',
793                                                                     'IsMadeUpOf(len)']);                                                                     'IsMadeUpOf(len)']);
794                          my $stopPosition = $startPosition + $sequenceLength;                          my $stopPosition = $startPosition + $sequenceLength;
795                Trace("Sequence is from $startPosition to $stopPosition.") if T(SDNA => 4);
796                          # Figure out the start point and length of the relevant section.                          # Figure out the start point and length of the relevant section.
797                          my $pos1 = ($start < $startPosition ? 0 : $start - $startPosition);                          my $pos1 = ($start < $startPosition ? 0 : $start - $startPosition);
798                          my $len = ($stopPosition <= $stop ? $stopPosition : $stop) - $startPosition - $pos1;              my $len1 = ($stopPosition < $stop ? $stopPosition : $stop) + 1 - $startPosition - $pos1;
799                Trace("Position is $pos1 for length $len1.") if T(SDNA => 4);
800                          # Add the relevant data to the location data.                          # Add the relevant data to the location data.
801                          $locationDNA .= substr($sequenceData, $pos1, $len);              $locationDNA .= substr($sequenceData, $pos1, $len1);
802                  }                  }
803                  # Add this location's data to the return string. Note that we may need to reverse it.                  # Add this location's data to the return string. Note that we may need to reverse it.
804                  if ($dir eq '+') {                  if ($dir eq '+') {
805                          $retVal .= $locationDNA;                          $retVal .= $locationDNA;
806                  } else {                  } else {
807                          $locationDNA = join('', reverse split //, $locationDNA);              $retVal .= FIG::reverse_comp($locationDNA);
                         $retVal .= $locationDNA;  
808                  }                  }
809          }          }
810          # Return the result.          # Return the result.
# Line 773  Line 830 
830  =back  =back
831    
832  =cut  =cut
833    #: Return Type @;
834  sub AllContigs {  sub AllContigs {
835          # Get the parameters.          # Get the parameters.
836          my $self = shift @_;      my ($self, $genomeID) = @_;
         my ($genomeID) = @_;  
837          # Ask for the genome's Contigs.          # Ask for the genome's Contigs.
838          my @retVal = $self->GetFlat(['HasContig'], "HasContig(from-link) = ?", [$genomeID],          my @retVal = $self->GetFlat(['HasContig'], "HasContig(from-link) = ?", [$genomeID],
839                                                                  'HasContig(to-link)');                                                                  'HasContig(to-link)');
# Line 797  Line 853 
853    
854  ID of the contig whose length is desired.  ID of the contig whose length is desired.
855    
856    =item RETURN
857    
858    Returns the number of positions in the contig.
859    
860  =back  =back
861    
862  =cut  =cut
863    #: Return Type $;
864  sub ContigLength {  sub ContigLength {
865          # Get the parameters.          # Get the parameters.
866          my $self = shift @_;      my ($self, $contigID) = @_;
         my ($contigID) = @_;  
867          # Get the contig's last sequence.          # Get the contig's last sequence.
868          my $query = $self->Get(['IsMadeUpOf'],          my $query = $self->Get(['IsMadeUpOf'],
869                  "IsMadeUpOf(from-link) = ? ORDER BY IsMadeUpOf(start-position) DESC",                  "IsMadeUpOf(from-link) = ? ORDER BY IsMadeUpOf(start-position) DESC",
# Line 815  Line 874 
874          # Set it from the sequence data, if any.          # Set it from the sequence data, if any.
875          if ($sequence) {          if ($sequence) {
876                  my ($start, $len) = $sequence->Values(['IsMadeUpOf(start-position)', 'IsMadeUpOf(len)']);                  my ($start, $len) = $sequence->Values(['IsMadeUpOf(start-position)', 'IsMadeUpOf(len)']);
877                  $retVal = $start + $len;          $retVal = $start + $len - 1;
878        }
879        # Return the result.
880        return $retVal;
881    }
882    
883    =head3 ClusterPEGs
884    
885    C<< my $clusteredList = $sprout->ClusterPEGs($sub, \@pegs); >>
886    
887    Cluster the PEGs in a list according to the cluster coding scheme of the specified
888    subsystem. In order for this to work properly, the subsystem object must have
889    been used recently to retrieve the PEGs using the B<get_pegs_from_cell> method.
890    This causes the cluster numbers to be pulled into the subsystem's color hash.
891    If a PEG is not found in the color hash, it will not appear in the output
892    sequence.
893    
894    =over 4
895    
896    =item sub
897    
898    Sprout subsystem object for the relevant subsystem, from the L</get_subsystem>
899    method.
900    
901    =item pegs
902    
903    Reference to the list of PEGs to be clustered.
904    
905    =item RETURN
906    
907    Returns a list of the PEGs, grouped into smaller lists by cluster number.
908    
909    =back
910    
911    =cut
912    #: Return Type $@@;
913    sub ClusterPEGs {
914        # Get the parameters.
915        my ($self, $sub, $pegs) = @_;
916        # Declare the return variable.
917        my $retVal = [];
918        # Loop through the PEGs, creating arrays for each cluster.
919        for my $pegID (@{$pegs}) {
920            my $clusterNumber = $sub->get_cluster_number($pegID);
921            # Only proceed if the PEG is in a cluster.
922            if ($clusterNumber >= 0) {
923                # Push this PEG onto the sub-list for the specified cluster number.
924                push @{$retVal->[$clusterNumber]}, $pegID;
925            }
926          }          }
927          # Return the result.          # Return the result.
928          return $retVal;          return $retVal;
# Line 846  Line 953 
953  Returns a three-element list. The first element is a list of feature IDs for the features that  Returns a three-element list. The first element is a list of feature IDs for the features that
954  overlap the region of interest. The second and third elements are the minimum and maximum  overlap the region of interest. The second and third elements are the minimum and maximum
955  locations of the features provided on the specified contig. These may extend outside  locations of the features provided on the specified contig. These may extend outside
956  the start and stop values.  the start and stop values. The first element (that is, the list of features) is sorted
957    roughly by location.
958    
959  =back  =back
960    
961  =cut  =cut
962    #: Return Type @@;
963  sub GenesInRegion {  sub GenesInRegion {
964          # Get the parameters.          # Get the parameters.
965          my $self = shift @_;      my ($self, $contigID, $start, $stop) = @_;
         my ($contigID, $start, $stop) = @_;  
966          # Get the maximum segment length.          # Get the maximum segment length.
967          my $maximumSegmentLength = $self->MaxSegment;          my $maximumSegmentLength = $self->MaxSegment;
968          # Create a hash to receive the feature list. We use a hash so that we can eliminate          # Create a hash to receive the feature list. We use a hash so that we can eliminate
969          # duplicates easily.      # duplicates easily. The hash key will be the feature ID. The value will be a two-element
970        # containing the minimum and maximum offsets. We will use the offsets to sort the results
971        # when we're building the result set.
972          my %featuresFound = ();          my %featuresFound = ();
973          # Prime the values we'll use for the returned beginning and end.          # Prime the values we'll use for the returned beginning and end.
974          my ($min, $max) = ($self->ContigLength($contigID), 0);      my @initialMinMax = ($self->ContigLength($contigID), 0);
975        my ($min, $max) = @initialMinMax;
976          # Create a table of parameters for each query. Each query looks for features travelling in          # Create a table of parameters for each query. Each query looks for features travelling in
977          # a particular direction. The query parameters include the contig ID, the feature direction,          # a particular direction. The query parameters include the contig ID, the feature direction,
978          # the lowest possible start position, and the highest possible start position. This works          # the lowest possible start position, and the highest possible start position. This works
# Line 892  Line 1002 
1002                                          $found = 1;                                          $found = 1;
1003                                  }                                  }
1004                          } elsif ($dir eq '-') {                          } elsif ($dir eq '-') {
1005                                  $end = $beg - $len;                  # Note we switch things around so that the beginning is to the left of the
1006                                  if ($end <= $stop) {                  # ending.
1007                    ($beg, $end) = ($beg - $len, $beg);
1008                    if ($beg <= $stop) {
1009                                          # Denote we found a useful feature.                                          # Denote we found a useful feature.
1010                                          $found = 1;                                          $found = 1;
1011                                  }                                  }
1012                          }                          }
1013                          if ($found) {                          if ($found) {
1014                                  # Here we need to record the feature and update the minimum and maximum.                  # Here we need to record the feature and update the minima and maxima. First,
1015                                  $featuresFound{$featureID} = 1;                  # get the current entry for the specified feature.
1016                                  if ($beg < $min) { $min = $beg; }                  my ($loc1, $loc2) = (exists $featuresFound{$featureID} ? @{$featuresFound{$featureID}} :
1017                                  if ($end < $min) { $min = $end; }                                       @initialMinMax);
1018                                  if ($beg > $max) { $max = $beg; }                  # Merge the current segment's begin and end into the feature begin and end and the
1019                                  if ($end > $max) { $max = $end; }                  # global min and max.
1020                    if ($beg < $loc1) {
1021                        $loc1 = $beg;
1022                        $min = $beg if $beg < $min;
1023                    }
1024                    if ($end > $loc2) {
1025                        $loc2 = $end;
1026                        $max = $end if $end > $max;
1027                    }
1028                    # Store the entry back into the hash table.
1029                    $featuresFound{$featureID} = [$loc1, $loc2];
1030                          }                          }
1031                  }                  }
1032          }          }
1033          # Compute a list of the IDs for the features found.      # Now we must compute the list of the IDs for the features found. We start with a list
1034          my @list = (sort (keys %featuresFound));      # of midpoints / feature ID pairs. (It's not really a midpoint, it's twice the midpoint,
1035        # but the result of the sort will be the same.)
1036        my @list = map { [$featuresFound{$_}->[0] + $featuresFound{$_}->[1], $_] } keys %featuresFound;
1037        # Now we sort by midpoint and yank out the feature IDs.
1038        my @retVal = map { $_->[1] } sort { $a->[0] <=> $b->[0] } @list;
1039          # Return it along with the min and max.          # Return it along with the min and max.
1040          return (\@list, $min, $max);      return (\@retVal, $min, $max);
1041  }  }
1042    
1043  =head3 FType  =head3 FType
# Line 934  Line 1060 
1060  =back  =back
1061    
1062  =cut  =cut
1063    #: Return Type $;
1064  sub FType {  sub FType {
1065          # Get the parameters.          # Get the parameters.
1066          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1067          # Get the specified feature's type.          # Get the specified feature's type.
1068          my ($retVal) = $self->GetEntityValues('Feature', $featureID, ['Feature(feature-type)']);          my ($retVal) = $self->GetEntityValues('Feature', $featureID, ['Feature(feature-type)']);
1069          # Return the result.          # Return the result.
# Line 947  Line 1072 
1072    
1073  =head3 FeatureAnnotations  =head3 FeatureAnnotations
1074    
1075  C<< my @descriptors = $sprout->FeatureAnnotations($featureID); >>  C<< my @descriptors = $sprout->FeatureAnnotations($featureID, $rawFlag); >>
1076    
1077  Return the annotations of a feature.  Return the annotations of a feature.
1078    
# Line 957  Line 1082 
1082    
1083  ID of the feature whose annotations are desired.  ID of the feature whose annotations are desired.
1084    
1085    =item rawFlag
1086    
1087    If TRUE, the annotation timestamps will be returned in raw form; otherwise, they
1088    will be returned in human-readable form.
1089    
1090  =item RETURN  =item RETURN
1091    
1092  Returns a list of annotation descriptors. Each descriptor is a hash with the following fields.  Returns a list of annotation descriptors. Each descriptor is a hash with the following fields.
# Line 972  Line 1102 
1102  =back  =back
1103    
1104  =cut  =cut
1105    #: Return Type @%;
1106  sub FeatureAnnotations {  sub FeatureAnnotations {
1107          # Get the parameters.          # Get the parameters.
1108          my $self = shift @_;      my ($self, $featureID, $rawFlag) = @_;
         my ($featureID) = @_;  
1109          # Create a query to get the feature's annotations and the associated users.          # Create a query to get the feature's annotations and the associated users.
1110          my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],          my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1111                                                     "IsTargetOfAnnotation(from-link) = ?", [$featureID]);                                                     "IsTargetOfAnnotation(from-link) = ?", [$featureID]);
# Line 989  Line 1118 
1118                          $annotation->Values(['IsTargetOfAnnotation(from-link)',                          $annotation->Values(['IsTargetOfAnnotation(from-link)',
1119                                                                   'Annotation(time)', 'MadeAnnotation(from-link)',                                                                   'Annotation(time)', 'MadeAnnotation(from-link)',
1120                                                                   'Annotation(annotation)']);                                                                   'Annotation(annotation)']);
1121            # Convert the time, if necessary.
1122            if (! $rawFlag) {
1123                $timeStamp = FriendlyTimestamp($timeStamp);
1124            }
1125                  # Assemble them into a hash.                  # Assemble them into a hash.
1126                  my $annotationHash = { featureID => $featureID, timeStamp => $timeStamp,          my $annotationHash = { featureID => $featureID,
1127                                   timeStamp => $timeStamp,
1128                                                             user => $user, text => $text };                                                             user => $user, text => $text };
1129                  # Add it to the return list.                  # Add it to the return list.
1130                  push @retVal, $annotationHash;                  push @retVal, $annotationHash;
# Line 1004  Line 1138 
1138  C<< my %functions = $sprout->AllFunctionsOf($featureID); >>  C<< my %functions = $sprout->AllFunctionsOf($featureID); >>
1139    
1140  Return all of the functional assignments for a particular feature. The data is returned as a  Return all of the functional assignments for a particular feature. The data is returned as a
1141  hash of functional assignments to user IDs. A functional assignment is a type of annotation.  hash of functional assignments to user IDs. A functional assignment is a type of annotation,
1142  It has the format "XXXX\nset XXXX function to\nYYYYY". In this instance, XXXX is the user ID  Functional assignments are described in the L</ParseAssignment> function. Its worth noting that
1143  and YYYYY is the functional assignment text. Its worth noting that we cannot filter on the content  we cannot filter on the content of the annotation itself because it's a text field; however,
1144  of the annotation itself because it's a text field; however, this is not a big problem because most  this is not a big problem because most features only have a small number of annotations.
1145  features only have a small number of annotations.  Finally, if a single user has multiple functional assignments, we will only keep the most
1146    recent one.
1147    
1148  =over 4  =over 4
1149    
# Line 1016  Line 1151 
1151    
1152  ID of the feature whose functional assignments are desired.  ID of the feature whose functional assignments are desired.
1153    
1154    =item RETURN
1155    
1156    Returns a hash mapping the user IDs to functional assignment IDs.
1157    
1158  =back  =back
1159    
1160  =cut  =cut
1161    #: Return Type %;
1162  sub AllFunctionsOf {  sub AllFunctionsOf {
1163          # Get the parameters.          # Get the parameters.
1164          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1165          # Get all of the feature's annotations.          # Get all of the feature's annotations.
1166          my @query = $self->GetFlat(['IsTargetOfAnnotation', 'Annotation'],      my @query = $self->GetAll(['IsTargetOfAnnotation', 'Annotation'],
1167                                                      "IsTargetOfAnnotation(from-link) = ?",                                                      "IsTargetOfAnnotation(from-link) = ?",
1168                                                          [$featureID], 'Annotation(annotation)');                              [$featureID], ['Annotation(time)', 'Annotation(annotation)']);
1169          # Declare the return hash.          # Declare the return hash.
1170          my %retVal;          my %retVal;
1171        # Now we sort the assignments by timestamp in reverse.
1172        my @sortedQuery = sort { -($a->[0] <=> $b->[0]) } @query;
1173          # Loop until we run out of annotations.          # Loop until we run out of annotations.
1174          for my $text (@query) {      for my $annotation (@sortedQuery) {
1175            # Get the annotation fields.
1176            my ($timeStamp, $text) = @{$annotation};
1177                  # Check to see if this is a functional assignment.                  # Check to see if this is a functional assignment.
1178                  my ($user, $function) = ParseAssignment($text);          my ($user, $function) = _ParseAssignment($text);
1179                  if ($user) {          if ($user && ! exists $retVal{$user}) {
1180                          # Here it is, so stuff it in the return hash.              # Here it is a functional assignment and there has been no
1181                          $retVal{$function} = $user;              # previous assignment for this user, so we stuff it in the
1182                # return hash.
1183                $retVal{$user} = $function;
1184                  }                  }
1185          }          }
1186          # Return the hash of assignments found.          # Return the hash of assignments found.
# Line 1047  Line 1191 
1191    
1192  C<< my $functionText = $sprout->FunctionOf($featureID, $userID); >>  C<< my $functionText = $sprout->FunctionOf($featureID, $userID); >>
1193    
1194  Return the most recently-determined functional assignment of a particular feature. A functional  Return the most recently-determined functional assignment of a particular feature.
1195  assignment is a type of annotation. It has the format "XXXX\nset XXXX function to\nYYYYY". In this  
1196  instance, XXXX is the user ID and YYYYY is the functional assignment text. Its worth noting that  The functional assignment is handled differently depending on the type of feature. If
1197  we cannot filter on the content of the annotation itself because it's a text field; however, this  the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional
1198  is not a big problem because most features only have a small number of annotations.  assignment is a type of annotation. The format of an assignment is described in
1199    L</ParseAssignment>. Its worth noting that we cannot filter on the content of the
1200    annotation itself because it's a text field; however, this is not a big problem because
1201    most features only have a small number of annotations.
1202    
1203    Each user has an associated list of trusted users. The assignment returned will be the most
1204    recent one by at least one of the trusted users. If no trusted user list is available, then
1205    the specified user and FIG are considered trusted. If the user ID is omitted, only FIG
1206    is trusted.
1207    
1208    If the feature is B<not> identified by a FIG ID, then the functional assignment
1209    information is taken from the B<ExternalAliasFunc> table. If the table does
1210    not contain an entry for the feature, an undefined value is returned.
1211    
1212  =over 4  =over 4
1213    
# Line 1061  Line 1217 
1217    
1218  =item userID (optional)  =item userID (optional)
1219    
1220  ID of the user whose function determination is desired. If omitted, C<FIG> is assumed.  ID of the user whose function determination is desired. If omitted, only the latest
1221    C<FIG> assignment will be returned.
1222    
1223  =item RETURN  =item RETURN
1224    
# Line 1070  Line 1227 
1227  =back  =back
1228    
1229  =cut  =cut
1230    #: Return Type $;
1231  sub FunctionOf {  sub FunctionOf {
1232          # Get the parameters.          # Get the parameters.
1233          my $self = shift @_;      my ($self, $featureID, $userID) = @_;
1234          my ($featureID, $userID) = @_;      # Declare the return value.
         if (!$userID) { $userID = 'FIG'; }  
         # Build a query for all of the feature's annotation, sorted by date.  
         my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation'],  
                                                     "IsTargetOfAnnotation(from-link) = ?", [$featureID]);  
         # Declare the return value. We'll set this to the most recent annotation for the  
         # specified user.  
1235          my $retVal;          my $retVal;
1236        # Determine the ID type.
1237        if ($featureID =~ m/^fig\|/) {
1238            # Here we have a FIG feature ID. We must build the list of trusted
1239            # users.
1240            my %trusteeTable = ();
1241            # Check the user ID.
1242            if (!$userID) {
1243                # No user ID, so only FIG is trusted.
1244                $trusteeTable{FIG} = 1;
1245            } else {
1246                # Add this user's ID.
1247                $trusteeTable{$userID} = 1;
1248                # Look for the trusted users in the database.
1249                my @trustees = $self->GetFlat(['IsTrustedBy'], 'IsTrustedBy(from-link) = ?', [$userID], 'IsTrustedBy(to-link)');
1250                if (! @trustees) {
1251                    # None were found, so build a default list.
1252                    $trusteeTable{FIG} = 1;
1253                } else {
1254                    # Otherwise, put all the trustees in.
1255                    for my $trustee (@trustees) {
1256                        $trusteeTable{$trustee} = 1;
1257                    }
1258                }
1259            }
1260            # Build a query for all of the feature's annotations, sorted by date.
1261            my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation'],
1262                                   "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",
1263                                   [$featureID]);
1264          my $timeSelected = 0;          my $timeSelected = 0;
1265          # Loop until we run out of annotations.          # Loop until we run out of annotations.
1266          while (my $annotation = $query->Fetch()) {          while (my $annotation = $query->Fetch()) {
1267                  # Get the annotation text.                  # Get the annotation text.
1268                  my ($text, $time) = $annotation->Values(['Annotation(annotation)','Annotation(time)']);                  my ($text, $time) = $annotation->Values(['Annotation(annotation)','Annotation(time)']);
1269                  # Check to see if this is a functional assignment for the desired user.              # Check to see if this is a functional assignment for a trusted user.
1270                  my ($user, $type, $function) = split(/\n/, $text);              my ($user, $function) = _ParseAssignment($text);
1271                  if ($type =~ m/^set $userID function to$/i) {              if ($user) {
1272                          # Here it is, so we check the time and save the assignment value.                  # Here it is a functional assignment. Check the time and the user
1273                          if ($time > $timeSelected) {                  # name. The time must be recent and the user must be trusted.
1274                    if ((exists $trusteeTable{$user}) && ($time > $timeSelected)) {
1275                                  $retVal = $function;                                  $retVal = $function;
1276                                  $timeSelected = $time;                                  $timeSelected = $time;
1277                          }                          }
1278                  }                  }
1279          }          }
1280        } else {
1281            # Here we have a non-FIG feature ID. In this case the user ID does not
1282            # matter. We simply get the information from the External Alias Function
1283            # table.
1284            ($retVal) = $self->GetEntityValues('ExternalAliasFunc', $featureID, ['ExternalAliasFunc(func)']);
1285        }
1286          # Return the assignment found.          # Return the assignment found.
1287          return $retVal;          return $retVal;
1288  }  }
1289    
1290    =head3 FunctionsOf
1291    
1292    C<< my @functionList = $sprout->FunctionOf($featureID, $userID); >>
1293    
1294    Return the functional assignments of a particular feature.
1295    
1296    The functional assignment is handled differently depending on the type of feature. If
1297    the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional
1298    assignment is a type of annotation. The format of an assignment is described in
1299    L</ParseAssignment>. Its worth noting that we cannot filter on the content of the
1300    annotation itself because it's a text field; however, this is not a big problem because
1301    most features only have a small number of annotations.
1302    
1303    If the feature is B<not> identified by a FIG ID, then the functional assignment
1304    information is taken from the B<ExternalAliasFunc> table. If the table does
1305    not contain an entry for the feature, an empty list is returned.
1306    
1307    =over 4
1308    
1309    =item featureID
1310    
1311    ID of the feature whose functional assignments are desired.
1312    
1313    =item RETURN
1314    
1315    Returns a list of 2-tuples, each consisting of a user ID and the text of an assignment by
1316    that user.
1317    
1318    =back
1319    
1320    =cut
1321    #: Return Type @@;
1322    sub FunctionsOf {
1323        # Get the parameters.
1324        my ($self, $featureID) = @_;
1325        # Declare the return value.
1326        my @retVal = ();
1327        # Determine the ID type.
1328        if ($featureID =~ m/^fig\|/) {
1329            # Here we have a FIG feature ID. We must build the list of trusted
1330            # users.
1331            my %trusteeTable = ();
1332            # Build a query for all of the feature's annotations, sorted by date.
1333            my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation'],
1334                                   "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",
1335                                   [$featureID]);
1336            my $timeSelected = 0;
1337            # Loop until we run out of annotations.
1338            while (my $annotation = $query->Fetch()) {
1339                # Get the annotation text.
1340                my ($text, $time) = $annotation->Values(['Annotation(annotation)','Annotation(time)']);
1341                # Check to see if this is a functional assignment for a trusted user.
1342                my ($user, $function) = _ParseAssignment($text);
1343                if ($user) {
1344                    # Here it is a functional assignment.
1345                    push @retVal, [$user, $function];
1346                }
1347            }
1348        } else {
1349            # Here we have a non-FIG feature ID. In this case the user ID does not
1350            # matter. We simply get the information from the External Alias Function
1351            # table.
1352            push @retVal, $self->GetEntityValues('ExternalAliasFunc', $featureID, ['ExternalAliasFunc(func)']);
1353        }
1354        # Return the assignments found.
1355        return @retVal;
1356    }
1357    
1358  =head3 BBHList  =head3 BBHList
1359    
1360  C<< my $bbhHash = $sprout->BBHList($genomeID, \@featureList); >>  C<< my $bbhHash = $sprout->BBHList($genomeID, \@featureList); >>
# Line 1120  Line 1374 
1374    
1375  =item RETURN  =item RETURN
1376    
1377  Returns a reference to a hash that maps the IDs of the incoming features to the IDs of  Returns a reference to a hash that maps the IDs of the incoming features to the best hits
1378  their best hits.  on the target genome.
1379    
1380  =back  =back
1381    
1382  =cut  =cut
1383    #: Return Type %;
1384  sub BBHList {  sub BBHList {
1385          # Get the parameters.          # Get the parameters.
1386          my $self = shift @_;      my ($self, $genomeID, $featureList) = @_;
         my ($genomeID, $featureList) = @_;  
1387          # Create the return structure.          # Create the return structure.
1388          my %retVal = ();          my %retVal = ();
1389          # Loop through the incoming features.          # Loop through the incoming features.
# Line 1139  Line 1392 
1392                  my $query = $self->Get(['IsBidirectionalBestHitOf'],                  my $query = $self->Get(['IsBidirectionalBestHitOf'],
1393                                                             "IsBidirectionalBestHitOf(from-link) = ? AND IsBidirectionalBestHitOf(genome) = ?",                                                             "IsBidirectionalBestHitOf(from-link) = ? AND IsBidirectionalBestHitOf(genome) = ?",
1394                                                             [$featureID, $genomeID]);                                                             [$featureID, $genomeID]);
1395                  # Look for the best hit.          # Peel off the BBHs found.
1396                  my $bbh = $query->Fetch;          my @found = ();
1397                  if ($bbh) {          while (my $bbh = $query->Fetch) {
1398                          my ($targetFeature) = $bbh->Value('IsBidirectionalBestHitOf(to-link)');              push @found, $bbh->Value('IsBidirectionalBestHitOf(to-link)');
                         $retVal{$featureID} = $targetFeature;  
1399                  }                  }
1400            $retVal{$featureID} = \@found;
1401          }          }
1402          # Return the mapping.          # Return the mapping.
1403          return \%retVal;          return \%retVal;
1404  }  }
1405    
1406    =head3 SimList
1407    
1408    C<< my %similarities = $sprout->SimList($featureID, $count); >>
1409    
1410    Return a list of the similarities to the specified feature.
1411    
1412    Sprout does not support real similarities, so this method just returns the bidirectional
1413    best hits.
1414    
1415    =over 4
1416    
1417    =item featureID
1418    
1419    ID of the feature whose similarities are desired.
1420    
1421    =item count
1422    
1423    Maximum number of similar features to be returned, or C<0> to return them all.
1424    
1425    =back
1426    
1427    =cut
1428    #: Return Type %;
1429    sub SimList {
1430        # Get the parameters.
1431        my ($self, $featureID, $count) = @_;
1432        # Ask for the best hits.
1433        my @lists = $self->GetAll(['IsBidirectionalBestHitOf'],
1434                                  "IsBidirectionalBestHitOf(from-link) = ? ORDER BY IsBidirectionalBestHitOf(score) DESC",
1435                                  [$featureID], ['IsBidirectionalBestHitOf(to-link)', 'IsBidirectionalBestHitOf(score)'],
1436                                  $count);
1437        # Create the return value.
1438        my %retVal = ();
1439        for my $tuple (@lists) {
1440            $retVal{$tuple->[0]} = $tuple->[1];
1441        }
1442        # Return the result.
1443        return %retVal;
1444    }
1445    
1446    
1447    
1448    =head3 IsComplete
1449    
1450    C<< my $flag = $sprout->IsComplete($genomeID); >>
1451    
1452    Return TRUE if the specified genome is complete, else FALSE.
1453    
1454    =over 4
1455    
1456    =item genomeID
1457    
1458    ID of the genome whose completeness status is desired.
1459    
1460    =item RETURN
1461    
1462    Returns TRUE if the genome is complete, FALSE if it is incomplete, and C<undef> if it is
1463    not found.
1464    
1465    =back
1466    
1467    =cut
1468    #: Return Type $;
1469    sub IsComplete {
1470        # Get the parameters.
1471        my ($self, $genomeID) = @_;
1472        # Declare the return variable.
1473        my $retVal;
1474        # Get the genome's data.
1475        my $genomeData = $self->GetEntity('Genome', $genomeID);
1476        if ($genomeData) {
1477            # The genome exists, so get the completeness flag.
1478            ($retVal) = $genomeData->Value('complete');
1479        }
1480        # Return the result.
1481        return $retVal;
1482    }
1483    
1484  =head3 FeatureAliases  =head3 FeatureAliases
1485    
1486  C<< my @aliasList = $sprout->FeatureAliases($featureID); >>  C<< my @aliasList = $sprout->FeatureAliases($featureID); >>
# Line 1170  Line 1501 
1501  =back  =back
1502    
1503  =cut  =cut
1504    #: Return Type @;
1505  sub FeatureAliases {  sub FeatureAliases {
1506          # Get the parameters.          # Get the parameters.
1507          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1508          # Get the desired feature's aliases          # Get the desired feature's aliases
1509          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(alias)']);          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(alias)']);
1510          # Return the result.          # Return the result.
# Line 1201  Line 1531 
1531  =back  =back
1532    
1533  =cut  =cut
1534    #: Return Type $;
1535  sub GenomeOf {  sub GenomeOf {
1536          # Get the parameters.          # Get the parameters.
1537          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1538          # Create a query to find the genome associated with the feature.          # Create a query to find the genome associated with the feature.
1539          my $query = $self->Get(['IsLocatedIn', 'HasContig'], "IsLocatedIn(from-link) = ?", [$featureID]);          my $query = $self->Get(['IsLocatedIn', 'HasContig'], "IsLocatedIn(from-link) = ?", [$featureID]);
1540          # Declare the return value.          # Declare the return value.
# Line 1238  Line 1567 
1567  =back  =back
1568    
1569  =cut  =cut
1570    #: Return Type %;
1571  sub CoupledFeatures {  sub CoupledFeatures {
1572          # Get the parameters.          # Get the parameters.
1573          my $self = shift @_;      my ($self, $featureID) = @_;
1574          my ($featureID) = @_;      # Create a query to retrieve the functionally-coupled features.
1575          # Create a query to retrieve the functionally-coupled features. Note that we depend on the      my $query = $self->Get(['ParticipatesInCoupling', 'Coupling'],
1576          # fact that the functional coupling is physically paired. If (A,B) is in the database, then                             "ParticipatesInCoupling(from-link) = ?", [$featureID]);
         # (B,A) will also be found.  
         my $query = $self->Get(['IsClusteredOnChromosomeWith'],  
                                                    "IsClusteredOnChromosomeWith(from-link) = ?", [$featureID]);  
1577          # This value will be set to TRUE if we find at least one coupled feature.          # This value will be set to TRUE if we find at least one coupled feature.
1578          my $found = 0;          my $found = 0;
1579          # Create the return hash.          # Create the return hash.
1580          my %retVal = ();          my %retVal = ();
1581          # Retrieve the relationship records and store them in the hash.          # Retrieve the relationship records and store them in the hash.
1582          while (my $clustering = $query->Fetch()) {          while (my $clustering = $query->Fetch()) {
1583                  my ($otherFeatureID, $score) = $clustering->Values(['IsClusteredOnChromosomeWith(to-link)',          # Get the ID and score of the coupling.
1584                                                                      'IsClusteredOnChromosomeWith(score)']);          my ($couplingID, $score) = $clustering->Values(['Coupling(id)',
1585                                                            'Coupling(score)']);
1586            # The coupling ID contains the two feature IDs separated by a space. We use
1587            # this information to find the ID of the other feature.
1588            my ($fid1, $fid2) = split / /, $couplingID;
1589            my $otherFeatureID = ($featureID eq $fid1 ? $fid2 : $fid1);
1590            # Attach the other feature's score to its ID.
1591                  $retVal{$otherFeatureID} = $score;                  $retVal{$otherFeatureID} = $score;
1592                  $found = 1;                  $found = 1;
1593          }          }
# Line 1268  Line 1600 
1600          return %retVal;          return %retVal;
1601  }  }
1602    
1603    =head3 CouplingEvidence
1604    
1605    C<< my @evidence = $sprout->CouplingEvidence($peg1, $peg2); >>
1606    
1607    Return the evidence for a functional coupling.
1608    
1609    A pair of features is considered evidence of a coupling between two other
1610    features if they occur close together on a contig and both are similar to
1611    the coupled features. So, if B<A1> and B<A2> are close together on a contig,
1612    B<B1> and B<B2> are considered evidence for the coupling if (1) B<B1> and
1613    B<B2> are close together, (2) B<B1> is similar to B<A1>, and (3) B<B2> is
1614    similar to B<A2>.
1615    
1616    The score of a coupling is determined by the number of pieces of evidence
1617    that are considered I<representative>. If several evidence items belong to
1618    a group of genomes that are close to each other, only one of those items
1619    is considered representative. The other evidence items are presumed to be
1620    there because of the relationship between the genomes rather than because
1621    the two proteins generated by the features have a related functionality.
1622    
1623    Each evidence item is returned as a three-tuple in the form C<[>I<$peg1a>C<,>
1624    I<$peg2a>C<,> I<$rep>C<]>, where I<$peg1a> is similar to I<$peg1>, I<$peg2a>
1625    is similar to I<$peg2>, and I<$rep> is TRUE if the evidence is representative
1626    and FALSE otherwise.
1627    
1628    =over 4
1629    
1630    =item peg1
1631    
1632    ID of the feature of interest.
1633    
1634    =item peg2
1635    
1636    ID of a feature functionally coupled to the feature of interest.
1637    
1638    =item RETURN
1639    
1640    Returns a list of 3-tuples. Each tuple consists of a feature similar to the feature
1641    of interest, a feature similar to the functionally coupled feature, and a flag
1642    that is TRUE for a representative piece of evidence and FALSE otherwise.
1643    
1644    =back
1645    
1646    =cut
1647    #: Return Type @@;
1648    sub CouplingEvidence {
1649        # Get the parameters.
1650        my ($self, $peg1, $peg2) = @_;
1651        # Declare the return variable.
1652        my @retVal = ();
1653        # Our first task is to find out the nature of the coupling: whether or not
1654        # it exists, its score, and whether the features are stored in the same
1655        # order as the ones coming in.
1656        my ($couplingID, $inverted, $score) = $self->GetCoupling($peg1, $peg2);
1657        # Only proceed if a coupling exists.
1658        if ($couplingID) {
1659            # Determine the ordering to place on the evidence items. If we're
1660            # inverted, we want to see feature 2 before feature 1 (descending); otherwise,
1661            # we want feature 1 before feature 2 (normal).
1662            Trace("Coupling evidence for ($peg1, $peg2) with inversion flag $inverted.") if T(Coupling => 4);
1663            my $ordering = ($inverted ? "DESC" : "");
1664            # Get the coupling evidence.
1665            my @evidenceList = $self->GetAll(['IsEvidencedBy', 'PCH', 'UsesAsEvidence'],
1666                                              "IsEvidencedBy(from-link) = ? ORDER BY PCH(id), UsesAsEvidence(pos) $ordering",
1667                                              [$couplingID],
1668                                              ['PCH(used)', 'UsesAsEvidence(to-link)']);
1669            # Loop through the evidence items. Each piece of evidence is represented by two
1670            # positions in the evidence list, one for each feature on the other side of the
1671            # evidence link. If at some point we want to generalize to couplings with
1672            # more than two positions, this section of code will need to be re-done.
1673            while (@evidenceList > 0) {
1674                my $peg1Data = shift @evidenceList;
1675                my $peg2Data = shift @evidenceList;
1676                Trace("Peg 1 is " . $peg1Data->[1] . " and Peg 2 is " . $peg2Data->[1] . ".") if T(Coupling => 4);
1677                push @retVal, [$peg1Data->[1], $peg2Data->[1], $peg1Data->[0]];
1678            }
1679            Trace("Last index in evidence result is is $#retVal.") if T(Coupling => 4);
1680        }
1681        # Return the result.
1682        return @retVal;
1683    }
1684    
1685    =head3 GetCoupling
1686    
1687    C<< my ($couplingID, $inverted, $score) = $sprout->GetCoupling($peg1, $peg2); >>
1688    
1689    Return the coupling (if any) for the specified pair of PEGs. If a coupling
1690    exists, we return the coupling ID along with an indicator of whether the
1691    coupling is stored as C<(>I<$peg1>C<, >I<$peg2>C<)> or C<(>I<$peg2>C<, >I<$peg1>C<)>.
1692    In the second case, we say the coupling is I<inverted>. The importance of an
1693    inverted coupling is that the PEGs in the evidence will appear in reverse order.
1694    
1695    =over 4
1696    
1697    =item peg1
1698    
1699    ID of the feature of interest.
1700    
1701    =item peg2
1702    
1703    ID of the potentially coupled feature.
1704    
1705    =item RETURN
1706    
1707    Returns a three-element list. The first element contains the database ID of
1708    the coupling. The second element is FALSE if the coupling is stored in the
1709    database in the caller specified order and TRUE if it is stored in the
1710    inverted order. The third element is the coupling's score. If the coupling
1711    does not exist, all three list elements will be C<undef>.
1712    
1713    =back
1714    
1715    =cut
1716    #: Return Type $%@;
1717    sub GetCoupling {
1718        # Get the parameters.
1719        my ($self, $peg1, $peg2) = @_;
1720        # Declare the return values. We'll start with the coupling ID and undefine the
1721        # flag and score until we have more information.
1722        my ($retVal, $inverted, $score) = (CouplingID($peg1, $peg2), undef, undef);
1723        # Find the coupling data.
1724        my @pegs = $self->GetAll(['Coupling', 'ParticipatesInCoupling'],
1725                                     "Coupling(id) = ? ORDER BY ParticipatesInCoupling(pos)",
1726                                     [$retVal], ["ParticipatesInCoupling(from-link)", "Coupling(score)"]);
1727        # Check to see if we found anything.
1728        if (!@pegs) {
1729            Trace("No coupling found.") if T(Coupling => 4);
1730            # No coupling, so undefine the return value.
1731            $retVal = undef;
1732        } else {
1733            # We have a coupling! Get the score and check for inversion.
1734            $score = $pegs[0]->[1];
1735            my $firstFound = $pegs[0]->[0];
1736            $inverted = ($firstFound ne $peg1);
1737            Trace("Coupling score is $score. First peg is $firstFound, peg 1 is $peg1.") if T(Coupling => 4);
1738        }
1739        # Return the result.
1740        return ($retVal, $inverted, $score);
1741    }
1742    
1743    =head3 CouplingID
1744    
1745    C<< my $couplingID = Sprout::CouplingID($peg1, $peg2); >>
1746    
1747    Return the coupling ID for a pair of feature IDs.
1748    
1749    The coupling ID is currently computed by joining the feature IDs in
1750    sorted order with a space. Client modules (that is, modules which
1751    use Sprout) should not, however, count on this always being the
1752    case. This method provides a way for abstracting the concept of a
1753    coupling ID. All that we know for sure about it is that it can be
1754    generated easily from the feature IDs and the order of the IDs
1755    in the parameter list does not matter (i.e. C<CouplingID("a1", "b1")>
1756    will have the same value as C<CouplingID("b1", "a1")>.
1757    
1758    =over 4
1759    
1760    =item peg1
1761    
1762    First feature of interest.
1763    
1764    =item peg2
1765    
1766    Second feature of interest.
1767    
1768    =item RETURN
1769    
1770    Returns the ID that would be used to represent a functional coupling of
1771    the two specified PEGs.
1772    
1773    =back
1774    
1775    =cut
1776    #: Return Type $;
1777    sub CouplingID {
1778        return join " ", sort @_;
1779    }
1780    
1781  =head3 GetEntityTypes  =head3 GetEntityTypes
1782    
1783  C<< my @entityList = $sprout->GetEntityTypes(); >>  C<< my @entityList = $sprout->GetEntityTypes(); >>
# Line 1275  Line 1785 
1785  Return the list of supported entity types.  Return the list of supported entity types.
1786    
1787  =cut  =cut
1788    #: Return Type @;
1789  sub GetEntityTypes {  sub GetEntityTypes {
1790          # Get the parameters.          # Get the parameters.
1791          my $self = shift @_;      my ($self) = @_;
1792          # Get the underlying database object.          # Get the underlying database object.
1793          my $erdb = $self->{_erdb};          my $erdb = $self->{_erdb};
1794          # Get its entity type list.          # Get its entity type list.
# Line 1310  Line 1820 
1820  =back  =back
1821    
1822  =cut  =cut
1823    #: Return Type %;
1824  sub ReadFasta {  sub ReadFasta {
1825          # Get the parameters.          # Get the parameters.
1826          my ($fileName, $prefix) = @_;          my ($fileName, $prefix) = @_;
# Line 1329  Line 1839 
1839                  if ($line =~ m/^>\s*(.+?)(\s|\n)/) {                  if ($line =~ m/^>\s*(.+?)(\s|\n)/) {
1840                          # Here we have a new header. Store the current sequence if we have one.                          # Here we have a new header. Store the current sequence if we have one.
1841                          if ($id) {                          if ($id) {
1842                                  $retVal{$id} = $sequence;                  $retVal{$id} = lc $sequence;
1843                          }                          }
1844                          # Clear the sequence accumulator and save the new ID.                          # Clear the sequence accumulator and save the new ID.
1845                          ($id, $sequence) = ("$prefix$1", "");                          ($id, $sequence) = ("$prefix$1", "");
1846                  } else {                  } else {
1847                          # Here we have a data line, so we add it to the sequence accumulator.                          # Here we have a data line, so we add it to the sequence accumulator.
1848                          # First, we get the actual data out.              # First, we get the actual data out. Note that we normalize to lower
1849                # case.
1850                          $line =~ /^\s*(.*?)(\s|\n)/;                          $line =~ /^\s*(.*?)(\s|\n)/;
1851                          $sequence .= $1;                          $sequence .= $1;
1852                  }                  }
1853          }          }
1854          # Flush out the last sequence (if any).          # Flush out the last sequence (if any).
1855          if ($sequence) {          if ($sequence) {
1856                  $retVal {$id} = $sequence;          $retVal{$id} = lc $sequence;
1857          }          }
1858        # Close the file.
1859        close FASTAFILE;
1860          # Return the hash constructed from the file.          # Return the hash constructed from the file.
1861          return %retVal;          return %retVal;
1862  }  }
# Line 1354  Line 1867 
1867    
1868  Insure that a list of feature locations is in the Sprout format. The Sprout feature location  Insure that a list of feature locations is in the Sprout format. The Sprout feature location
1869  format is I<contig>_I<beg*len> where I<*> is C<+> for a forward gene and C<-> for a backward  format is I<contig>_I<beg*len> where I<*> is C<+> for a forward gene and C<-> for a backward
1870  gene. The old format is I<contig>_I<beg>_I<end>.  gene. The old format is I<contig>_I<beg>_I<end>. If a feature is in the new format already,
1871    it will not be changed; otherwise, it will be converted. This method can also be used to
1872    perform the reverse task-- insuring that all the locations are in the old format.
1873    
1874  =over 4  =over 4
1875    
# Line 1378  Line 1893 
1893  =back  =back
1894    
1895  =cut  =cut
1896    #: Return Type @;
1897  sub FormatLocations {  sub FormatLocations {
1898          # Get the parameters.          # Get the parameters.
1899          my $self = shift @_;      my ($self, $prefix, $locations, $oldFormat) = @_;
         my ($prefix, $locations, $oldFormat) = @_;  
1900          # Create the return list.          # Create the return list.
1901          my @retVal = ();          my @retVal = ();
1902          # Check to see if any locations were passed in.          # Check to see if any locations were passed in.
1903          if ($locations eq '') {          if ($locations eq '') {
1904              confess "No locations specified.";          Confess("No locations specified.");
1905          } else {          } else {
1906                  # Loop through the locations, converting them to the new format.                  # Loop through the locations, converting them to the new format.
1907                  for my $location (@{$locations}) {                  for my $location (@{$locations}) {
# Line 1422  Line 1936 
1936    
1937  sub DumpData {  sub DumpData {
1938          # Get the parameters.          # Get the parameters.
1939          my $self = shift @_;      my ($self) = @_;
1940          # Get the data directory name.          # Get the data directory name.
1941          my $outputDirectory = $self->{_options}->{dataDir};          my $outputDirectory = $self->{_options}->{dataDir};
1942          # Dump the relations.          # Dump the relations.
# Line 1436  Line 1950 
1950  Return the name of this database's XML definition file.  Return the name of this database's XML definition file.
1951    
1952  =cut  =cut
1953    #: Return Type $;
1954  sub XMLFileName {  sub XMLFileName {
1955          my $self = shift @_;      my ($self) = @_;
1956          return $self->{_xmlName};          return $self->{_xmlName};
1957  }  }
1958    
# Line 1458  Line 1972 
1972  The next statement inserts a C<HasProperty> relationship between feature C<fig|158879.1.peg.1> and  The next statement inserts a C<HasProperty> relationship between feature C<fig|158879.1.peg.1> and
1973  property C<4> with an evidence URL of C<http://seedu.uchicago.edu/query.cgi?article_id=142>.  property C<4> with an evidence URL of C<http://seedu.uchicago.edu/query.cgi?article_id=142>.
1974    
1975  C<< $sprout->InsertObject('HasProperty', { 'from-link' => 'fig|158879.1.peg.1', 'to-link' => 4, evidence = 'http://seedu.uchicago.edu/query.cgi?article_id=142'}); >>  C<< $sprout->InsertObject('HasProperty', { 'from-link' => 'fig|158879.1.peg.1', 'to-link' => 4, evidence => 'http://seedu.uchicago.edu/query.cgi?article_id=142'}); >>
1976    
1977  =over 4  =over 4
1978    
# Line 1473  Line 1987 
1987  =back  =back
1988    
1989  =cut  =cut
1990    #: Return Type ;
1991  sub Insert {  sub Insert {
1992          # Get the parameters.          # Get the parameters.
1993          my $self = shift @_;      my ($self, $objectType, $fieldHash) = @_;
         my ($objectType, $fieldHash) = @_;  
1994          # Call the underlying method.          # Call the underlying method.
1995          $self->{_erdb}->InsertObject($objectType, $fieldHash);          $self->{_erdb}->InsertObject($objectType, $fieldHash);
1996  }  }
# Line 1515  Line 2028 
2028  =back  =back
2029    
2030  =cut  =cut
2031    #: Return Type $;
2032  sub Annotate {  sub Annotate {
2033          # Get the parameters.          # Get the parameters.
2034          my $self = shift @_;      my ($self, $fid, $timestamp, $user, $text) = @_;
         my ($fid, $timestamp, $user, $text) = @_;  
2035          # Create the annotation ID.          # Create the annotation ID.
2036          my $aid = "$fid:$timestamp";          my $aid = "$fid:$timestamp";
2037          # Insert the Annotation object.          # Insert the Annotation object.
# Line 1539  Line 2051 
2051    
2052  =head3 AssignFunction  =head3 AssignFunction
2053    
2054  C<< my $ok = $sprout->AssignFunction($featureID, $user, $function); >>  C<< my $ok = $sprout->AssignFunction($featureID, $user, $function, $assigningUser); >>
2055    
2056  This method assigns a function to a feature. Functions are a special type of annotation. The general  This method assigns a function to a feature. Functions are a special type of annotation. The general
2057  format is "XXXX\nset XXXX function to\nYYYYY" where XXXX is the feature type and YYYY is the functional  format is described in L</ParseAssignment>.
 assignment text.  
2058    
2059  =over 4  =over 4
2060    
# Line 1553  Line 2064 
2064    
2065  =item user  =item user
2066    
2067  Name of the user making the assignment. This is frequently a group name, like C<kegg> or C<fig>.  Name of the user group making the assignment, such as C<kegg> or C<fig>.
2068    
2069  =item function  =item function
2070    
2071  Text of the function being assigned.  Text of the function being assigned.
2072    
2073    =item assigningUser (optional)
2074    
2075    Name of the individual user making the assignment. If omitted, defaults to the user group.
2076    
2077  =item RETURN  =item RETURN
2078    
2079  Returns 1 if successful, 0 if an error occurred.  Returns 1 if successful, 0 if an error occurred.
# Line 1566  Line 2081 
2081  =back  =back
2082    
2083  =cut  =cut
2084    #: Return Type $;
2085  sub AssignFunction {  sub AssignFunction {
2086          # Get the parameters.          # Get the parameters.
2087          my $self = shift @_;      my ($self, $featureID, $user, $function, $assigningUser) = @_;
2088          my ($featureID, $user, $function) = @_;      # Default the assigning user.
2089        if (! $assigningUser) {
2090            $assigningUser = $user;
2091        }
2092          # Create an annotation string from the parameters.          # Create an annotation string from the parameters.
2093          my $annotationText = "$user\nset $user function to\n$function";      my $annotationText = "$assigningUser\nset $user function to\n$function";
2094          # Get the current time.          # Get the current time.
2095          my $now = time;          my $now = time;
2096          # Declare the return variable.          # Declare the return variable.
# Line 1614  Line 2132 
2132  =back  =back
2133    
2134  =cut  =cut
2135    #: Return Type @;
2136  sub FeaturesByAlias {  sub FeaturesByAlias {
2137          # Get the parameters.          # Get the parameters.
2138          my $self = shift @_;      my ($self, $alias) = @_;
         my ($alias) = @_;  
2139          # Declare the return variable.          # Declare the return variable.
2140          my @retVal = ();          my @retVal = ();
2141          # Parse the alias.          # Parse the alias.
# Line 1657  Line 2174 
2174  =back  =back
2175    
2176  =cut  =cut
2177    #: Return Type $;
2178  sub Exists {  sub Exists {
2179          # Get the parameters.          # Get the parameters.
2180          my $self = shift @_;      my ($self, $entityName, $entityID) = @_;
         my ($entityName, $entityID) = @_;  
2181          # Check for the entity instance.          # Check for the entity instance.
2182        Trace("Checking existence of $entityName with ID=$entityID.") if T(4);
2183          my $testInstance = $self->GetEntity($entityName, $entityID);          my $testInstance = $self->GetEntity($entityName, $entityID);
2184          # Return an existence indicator.          # Return an existence indicator.
2185          my $retVal = ($testInstance ? 1 : 0);          my $retVal = ($testInstance ? 1 : 0);
# Line 1688  Line 2205 
2205  =back  =back
2206    
2207  =cut  =cut
2208    #: Return Type $;
2209  sub FeatureTranslation {  sub FeatureTranslation {
2210          # Get the parameters.          # Get the parameters.
2211          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
2212          # Get the specified feature's translation.          # Get the specified feature's translation.
2213          my ($retVal) = $self->GetEntityValues("Feature", $featureID, ['Feature(translation)']);          my ($retVal) = $self->GetEntityValues("Feature", $featureID, ['Feature(translation)']);
2214          return $retVal;          return $retVal;
# Line 1721  Line 2237 
2237  =back  =back
2238    
2239  =cut  =cut
2240    #: Return Type @;
2241  sub Taxonomy {  sub Taxonomy {
2242          # Get the parameters.          # Get the parameters.
2243          my $self = shift @_;      my ($self, $genome) = @_;
         my ($genome) = @_;  
2244          # Find the specified genome's taxonomy string.          # Find the specified genome's taxonomy string.
2245          my ($list) = $self->GetEntityValues('Genome', $genome, ['Genome(taxonomy)']);          my ($list) = $self->GetEntityValues('Genome', $genome, ['Genome(taxonomy)']);
2246          # Declare the return variable.          # Declare the return variable.
# Line 1765  Line 2280 
2280  =back  =back
2281    
2282  =cut  =cut
2283    #: Return Type $;
2284  sub CrudeDistance {  sub CrudeDistance {
2285          # Get the parameters.          # Get the parameters.
2286          my $self = shift @_;      my ($self, $genome1, $genome2) = @_;
         my ($genome1, $genome2) = @_;  
2287          # Insure that the distance is commutative by sorting the genome IDs.          # Insure that the distance is commutative by sorting the genome IDs.
2288          my ($genomeA, $genomeB);          my ($genomeA, $genomeB);
2289          if ($genome2 < $genome2) {          if ($genome2 < $genome2) {
# Line 1813  Line 2327 
2327  =back  =back
2328    
2329  =cut  =cut
2330    #: Return Type $;
2331  sub RoleName {  sub RoleName {
2332          # Get the parameters.          # Get the parameters.
2333          my $self = shift @_;      my ($self, $roleID) = @_;
         my ($roleID) = @_;  
2334          # Get the specified role's name.          # Get the specified role's name.
2335          my ($retVal) = $self->GetEntityValues('Role', $roleID, ['Role(name)']);          my ($retVal) = $self->GetEntityValues('Role', $roleID, ['Role(name)']);
2336          # Use the ID if the role has no name.          # Use the ID if the role has no name.
# Line 1847  Line 2360 
2360  =back  =back
2361    
2362  =cut  =cut
2363    #: Return Type @;
2364  sub RoleDiagrams {  sub RoleDiagrams {
2365          # Get the parameters.          # Get the parameters.
2366          my $self = shift @_;      my ($self, $roleID) = @_;
         my ($roleID) = @_;  
2367          # Query for the diagrams.          # Query for the diagrams.
2368          my @retVal = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],          my @retVal = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],
2369                                                                  'RoleOccursIn(to-link)');                                                                  'RoleOccursIn(to-link)');
# Line 1859  Line 2371 
2371          return @retVal;          return @retVal;
2372  }  }
2373    
2374    =head3 GetProperties
2375    
2376    C<< my @list = $sprout->GetProperties($fid, $key, $value, $url); >>
2377    
2378    Return a list of the properties with the specified characteristics.
2379    
2380    Properties are arbitrary key-value pairs associated with a feature. (At some point they
2381    will also be associated with genomes.) A property value is represented by a 4-tuple of
2382    the form B<($fid, $key, $value, $url)>. These exactly correspond to the parameter
2383    
2384    =over 4
2385    
2386    =item fid
2387    
2388    ID of the feature possessing the property.
2389    
2390    =item key
2391    
2392    Name or key of the property.
2393    
2394    =item value
2395    
2396    Value of the property.
2397    
2398    =item url
2399    
2400    URL of the document that indicated the property should have this particular value, or an
2401    empty string if no such document exists.
2402    
2403    =back
2404    
2405    The parameters act as a filter for the desired data. Any non-null parameter will
2406    automatically match all the tuples returned. So, specifying just the I<$fid> will
2407    return all the properties of the specified feature; similarly, specifying the I<$key>
2408    and I<$value> parameters will return all the features having the specified property
2409    value.
2410    
2411    A single property key can have many values, representing different ideas about the
2412    feature in question. For example, one paper may declare that a feature C<fig|83333.1.peg.10> is
2413    virulent, and another may declare that it is not virulent. A query about the virulence of
2414    C<fig|83333.1.peg.10> would be coded as
2415    
2416        my @list = $sprout->GetProperties('fig|83333.1.peg.10', 'virulence', '', '');
2417    
2418    Here the I<$value> and I<$url> fields are left blank, indicating that those fields are
2419    not to be filtered. The tuples returned would be
2420    
2421        ('fig|83333.1.peg.10', 'virulence', 'yes', 'http://www.somewhere.edu/first.paper.pdf')
2422        ('fig|83333.1.peg.10', 'virulence', 'no', 'http://www.somewhere.edu/second.paper.pdf')
2423    
2424    =cut
2425    #: Return Type @@;
2426    sub GetProperties {
2427        # Get the parameters.
2428        my ($self, @parms) = @_;
2429        # Declare the return variable.
2430        my @retVal = ();
2431        # Now we need to create a WHERE clause that will get us the data we want. First,
2432        # we create a list of the columns containing the data for each parameter.
2433        my @colNames = ('HasProperty(from-link)', 'Property(property-name)',
2434                        'Property(property-value)', 'HasProperty(evidence)');
2435        # Now we build the WHERE clause and the list of parameter values.
2436        my @where = ();
2437        my @values = ();
2438        for (my $i = 0; $i <= $#colNames; $i++) {
2439            my $parm = $parms[$i];
2440            if (defined $parm && ($parm ne '')) {
2441                push @where, "$colNames[$i] = ?";
2442                push @values, $parm;
2443            }
2444        }
2445        # Format the WHERE clause.
2446        my $filter = (@values > 0 ? (join " AND ", @where) : undef);
2447        # Ask for all the propertie values with the desired characteristics.
2448        my $query = $self->Get(['HasProperty', 'Property'], $filter, \@values);
2449        while (my $valueObject = $query->Fetch()) {
2450            my @tuple = $valueObject->Values(\@colNames);
2451            push @retVal, \@tuple;
2452        }
2453        # Return the result.
2454        return @retVal;
2455    }
2456    
2457  =head3 FeatureProperties  =head3 FeatureProperties
2458    
2459  C<< my @properties = $sprout->FeatureProperties($featureID); >>  C<< my @properties = $sprout->FeatureProperties($featureID); >>
# Line 1885  Line 2480 
2480  =back  =back
2481    
2482  =cut  =cut
2483    #: Return Type @@;
2484  sub FeatureProperties {  sub FeatureProperties {
2485          # Get the parameters.          # Get the parameters.
2486          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
2487          # Get the properties.          # Get the properties.
2488          my @retVal = $self->GetAll(['HasProperty', 'Property'], "HasProperty(from-link) = ?", [$featureID],          my @retVal = $self->GetAll(['HasProperty', 'Property'], "HasProperty(from-link) = ?", [$featureID],
2489                                                          ['Property(property-name)', 'Property(property-value)',                                                          ['Property(property-name)', 'Property(property-value)',
# Line 1917  Line 2511 
2511  =back  =back
2512    
2513  =cut  =cut
2514    #: Return Type $;
2515  sub DiagramName {  sub DiagramName {
2516          # Get the parameters.          # Get the parameters.
2517          my $self = shift @_;      my ($self, $diagramID) = @_;
         my ($diagramID) = @_;  
2518          # Get the specified diagram's name and return it.          # Get the specified diagram's name and return it.
2519          my ($retVal) = $self->GetEntityValues('Diagram', $diagramID, ['Diagram(name)']);          my ($retVal) = $self->GetEntityValues('Diagram', $diagramID, ['Diagram(name)']);
2520          return $retVal;          return $retVal;
# Line 1950  Line 2543 
2543  =back  =back
2544    
2545  =cut  =cut
2546    #: Return Type @;
2547  sub MergedAnnotations {  sub MergedAnnotations {
2548          # Get the parameters.          # Get the parameters.
2549          my $self = shift @_;      my ($self, $list) = @_;
         my ($list) = @_;  
2550          # Create a list to hold the annotation tuples found.          # Create a list to hold the annotation tuples found.
2551          my @tuples = ();          my @tuples = ();
2552          # Loop through the features in the input list.          # Loop through the features in the input list.
# Line 1969  Line 2561 
2561          }          }
2562          # Sort the result list by timestamp.          # Sort the result list by timestamp.
2563          my @retVal = sort { $a->[1] <=> $b->[1] } @tuples;          my @retVal = sort { $a->[1] <=> $b->[1] } @tuples;
2564        # Loop through and make the time stamps friendly.
2565        for my $tuple (@retVal) {
2566            $tuple->[1] = FriendlyTimestamp($tuple->[1]);
2567        }
2568          # Return the sorted list.          # Return the sorted list.
2569          return @retVal;          return @retVal;
2570  }  }
# Line 1995  Line 2591 
2591  =back  =back
2592    
2593  =cut  =cut
2594    #: Return Type @;
2595  sub RoleNeighbors {  sub RoleNeighbors {
2596          # Get the parameters.          # Get the parameters.
2597          my $self = shift @_;      my ($self, $roleID) = @_;
         my ($roleID) = @_;  
2598          # Get all the diagrams containing this role.          # Get all the diagrams containing this role.
2599          my @diagrams = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],          my @diagrams = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],
2600                                                                    'RoleOccursIn(to-link)');                                                                    'RoleOccursIn(to-link)');
# Line 2038  Line 2633 
2633  =back  =back
2634    
2635  =cut  =cut
2636    #: Return Type @;
2637  sub FeatureLinks {  sub FeatureLinks {
2638          # Get the parameters.          # Get the parameters.
2639          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
2640          # Get the feature's links.          # Get the feature's links.
2641          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(link)']);          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(link)']);
2642          # Return the feature's links.          # Return the feature's links.
# Line 2054  Line 2648 
2648  C<< my %subsystems = $sprout->SubsystemsOf($featureID); >>  C<< my %subsystems = $sprout->SubsystemsOf($featureID); >>
2649    
2650  Return a hash describing all the subsystems in which a feature participates. Each subsystem is mapped  Return a hash describing all the subsystems in which a feature participates. Each subsystem is mapped
2651  to the role the feature performs.  to the roles the feature performs.
2652    
2653  =over 4  =over 4
2654    
# Line 2064  Line 2658 
2658    
2659  =item RETURN  =item RETURN
2660    
2661  Returns a hash mapping all the feature's subsystems to the feature's role.  Returns a hash mapping all the feature's subsystems to a list of the feature's roles.
2662    
2663  =back  =back
2664    
2665  =cut  =cut
2666    #: Return Type %@;
2667  sub SubsystemsOf {  sub SubsystemsOf {
2668          # Get the parameters.          # Get the parameters.
2669          my $self = shift @_;      my ($self, $featureID) = @_;
2670          my ($featureID) = @_;      # Get the subsystem list.
         # Use the SSCell to connect features to subsystems.  
2671          my @subsystems = $self->GetAll(['ContainsFeature', 'HasSSCell', 'IsRoleOf'],          my @subsystems = $self->GetAll(['ContainsFeature', 'HasSSCell', 'IsRoleOf'],
2672                                                                          "ContainsFeature(to-link) = ?", [$featureID],                                                                          "ContainsFeature(to-link) = ?", [$featureID],
2673                                                                          ['HasSSCell(from-link)', 'IsRoleOf(from-link)']);                                                                          ['HasSSCell(from-link)', 'IsRoleOf(from-link)']);
2674          # Create the return value.          # Create the return value.
2675          my %retVal = ();          my %retVal = ();
2676        # Build a hash to weed out duplicates. Sometimes the same PEG and role appears
2677        # in two spreadsheet cells.
2678        my %dupHash = ();
2679          # Loop through the results, adding them to the hash.          # Loop through the results, adding them to the hash.
2680          for my $record (@subsystems) {          for my $record (@subsystems) {
2681                  $retVal{$record->[0]} = $record->[1];          # Get this subsystem and role.
2682            my ($subsys, $role) = @{$record};
2683            # Insure it's the first time for both.
2684            my $dupKey = "$subsys\n$role";
2685            if (! exists $dupHash{"$subsys\n$role"}) {
2686                $dupHash{$dupKey} = 1;
2687                push @{$retVal{$subsys}}, $role;
2688            }
2689          }          }
2690          # Return the hash.          # Return the hash.
2691          return %retVal;          return %retVal;
2692  }  }
2693    
2694    =head3 SubsystemList
2695    
2696    C<< my @subsystems = $sprout->SubsystemList($featureID); >>
2697    
2698    Return a list containing the names of the subsystems in which the specified
2699    feature participates. Unlike L</SubsystemsOf>, this method only returns the
2700    subsystem names, not the roles.
2701    
2702    =over 4
2703    
2704    =item featureID
2705    
2706    ID of the feature whose subsystem names are desired.
2707    
2708    =item RETURN
2709    
2710    Returns a list of the names of the subsystems in which the feature participates.
2711    
2712    =back
2713    
2714    =cut
2715    #: Return Type @;
2716    sub SubsystemList {
2717        # Get the parameters.
2718        my ($self, $featureID) = @_;
2719        # Get the list of names.
2720        my @retVal = $self->GetFlat(['ContainsFeature', 'HasSSCell'], "ContainsFeature(to-link) = ?",
2721                                    [$featureID], 'HasSSCell(from-link)');
2722        # Return the result.
2723        return @retVal;
2724    }
2725    
2726  =head3 RelatedFeatures  =head3 RelatedFeatures
2727    
2728  C<< my @relatedList = $sprout->RelatedFeatures($featureID, $function, $userID); >>  C<< my @relatedList = $sprout->RelatedFeatures($featureID, $function, $userID); >>
# Line 2118  Line 2753 
2753  =back  =back
2754    
2755  =cut  =cut
2756    #: Return Type @;
2757  sub RelatedFeatures {  sub RelatedFeatures {
2758          # Get the parameters.          # Get the parameters.
2759          my $self = shift @_;      my ($self, $featureID, $function, $userID) = @_;
         my ($featureID, $function, $userID) = @_;  
2760          # Get a list of the features that are BBHs of the incoming feature.          # Get a list of the features that are BBHs of the incoming feature.
2761          my @bbhFeatures = $self->GetFlat(['IsBidirectionalBestHitOf'],          my @bbhFeatures = $self->GetFlat(['IsBidirectionalBestHitOf'],
2762                                                                           "IsBidirectionalBestHitOf(from-link) = ?", [$featureID],                                                                           "IsBidirectionalBestHitOf(from-link) = ?", [$featureID],
# Line 2167  Line 2801 
2801  =back  =back
2802    
2803  =cut  =cut
2804    #: Return Type @;
2805  sub TaxonomySort {  sub TaxonomySort {
2806          # Get the parameters.          # Get the parameters.
2807          my $self = shift @_;      my ($self, $featureIDs) = @_;
         my ($featureIDs) = @_;  
2808          # Create the working hash table.          # Create the working hash table.
2809          my %hashBuffer = ();          my %hashBuffer = ();
2810          # Loop through the features.          # Loop through the features.
# Line 2180  Line 2813 
2813                  my ($taxonomy) = $self->GetFlat(['IsLocatedIn', 'HasContig', 'Genome'], "IsLocatedIn(from-link) = ?",                  my ($taxonomy) = $self->GetFlat(['IsLocatedIn', 'HasContig', 'Genome'], "IsLocatedIn(from-link) = ?",
2814                                                                                  [$fid], 'Genome(taxonomy)');                                                                                  [$fid], 'Genome(taxonomy)');
2815                  # Add this feature to the hash buffer.                  # Add this feature to the hash buffer.
2816                  if (exists $hashBuffer{$taxonomy}) {          Tracer::AddToListMap(\%hashBuffer, $taxonomy, $fid);
                         push @{$hashBuffer{$taxonomy}}, $fid;  
                 } else {  
                         $hashBuffer{$taxonomy} = [$fid];  
                 }  
2817          }          }
2818          # Sort the keys and get the elements.          # Sort the keys and get the elements.
2819          my @retVal = ();          my @retVal = ();
# Line 2250  Line 2879 
2879  =back  =back
2880    
2881  =cut  =cut
2882    #: Return Type @@;
2883  sub GetAll {  sub GetAll {
2884          # Get the parameters.          # Get the parameters.
2885          my $self = shift @_;      my ($self, $objectNames, $filterClause, $parameterList, $fields, $count) = @_;
2886          my ($objectNames, $filterClause, $parameterList, $fields, $count) = @_;      # Call the ERDB method.
2887          # Create the query.      my @retVal = $self->{_erdb}->GetAll($objectNames, $filterClause, $parameterList,
2888          my $query = $self->Get($objectNames, $filterClause, $parameterList);                                          $fields, $count);
         # Set up a counter of the number of records read.  
         my $fetched = 0;  
         # Insure the counter has a value.  
         if (!defined $count) {  
                 $count = 0;  
         }  
         # Loop through the records returned, extracting the fields. Note that if the  
         # counter is non-zero, we stop when the number of records read hits the count.  
         my @retVal = ();  
         while (($count == 0 || $fetched < $count) && (my $row = $query->Fetch())) {  
                 my @rowData = $row->Values($fields);  
                 push @retVal, \@rowData;  
                 $fetched++;  
         }  
2889          # Return the resulting list.          # Return the resulting list.
2890          return @retVal;          return @retVal;
2891  }  }
# Line 2312  Line 2927 
2927  =back  =back
2928    
2929  =cut  =cut
2930    #: Return Type @;
2931  sub GetFlat {  sub GetFlat {
2932          # Get the parameters.          # Get the parameters.
2933          my $self = shift @_;      my ($self, $objectNames, $filterClause, $parameterList, $field) = @_;
         my ($objectNames, $filterClause, $parameterList, $field) = @_;  
2934          # Construct the query.          # Construct the query.
2935          my $query = $self->Get($objectNames, $filterClause, $parameterList);          my $query = $self->Get($objectNames, $filterClause, $parameterList);
2936          # Create the result list.          # Create the result list.
# Line 2423  Line 3037 
3037  to load the entire database.  to load the entire database.
3038    
3039  =cut  =cut
3040    #: Return Type @;
3041  sub LoadInfo {  sub LoadInfo {
3042          # Get the parameters.          # Get the parameters.
3043          my $self = shift @_;      my ($self) = @_;
3044          # Create the return list, priming it with the name of the data directory.          # Create the return list, priming it with the name of the data directory.
3045          my @retVal = ($self->{_options}->{dataDir});          my @retVal = ($self->{_options}->{dataDir});
3046          # Concatenate the table names.          # Concatenate the table names.
# Line 2460  Line 3074 
3074  =back  =back
3075    
3076  =cut  =cut
3077    #: Return Type %;
3078  sub LowBBHs {  sub LowBBHs {
3079          # Get the parsameters.          # Get the parsameters.
3080          my $self = shift @_;      my ($self, $featureID, $cutoff) = @_;
         my ($featureID, $cutoff) = @_;  
3081          # Create the return hash.          # Create the return hash.
3082          my %retVal = ();          my %retVal = ();
3083          # Create a query to get the desired BBHs.          # Create a query to get the desired BBHs.
# Line 2480  Line 3093 
3093          return %retVal;          return %retVal;
3094  }  }
3095    
3096    =head3 GetGroups
3097    
3098    C<< my %groups = $sprout->GetGroups(\@groupList); >>
3099    
3100    Return a hash mapping each group to the IDs of the genomes in the group.
3101    A list of groups may be specified, in which case only those groups will be
3102    shown. Alternatively, if no parameter is supplied, all groups will be
3103    included. Genomes that are not in any group are omitted.
3104    
3105    =cut
3106    #: Return Type %@;
3107    sub GetGroups {
3108        # Get the parameters.
3109        my ($self, $groupList) = @_;
3110        # Declare the return value.
3111        my %retVal = ();
3112        # Determine whether we are getting all the groups or just some.
3113        if (defined $groupList) {
3114            # Here we have a group list. Loop through them individually,
3115            # getting a list of the relevant genomes.
3116            for my $group (@{$groupList}) {
3117                my @genomeIDs = $self->GetFlat(['Genome'], "Genome(group-name) = ?",
3118                    [$group], "Genome(id)");
3119                $retVal{$group} = \@genomeIDs;
3120            }
3121        } else {
3122            # Here we need all of the groups. In this case, we run through all
3123            # of the genome records, putting each one found into the appropriate
3124            # group. Note that we use a filter clause to insure that only genomes
3125            # in groups are included in the return set.
3126            my @genomes = $self->GetAll(['Genome'], "Genome(group-name) > ' '", [],
3127                                        ['Genome(id)', 'Genome(group-name)']);
3128            # Loop through the genomes found.
3129            for my $genome (@genomes) {
3130                # Pop this genome's ID off the current list.
3131                my @groups = @{$genome};
3132                my $genomeID = shift @groups;
3133                # Loop through the groups, adding the genome ID to each group's
3134                # list.
3135                for my $group (@groups) {
3136                    Tracer::AddToListMap(\%retVal, $group, $genomeID);
3137                }
3138            }
3139        }
3140        # Return the hash we just built.
3141        return %retVal;
3142    }
3143    
3144    =head3 MyGenomes
3145    
3146    C<< my @genomes = Sprout::MyGenomes($dataDir); >>
3147    
3148    Return a list of the genomes to be included in the Sprout.
3149    
3150    This method is provided for use during the Sprout load. It presumes the Genome load file has
3151    already been created. (It will be in the Sprout data directory and called either C<Genome>
3152    or C<Genome.dtx>.) Essentially, it reads in the Genome load file and strips out the genome
3153    IDs.
3154    
3155    =over 4
3156    
3157    =item dataDir
3158    
3159    Directory containing the Sprout load files.
3160    
3161    =back
3162    
3163    =cut
3164    #: Return Type @;
3165    sub MyGenomes {
3166        # Get the parameters.
3167        my ($dataDir) = @_;
3168        # Compute the genome file name.
3169        my $genomeFileName = LoadFileName($dataDir, "Genome");
3170        # Extract the genome IDs from the files.
3171        my @retVal = map { $_ =~ /^(\S+)/; $1 } Tracer::GetFile($genomeFileName);
3172        # Return the result.
3173        return @retVal;
3174    }
3175    
3176    =head3 LoadFileName
3177    
3178    C<< my $fileName = Sprout::LoadFileName($dataDir, $tableName); >>
3179    
3180    Return the name of the load file for the specified table in the specified data
3181    directory.
3182    
3183    =over 4
3184    
3185    =item dataDir
3186    
3187    Directory containing the Sprout load files.
3188    
3189    =item tableName
3190    
3191    Name of the table whose load file is desired.
3192    
3193    =item RETURN
3194    
3195    Returns the name of the file containing the load data for the specified table, or
3196    C<undef> if no load file is present.
3197    
3198    =back
3199    
3200    =cut
3201    #: Return Type $;
3202    sub LoadFileName {
3203        # Get the parameters.
3204        my ($dataDir, $tableName) = @_;
3205        # Declare the return variable.
3206        my $retVal;
3207        # Check for the various file names.
3208        if (-e "$dataDir/$tableName") {
3209            $retVal = "$dataDir/$tableName";
3210        } elsif (-e "$dataDir/$tableName.dtx") {
3211            $retVal = "$dataDir/$tableName.dtx";
3212        }
3213        # Return the result.
3214        return $retVal;
3215    }
3216    
3217  =head2 Internal Utility Methods  =head2 Internal Utility Methods
3218    
3219  =head3 ParseAssignment  =head3 ParseAssignment
3220    
3221  Parse annotation text to determine whether or not it is a functional assignment. If it is,  Parse annotation text to determine whether or not it is a functional assignment. If it is,
3222  the user and function text will be returned as a 2-element list. If it isn't, an empty list  the user, function text, and assigning user will be returned as a 3-element list. If it
3223  will be returned.  isn't, an empty list will be returned.
3224    
3225    A functional assignment is always of the form
3226    
3227        I<XXXX>C<\nset >I<YYYY>C< function to\n>I<ZZZZZ>
3228    
3229    where I<XXXX> is the B<assigning user>, I<YYYY> is the B<user>, and I<ZZZZ> is the
3230    actual functional role. In most cases, the user and the assigning user will be the
3231    same, but that is not always the case.
3232    
3233  This is a static method.  This is a static method.
3234    
# Line 2505  Line 3247 
3247    
3248  =cut  =cut
3249    
3250  sub ParseAssignment {  sub _ParseAssignment {
3251          # Get the parameters.          # Get the parameters.
3252          my ($text) = @_;          my ($text) = @_;
3253          # Declare the return value.          # Declare the return value.
3254          my @retVal = ();          my @retVal = ();
3255          # Check to see if this is a functional assignment.          # Check to see if this is a functional assignment.
3256          my ($user, $type, $function) = split(/\n/, $text);      my ($type, $function) = split(/\n/, $text);
3257          if ($type =~ m/^set $user function to$/i) {      if ($type =~ m/^set ([^ ]+) function to$/i) {
3258                  # Here it is, so we return the user name and function text.          # Here it is, so we return the user name (which is in $1), the functional role text,
3259                  @retVal = ($user, $function);          # and the assigning user.
3260            @retVal = ($1, $function);
3261          }          }
3262          # Return the result list.          # Return the result list.
3263          return @retVal;          return @retVal;
3264  }  }
3265    
3266    =head3 FriendlyTimestamp
3267    
3268    Convert a time number to a user-friendly time stamp for display.
3269    
3270    This is a static method.
3271    
3272    =over 4
3273    
3274    =item timeValue
3275    
3276    Numeric time value.
3277    
3278    =item RETURN
3279    
3280    Returns a string containing the same time in user-readable format.
3281    
3282    =back
3283    
3284    =cut
3285    
3286    sub FriendlyTimestamp {
3287        my ($timeValue) = @_;
3288        my $retVal = localtime($timeValue);
3289        return $retVal;
3290    }
3291    
3292    =head3 AddProperty
3293    
3294    C<< my  = $sprout->AddProperty($featureID, $key, $value, $url); >>
3295    
3296    Add a new attribute value (Property) to a feature. In the SEED system, attributes can
3297    be added to almost any object. In Sprout, they can only be added to features. In
3298    Sprout, attributes are implemented using I<properties>. A property represents a key/value
3299    pair. If the particular key/value pair coming in is not already in the database, a new
3300    B<Property> record is created to hold it.
3301    
3302    =over 4
3303    
3304    =item peg
3305    
3306    ID of the feature to which the attribute is to be replied.
3307    
3308    =item key
3309    
3310    Name of the attribute (key).
3311    
3312    =item value
3313    
3314    Value of the attribute.
3315    
3316    =item url
3317    
3318    URL or text citation from which the property was obtained.
3319    
3320    =back
3321    
3322    =cut
3323    #: Return Type ;
3324    sub AddProperty {
3325        # Get the parameters.
3326        my ($self, $featureID, $key, $value, $url) = @_;
3327        # Declare the variable to hold the desired property ID.
3328        my $propID;
3329        # Attempt to find a property record for this key/value pair.
3330        my @properties = $self->GetFlat(['Property'],
3331                                       "Property(property-name) = ? AND Property(property-value) = ?",
3332                                       [$key, $value], 'Property(id)');
3333        if (@properties) {
3334            # Here the property is already in the database. We save its ID.
3335            $propID = $properties[0];
3336            # Here the property value does not exist. We need to generate an ID. It will be set
3337            # to a number one greater than the maximum value in the database. This call to
3338            # GetAll will stop after one record.
3339            my @maxProperty = $self->GetAll(['Property'], "ORDER BY Property(id) DESC", [], ['Property(id)'],
3340                                            1);
3341            $propID = $maxProperty[0]->[0] + 1;
3342            # Insert the new property value.
3343            $self->Insert('Property', { 'property-name' => $key, 'property-value' => $value, id => $propID });
3344        }
3345        # Now we connect the incoming feature to the property.
3346        $self->Insert('HasProperty', { 'from-link' => $featureID, 'to-link' => $propID, evidence => $url });
3347    }
3348    
3349    
3350    
3351  1;  1;

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3