[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.19, Sun Aug 14 23:32:08 2005 UTC revision 1.99, Fri Apr 27 22:21:46 2007 UTC
# Line 1  Line 1 
1  package Sprout;  package Sprout;
2    
3        require Exporter;
4        use ERDB;
5        @ISA = qw(Exporter ERDB);
6      use Data::Dumper;      use Data::Dumper;
7      use strict;      use strict;
     use Carp;  
8      use DBKernel;      use DBKernel;
9      use XML::Simple;      use XML::Simple;
10      use DBQuery;      use DBQuery;
11      use DBObject;      use ERDBObject;
     use ERDB;  
12      use Tracer;      use Tracer;
13      use FIGRules;      use FIGRules;
14        use FidCheck;
15      use Stats;      use Stats;
16      use POSIX qw(strftime);      use POSIX qw(strftime);
17        use BasicLocation;
18        use CustomAttributes;
19        use RemoteCustomAttributes;
20    
21  =head1 Sprout Database Manipulation Object  =head1 Sprout Database Manipulation Object
22    
# Line 32  Line 36 
36  query tasks. For example, L</genomes> lists the IDs of all the genomes in the database and  query tasks. For example, L</genomes> lists the IDs of all the genomes in the database and
37  L</dna_seq> returns the DNA sequence for a specified genome location.  L</dna_seq> returns the DNA sequence for a specified genome location.
38    
39    The Sprout object is a subclass of the ERDB object and inherits all its properties and methods.
40    
41  =cut  =cut
42    
43  #: Constructor SFXlate->new_sprout_only();  #: Constructor SFXlate->new_sprout_only();
# Line 62  Line 68 
68    
69  * B<xmlFileName> name of the XML file containing the database definition (default C<SproutDBD.xml>)  * B<xmlFileName> name of the XML file containing the database definition (default C<SproutDBD.xml>)
70    
71  * B<userData> user name and password, delimited by a slash (default C<root/>)  * B<userData> user name and password, delimited by a slash (default same as SEED)
72    
73  * B<port> connection port (default C<0>)  * B<port> connection port (default C<0>)
74    
75    * B<sock> connection socket (default same as SEED)
76    
77  * B<maxSegmentLength> maximum number of residues per feature segment, (default C<4500>)  * B<maxSegmentLength> maximum number of residues per feature segment, (default C<4500>)
78    
79  * B<maxSequenceLength> maximum number of residues per sequence, (default C<8000>)  * B<maxSequenceLength> maximum number of residues per sequence, (default C<8000>)
80    
81    * B<noDBOpen> suppresses the connection to the database if TRUE, else FALSE
82    
83  =back  =back
84    
85  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 83  Line 93 
93  sub new {  sub new {
94      # Get the parameters.      # Get the parameters.
95      my ($class, $dbName, $options) = @_;      my ($class, $dbName, $options) = @_;
96        # Compute the DBD directory.
97        my $dbd_dir = (defined($FIG_Config::dbd_dir) ? $FIG_Config::dbd_dir :
98                                                      $FIG_Config::fig );
99      # 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
100      # the incoming data.      # the incoming data.
101      my $optionTable = Tracer::GetOptions({      my $optionTable = Tracer::GetOptions({
# Line 90  Line 103 
103                                                          # database type                                                          # database type
104                         dataDir      => $FIG_Config::sproutData,                         dataDir      => $FIG_Config::sproutData,
105                                                          # data file directory                                                          # data file directory
106                         xmlFileName  => "$FIG_Config::sproutData/SproutDBD.xml",                         xmlFileName  => "$dbd_dir/SproutDBD.xml",
107                                                          # database definition file name                                                          # database definition file name
108                         userData     => "$FIG_Config::dbuser/$FIG_Config::dbpass",                         userData     => "$FIG_Config::dbuser/$FIG_Config::dbpass",
109                                                          # user name and password                                                          # user name and password
110                         port         => $FIG_Config::dbport,                         port         => $FIG_Config::dbport,
111                                                          # database connection port                                                          # database connection port
112                           sock         => $FIG_Config::dbsock,
113                           host         => $FIG_Config::dbhost,
114                         maxSegmentLength => 4500,        # maximum feature segment length                         maxSegmentLength => 4500,        # maximum feature segment length
115                         maxSequenceLength => 8000,       # maximum contig sequence length                         maxSequenceLength => 8000,       # maximum contig sequence length
116                           noDBOpen     => 0,               # 1 to suppress the database open
117                        }, $options);                        }, $options);
118      # Get the data directory.      # Get the data directory.
119      my $dataDir = $optionTable->{dataDir};      my $dataDir = $optionTable->{dataDir};
# Line 105  Line 121 
121      $optionTable->{userData} =~ m!([^/]*)/(.*)$!;      $optionTable->{userData} =~ m!([^/]*)/(.*)$!;
122      my ($userName, $password) = ($1, $2);      my ($userName, $password) = ($1, $2);
123      # Connect to the database.      # Connect to the database.
124      my $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName, $password, $optionTable->{port});      my $dbh;
125        if (! $optionTable->{noDBOpen}) {
126            $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName,
127                                    $password, $optionTable->{port}, $optionTable->{host}, $optionTable->{sock});
128        }
129      # Create the ERDB object.      # Create the ERDB object.
130      my $xmlFileName = "$optionTable->{xmlFileName}";      my $xmlFileName = "$optionTable->{xmlFileName}";
131      my $erdb = ERDB->new($dbh, $xmlFileName);      my $retVal = ERDB::new($class, $dbh, $xmlFileName);
132      # Create this object.      # Add the option table and XML file name.
133      my $self = { _erdb => $erdb, _options => $optionTable, _xmlName => $xmlFileName };      $retVal->{_options} = $optionTable;
134      # Bless and return it.      $retVal->{_xmlName} = $xmlFileName;
135      bless $self;      # Set up space for the group file data.
136      return $self;      $retVal->{groupHash} = undef;
137        # Connect to the attributes.
138        if ($FIG_Config::attrURL) {
139            Trace("Remote attribute server $FIG_Config::attrURL chosen.") if T(3);
140            $retVal->{_ca} = RemoteCustomAttributes->new($FIG_Config::attrURL);
141        } elsif ($FIG_Config::attrDbName) {
142            Trace("Local attribute database $FIG_Config::attrDbName chosen.") if T(3);
143            my $user = ($FIG_Config::arch eq 'win' ? 'self' : scalar(getpwent()));
144            $retVal->{_ca} = CustomAttributes->new(user => $user);
145        }
146        # Return it.
147        return $retVal;
148  }  }
149    
150  =head3 MaxSegment  =head3 MaxSegment
# Line 148  Line 179 
179      return $self->{_options}->{maxSequenceLength};      return $self->{_options}->{maxSequenceLength};
180  }  }
181    
 =head3 Get  
   
 C<< my $query = $sprout->Get(\@objectNames, $filterClause, \@parameterList); >>  
   
 This method allows a general query against the Sprout data using a specified filter clause.  
   
 The filter is a standard WHERE/ORDER BY clause with question marks as parameter markers and each  
 field name represented in the form B<I<objectName>(I<fieldName>)>. For example, the  
 following call requests all B<Genome> objects for the genus specified in the variable  
 $genus.  
   
 C<< $query = $sprout->Get(['Genome'], "Genome(genus) = ?", [$genus]); >>  
   
 The WHERE clause contains a single question mark, so there is a single additional  
 parameter representing the parameter value. It would also be possible to code  
   
 C<< $query = $sprout->Get(['Genome'], "Genome(genus) = \'$genus\'"); >>  
   
 however, this version of the call would generate a syntax error if there were any quote  
 characters inside the variable C<$genus>.  
   
 The use of the strange parenthesized notation for field names enables us to distinguish  
 hyphens contained within field names from minus signs that participate in the computation  
 of the WHERE clause. All of the methods that manipulate fields will use this same notation.  
   
 It is possible to specify multiple entity and relationship names in order to retrieve more than  
 one object's data at the same time, which allows highly complex joined queries. For example,  
   
 C<< $query = $sprout->Get(['Genome', 'ComesFrom', 'Source'], "Genome(genus) = ?", [$genus]); >>  
   
 This query returns all the genomes for a particular genus and allows access to the  
 sources from which they came. The join clauses to go from Genome to Source are generated  
 automatically.  
   
 Finally, the filter clause can contain sort information. To do this, simply put an C<ORDER BY>  
 clause at the end of the filter. Field references in the ORDER BY section follow the same rules  
 as they do in the filter itself; in other words, each one must be of the form B<I<objectName>(I<fieldName>)>.  
 For example, the following filter string gets all genomes for a particular genus and sorts  
 them by species name.  
   
 C<< $query = $sprout->Get(['Genome'], "Genome(genus) = ? ORDER BY Genome(species)", [$genus]); >>  
   
 It is also permissible to specify I<only> an ORDER BY clause. For example, the following invocation gets  
 all genomes ordered by genus and species.  
   
 C<< $query = $sprout->Get(['Genome'], "ORDER BY Genome(genus), Genome(species)"); >>  
   
 Odd things may happen if one of the ORDER BY fields is in a secondary relation. So, for example, an  
 attempt to order B<Feature>s by alias may (depending on the underlying database engine used) cause  
 a single feature to appear more than once.  
   
 If multiple names are specified, then the query processor will automatically determine a  
 join path between the entities and relationships. The algorithm used is very simplistic.  
 In particular, you can't specify any entity or relationship more than once, and if a  
 relationship is recursive, the path is determined by the order in which the entity  
 and the relationship appear. For example, consider a recursive relationship B<IsParentOf>  
 which relates B<People> objects to other B<People> objects. If the join path is  
 coded as C<['People', 'IsParentOf']>, then the people returned will be parents. If, however,  
 the join path is C<['IsParentOf', 'People']>, then the people returned will be children.  
   
 =over 4  
   
 =item objectNames  
   
 List containing the names of the entity and relationship objects to be retrieved.  
   
 =item filterClause  
   
 WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can  
 be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form  
 B<I<objectName>(I<fieldName>)>. Any parameters specified in the filter clause should be added to the  
 parameter list as additional parameters. The fields in a filter clause can come from primary  
 entity relations, relationship relations, or secondary entity relations; however, all of the  
 entities and relationships involved must be included in the list of object names.  
   
 =item parameterList  
   
 List of the parameters to be substituted in for the parameters marks in the filter clause.  
   
 =item RETURN  
   
 Returns a B<DBQuery> that can be used to iterate through all of the results.  
   
 =back  
   
 =cut  
   
 sub Get {  
     # Get the parameters.  
     my ($self, $objectNames, $filterClause, $parameterList) = @_;  
     # We differ from the ERDB Get method in that the parameter list is passed in as a list reference  
     # rather than a list of parameters. The next step is to convert the parameters from a reference  
     # to a real list. We can only do this if the parameters have been specified.  
     my @parameters;  
     if ($parameterList) { @parameters = @{$parameterList}; }  
     return $self->{_erdb}->Get($objectNames, $filterClause, @parameters);  
 }  
   
 =head3 GetEntity  
   
 C<< my $entityObject = $sprout->GetEntity($entityType, $ID); >>  
   
 Return an object describing the entity instance with a specified ID.  
   
 =over 4  
   
 =item entityType  
   
 Entity type name.  
   
 =item ID  
   
 ID of the desired entity.  
   
 =item RETURN  
   
 Returns a B<DBObject> representing the desired entity instance, or an undefined value if no  
 instance is found with the specified key.  
   
 =back  
   
 =cut  
   
 sub GetEntity {  
     # Get the parameters.  
     my ($self, $entityType, $ID) = @_;  
     # Call the ERDB method.  
     return $self->{_erdb}->GetEntity($entityType, $ID);  
 }  
   
 =head3 GetEntityValues  
   
 C<< my @values = GetEntityValues($entityType, $ID, \@fields); >>  
   
 Return a list of values from a specified entity instance.  
   
 =over 4  
   
 =item entityType  
   
 Entity type name.  
   
 =item ID  
   
 ID of the desired entity.  
   
 =item fields  
   
 List of field names, each of the form I<objectName>C<(>I<fieldName>C<)>.  
   
 =item RETURN  
   
 Returns a flattened list of the values of the specified fields for the specified entity.  
   
 =back  
   
 =cut  
 #: Return Type @;  
 sub GetEntityValues {  
     # Get the parameters.  
     my ($self, $entityType, $ID, $fields) = @_;  
     # Call the ERDB method.  
     return $self->{_erdb}->GetEntityValues($entityType, $ID, $fields);  
 }  
   
 =head3 ShowMetaData  
   
 C<< $sprout->ShowMetaData($fileName); >>  
   
 This method outputs a description of the database to an HTML file in the data directory.  
   
 =over 4  
   
 =item fileName  
   
 Fully-qualified name to give to the output file.  
   
 =back  
   
 =cut  
   
 sub ShowMetaData {  
     # Get the parameters.  
     my ($self, $fileName) = @_;  
     # Compute the file name.  
     my $options = $self->{_options};  
     # Call the show method on the underlying ERDB object.  
     $self->{_erdb}->ShowMetaData($fileName);  
 }  
   
182  =head3 Load  =head3 Load
183    
184  C<< $sprout->Load($rebuild); >>;  C<< $sprout->Load($rebuild); >>;
# Line 372  Line 213 
213  sub Load {  sub Load {
214      # Get the parameters.      # Get the parameters.
215      my ($self, $rebuild) = @_;      my ($self, $rebuild) = @_;
     # Get the database object.  
     my $erdb = $self->{_erdb};  
216      # Load the tables from the data directory.      # Load the tables from the data directory.
217      my $retVal = $erdb->LoadTables($self->{_options}->{dataDir}, $rebuild);      my $retVal = $self->LoadTables($self->{_options}->{dataDir}, $rebuild);
218      # Return the statistics.      # Return the statistics.
219      return $retVal;      return $retVal;
220  }  }
221    
222  =head3 LoadUpdate  =head3 LoadUpdate
223    
224  C<< my %stats = $sprout->LoadUpdate($truncateFlag, \@tableList); >>  C<< my $stats = $sprout->LoadUpdate($truncateFlag, \@tableList); >>
225    
226  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
227  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 415  Line 254 
254  sub LoadUpdate {  sub LoadUpdate {
255      # Get the parameters.      # Get the parameters.
256      my ($self, $truncateFlag, $tableList) = @_;      my ($self, $truncateFlag, $tableList) = @_;
     # Get the database object.  
     my $erdb = $self->{_erdb};  
257      # Declare the return value.      # Declare the return value.
258      my $retVal = Stats->new();      my $retVal = Stats->new();
259      # Get the data directory.      # Get the data directory.
# Line 430  Line 267 
267              Trace("No load file found for $tableName in $dataDir.") if T(0);              Trace("No load file found for $tableName in $dataDir.") if T(0);
268          } else {          } else {
269              # Attempt to load this table.              # Attempt to load this table.
270              my $result = $erdb->LoadTable($fileName, $tableName, $truncateFlag);              my $result = $self->LoadTable($fileName, $tableName, $truncateFlag);
271              # Accumulate the resulting statistics.              # Accumulate the resulting statistics.
272              $retVal->Accumulate($result);              $retVal->Accumulate($result);
273          }          }
# Line 439  Line 276 
276      return $retVal;      return $retVal;
277  }  }
278    
279    =head3 GenomeCounts
280    
281    C<< my ($arch, $bact, $euk, $vir, $env, $unk) = $sprout->GenomeCounts($complete); >>
282    
283    Count the number of genomes in each domain. If I<$complete> is TRUE, only complete
284    genomes will be included in the counts.
285    
286    =over 4
287    
288    =item complete
289    
290    TRUE if only complete genomes are to be counted, FALSE if all genomes are to be
291    counted
292    
293    =item RETURN
294    
295    A six-element list containing the number of genomes in each of six categories--
296    Archaea, Bacteria, Eukaryota, Viral, Environmental, and Unknown, respectively.
297    
298    =back
299    
300    =cut
301    
302    sub GenomeCounts {
303        # Get the parameters.
304        my ($self, $complete) = @_;
305        # Set the filter based on the completeness flag.
306        my $filter = ($complete ? "Genome(complete) = 1" : "");
307        # Get all the genomes and the related taxonomy information.
308        my @genomes = $self->GetAll(['Genome'], $filter, [], ['Genome(id)', 'Genome(taxonomy)']);
309        # Clear the counters.
310        my ($arch, $bact, $euk, $vir, $env, $unk) = (0, 0, 0, 0, 0, 0);
311        # Loop through, counting the domains.
312        for my $genome (@genomes) {
313            if    ($genome->[1] =~ /^archaea/i)  { ++$arch }
314            elsif ($genome->[1] =~ /^bacter/i)   { ++$bact }
315            elsif ($genome->[1] =~ /^eukar/i)    { ++$euk }
316            elsif ($genome->[1] =~ /^vir/i)      { ++$vir }
317            elsif ($genome->[1] =~ /^env/i)      { ++$env }
318            else  { ++$unk }
319        }
320        # Return the counts.
321        return ($arch, $bact, $euk, $vir, $env, $unk);
322    }
323    
324    =head3 ContigCount
325    
326    C<< my $count = $sprout->ContigCount($genomeID); >>
327    
328    Return the number of contigs for the specified genome ID.
329    
330    =over 4
331    
332    =item genomeID
333    
334    ID of the genome whose contig count is desired.
335    
336    =item RETURN
337    
338    Returns the number of contigs for the specified genome.
339    
340    =back
341    
342    =cut
343    
344    sub ContigCount {
345        # Get the parameters.
346        my ($self, $genomeID) = @_;
347        # Get the contig count.
348        my $retVal = $self->GetCount(['Contig', 'HasContig'], "HasContig(from-link) = ?", [$genomeID]);
349        # Return the result.
350        return $retVal;
351    }
352    
353    =head3 GeneMenu
354    
355    C<< my $selectHtml = $sprout->GeneMenu(\%attributes, $filterString, \@params, $selected); >>
356    
357    Return an HTML select menu of genomes. Each genome will be an option in the menu,
358    and will be displayed by name with the ID and a contig count attached. The selection
359    value will be the genome ID. The genomes will be sorted by genus/species name.
360    
361    =over 4
362    
363    =item attributes
364    
365    Reference to a hash mapping attributes to values for the SELECT tag generated.
366    
367    =item filterString
368    
369    A filter string for use in selecting the genomes. The filter string must conform
370    to the rules for the C<< ERDB->Get >> method.
371    
372    =item params
373    
374    Reference to a list of values to be substituted in for the parameter marks in
375    the filter string.
376    
377    =item selected (optional)
378    
379    ID of the genome to be initially selected.
380    
381    =item fast (optional)
382    
383    If specified and TRUE, the contig counts will be omitted to improve performance.
384    
385    =item RETURN
386    
387    Returns an HTML select menu with the specified genomes as selectable options.
388    
389    =back
390    
391    =cut
392    
393    sub GeneMenu {
394        # Get the parameters.
395        my ($self, $attributes, $filterString, $params, $selected, $fast) = @_;
396        my $slowMode = ! $fast;
397        # Default to nothing selected. This prevents an execution warning if "$selected"
398        # is undefined.
399        $selected = "" unless defined $selected;
400        Trace("Gene Menu called with slow mode \"$slowMode\" and selection \"$selected\".") if T(3);
401        # Start the menu.
402        my $retVal = "<select " .
403            join(" ", map { "$_=\"$attributes->{$_}\"" } keys %{$attributes}) .
404            ">\n";
405        # Get the genomes.
406        my @genomes = $self->GetAll(['Genome'], $filterString, $params, ['Genome(id)',
407                                                                         'Genome(genus)',
408                                                                         'Genome(species)',
409                                                                         'Genome(unique-characterization)']);
410        # Sort them by name.
411        my @sorted = sort { lc("$a->[1] $a->[2]") cmp lc("$b->[1] $b->[2]") } @genomes;
412        # Loop through the genomes, creating the option tags.
413        for my $genomeData (@sorted) {
414            # Get the data for this genome.
415            my ($genomeID, $genus, $species, $strain) = @{$genomeData};
416            # Get the contig count.
417            my $contigInfo = "";
418            if ($slowMode) {
419                my $count = $self->ContigCount($genomeID);
420                my $counting = ($count == 1 ? "contig" : "contigs");
421                $contigInfo = "[$count $counting]";
422            }
423            # Find out if we're selected.
424            my $selectOption = ($selected eq $genomeID ? " selected" : "");
425            # Build the option tag.
426            $retVal .= "<option value=\"$genomeID\"$selectOption>$genus $species $strain ($genomeID)$contigInfo</option>\n";
427        }
428        # Close the SELECT tag.
429        $retVal .= "</select>\n";
430        # Return the result.
431        return $retVal;
432    }
433    
434  =head3 Build  =head3 Build
435    
436  C<< $sprout->Build(); >>  C<< $sprout->Build(); >>
# Line 453  Line 445 
445      # Get the parameters.      # Get the parameters.
446      my ($self) = @_;      my ($self) = @_;
447      # Create the tables.      # Create the tables.
448      $self->{_erdb}->CreateTables;      $self->CreateTables();
449  }  }
450    
451  =head3 Genomes  =head3 Genomes
# Line 576  Line 568 
568  =item RETURN  =item RETURN
569    
570  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
571  context and as a space-delimited string in a scalar context.  context and as a comma-delimited string in a scalar context.
572    
573  =back  =back
574    
# Line 603  Line 595 
595          if ($prevContig eq $contigID && $dir eq $prevDir) {          if ($prevContig eq $contigID && $dir eq $prevDir) {
596              # 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
597              # new segment's beginning is next to the old segment's end.              # new segment's beginning is next to the old segment's end.
598              if (($dir eq "-" && $beg == $prevBeg - $prevLen) ||              if ($dir eq "-" && $beg + $len == $prevBeg) {
599                  ($dir eq "+" && $beg == $prevBeg + $prevLen)) {                  # Here we're merging two backward blocks, so we keep the new begin point
600                  # Here we need to merge two segments. Adjust the beginning and length values                  # and adjust the length.
601                  # to include both segments.                  $len += $prevLen;
602                    # Pop the old segment off. The new one will replace it later.
603                    pop @retVal;
604                } elsif ($dir eq "+" && $beg == $prevBeg + $prevLen) {
605                    # Here we need to merge two forward blocks. Adjust the beginning and
606                    # length values to include both segments.
607                  $beg = $prevBeg;                  $beg = $prevBeg;
608                  $len += $prevLen;                  $len += $prevLen;
609                  # 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 615  Line 612 
612          }          }
613          # Remember this specifier for the adjacent-segment test the next time through.          # Remember this specifier for the adjacent-segment test the next time through.
614          ($prevContig, $prevBeg, $prevDir, $prevLen) = ($contigID, $beg, $dir, $len);          ($prevContig, $prevBeg, $prevDir, $prevLen) = ($contigID, $beg, $dir, $len);
615            # Compute the initial base pair.
616            my $start = ($dir eq "+" ? $beg : $beg + $len - 1);
617          # Add the specifier to the list.          # Add the specifier to the list.
618          push @retVal, "${contigID}_$beg$dir$len";          push @retVal, "${contigID}_$start$dir$len";
619      }      }
620      # Return the list in the format indicated by the context.      # Return the list in the format indicated by the context.
621      return (wantarray ? @retVal : join(' ', @retVal));      return (wantarray ? @retVal : join(',', @retVal));
622  }  }
623    
624  =head3 ParseLocation  =head3 ParseLocation
# Line 650  Line 649 
649      shift if UNIVERSAL::isa($_[0],__PACKAGE__);      shift if UNIVERSAL::isa($_[0],__PACKAGE__);
650      my ($location) = @_;      my ($location) = @_;
651      # Parse it into segments.      # Parse it into segments.
652      $location =~ /^(.*)_(\d*)([+-_])(\d*)$/;      $location =~ /^(.+)_(\d+)([+\-_])(\d+)$/;
653      my ($contigID, $start, $dir, $len) = ($1, $2, $3, $4);      my ($contigID, $start, $dir, $len) = ($1, $2, $3, $4);
654      # If the direction is an underscore, convert it to a + or -.      # If the direction is an underscore, convert it to a + or -.
655      if ($dir eq "_") {      if ($dir eq "_") {
# Line 666  Line 665 
665      return ($contigID, $start, $dir, $len);      return ($contigID, $start, $dir, $len);
666  }  }
667    
668    
669    
670  =head3 PointLocation  =head3 PointLocation
671    
672  C<< my $found = Sprout::PointLocation($location, $point); >>  C<< my $found = Sprout::PointLocation($location, $point); >>
# Line 726  Line 727 
727  should be of the form returned by L</featureLocation> when in a list context. In other words,  should be of the form returned by L</featureLocation> when in a list context. In other words,
728  each location is of the form I<contigID>C<_>I<begin>I<dir>I<end>.  each location is of the form I<contigID>C<_>I<begin>I<dir>I<end>.
729    
730    For example, the following would return the DNA sequence for contig C<83333.1:NC_000913>
731    between positions 1401 and 1532, inclusive.
732    
733        my $sequence = $sprout->DNASeq('83333.1:NC_000913_1401_1532');
734    
735  =over 4  =over 4
736    
737  =item locationList  =item locationList
738    
739  List of location specifiers, each in the form I<contigID>C<_>I<begin>I<dir>I<end> (see  List of location specifiers, each in the form I<contigID>C<_>I<begin>I<dir>I<len> or
740  L</FeatureLocation> for more about this format).  I<contigID>C<_>I<begin>C<_>I<end> (see L</FeatureLocation> for more about this format).
741    
742  =item RETURN  =item RETURN
743    
# Line 758  Line 764 
764          # 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
765          # before putting it in the return value.          # before putting it in the return value.
766          my ($start, $stop);          my ($start, $stop);
767            Trace("Parse of \"$location\" is $beg$dir$len.") if T(SDNA => 4);
768          if ($dir eq "+") {          if ($dir eq "+") {
769              $start = $beg;              $start = $beg;
770              $stop = $beg + $len - 1;              $stop = $beg + $len - 1;
771          } else {          } else {
772              $start = $beg + $len + 1;              $start = $beg - $len + 1;
773              $stop = $beg;              $stop = $beg;
774          }          }
775            Trace("Looking for sequences containing $start through $stop.") if T(SDNA => 4);
776          my $query = $self->Get(['IsMadeUpOf','Sequence'],          my $query = $self->Get(['IsMadeUpOf','Sequence'],
777              "IsMadeUpOf(from-link) = ? AND IsMadeUpOf(start-position) + IsMadeUpOf(len) > ? AND " .              "IsMadeUpOf(from-link) = ? AND IsMadeUpOf(start-position) + IsMadeUpOf(len) > ? AND " .
778              " IsMadeUpOf(start-position) <= ? ORDER BY IsMadeUpOf(start-position)",              " IsMadeUpOf(start-position) <= ? ORDER BY IsMadeUpOf(start-position)",
# Line 776  Line 784 
784                  $sequence->Values(['IsMadeUpOf(start-position)', 'Sequence(sequence)',                  $sequence->Values(['IsMadeUpOf(start-position)', 'Sequence(sequence)',
785                                     'IsMadeUpOf(len)']);                                     'IsMadeUpOf(len)']);
786              my $stopPosition = $startPosition + $sequenceLength;              my $stopPosition = $startPosition + $sequenceLength;
787                Trace("Sequence is from $startPosition to $stopPosition.") if T(SDNA => 4);
788              # Figure out the start point and length of the relevant section.              # Figure out the start point and length of the relevant section.
789              my $pos1 = ($start < $startPosition ? 0 : $start - $startPosition);              my $pos1 = ($start < $startPosition ? 0 : $start - $startPosition);
790              my $len = ($stopPosition <= $stop ? $stopPosition : $stop) - $startPosition - $pos1;              my $len1 = ($stopPosition < $stop ? $stopPosition : $stop) + 1 - $startPosition - $pos1;
791                Trace("Position is $pos1 for length $len1.") if T(SDNA => 4);
792              # Add the relevant data to the location data.              # Add the relevant data to the location data.
793              $locationDNA .= substr($sequenceData, $pos1, $len);              $locationDNA .= substr($sequenceData, $pos1, $len1);
794          }          }
795          # 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.
796          if ($dir eq '+') {          if ($dir eq '+') {
797              $retVal .= $locationDNA;              $retVal .= $locationDNA;
798          } else {          } else {
799              $locationDNA = join('', reverse split //, $locationDNA);              $retVal .= FIG::reverse_comp($locationDNA);
             $retVal .= $locationDNA;  
800          }          }
801      }      }
802      # Return the result.      # Return the result.
# Line 824  Line 833 
833      return @retVal;      return @retVal;
834  }  }
835    
836    =head3 GenomeLength
837    
838    C<< my $length = $sprout->GenomeLength($genomeID); >>
839    
840    Return the length of the specified genome in base pairs.
841    
842    =over 4
843    
844    =item genomeID
845    
846    ID of the genome whose base pair count is desired.
847    
848    =item RETURN
849    
850    Returns the number of base pairs in all the contigs of the specified
851    genome.
852    
853    =back
854    
855    =cut
856    
857    sub GenomeLength {
858        # Get the parameters.
859        my ($self, $genomeID) = @_;
860        # Declare the return variable.
861        my $retVal = 0;
862        # Get the genome's contig sequence lengths.
863        my @lens = $self->GetFlat(['HasContig', 'IsMadeUpOf'], 'HasContig(from-link) = ?',
864                           [$genomeID], 'IsMadeUpOf(len)');
865        # Sum the lengths.
866        map { $retVal += $_ } @lens;
867        # Return the result.
868        return $retVal;
869    }
870    
871    =head3 FeatureCount
872    
873    C<< my $count = $sprout->FeatureCount($genomeID, $type); >>
874    
875    Return the number of features of the specified type in the specified genome.
876    
877    =over 4
878    
879    =item genomeID
880    
881    ID of the genome whose feature count is desired.
882    
883    =item type
884    
885    Type of feature to count (eg. C<peg>, C<rna>, etc.).
886    
887    =item RETURN
888    
889    Returns the number of features of the specified type for the specified genome.
890    
891    =back
892    
893    =cut
894    
895    sub FeatureCount {
896        # Get the parameters.
897        my ($self, $genomeID, $type) = @_;
898        # Compute the count.
899        my $retVal = $self->GetCount(['HasFeature', 'Feature'],
900                                    "HasFeature(from-link) = ? AND Feature(feature-type) = ?",
901                                    [$genomeID, $type]);
902        # Return the result.
903        return $retVal;
904    }
905    
906    =head3 GenomeAssignments
907    
908    C<< my $fidHash = $sprout->GenomeAssignments($genomeID); >>
909    
910    Return a list of a genome's assigned features. The return hash will contain each
911    assigned feature of the genome mapped to the text of its most recent functional
912    assignment.
913    
914    =over 4
915    
916    =item genomeID
917    
918    ID of the genome whose functional assignments are desired.
919    
920    =item RETURN
921    
922    Returns a reference to a hash which maps each feature to its most recent
923    functional assignment.
924    
925    =back
926    
927    =cut
928    
929    sub GenomeAssignments {
930        # Get the parameters.
931        my ($self, $genomeID) = @_;
932        # Declare the return variable.
933        my $retVal = {};
934        # Query the genome's features.
935        my $query = $self->Get(['HasFeature', 'Feature'], "HasFeature(from-link) = ?",
936                               [$genomeID]);
937        # Loop through the features.
938        while (my $data = $query->Fetch) {
939            # Get the feature ID and assignment.
940            my ($fid, $assignment) = $data->Values(['Feature(id)', 'Feature(assignment)']);
941            if ($assignment) {
942                $retVal->{$fid} = $assignment;
943            }
944        }
945        # Return the result.
946        return $retVal;
947    }
948    
949  =head3 ContigLength  =head3 ContigLength
950    
951  C<< my $length = $sprout->ContigLength($contigID); >>  C<< my $length = $sprout->ContigLength($contigID); >>
# Line 857  Line 979 
979      # Set it from the sequence data, if any.      # Set it from the sequence data, if any.
980      if ($sequence) {      if ($sequence) {
981          my ($start, $len) = $sequence->Values(['IsMadeUpOf(start-position)', 'IsMadeUpOf(len)']);          my ($start, $len) = $sequence->Values(['IsMadeUpOf(start-position)', 'IsMadeUpOf(len)']);
982          $retVal = $start + $len;          $retVal = $start + $len - 1;
983      }      }
984      # Return the result.      # Return the result.
985      return $retVal;      return $retVal;
986  }  }
987    
988  =head3 GenesInRegion  =head3 ClusterPEGs
989    
990  C<< my (\@featureIDList, $beg, $end) = $sprout->GenesInRegion($contigID, $start, $stop); >>  C<< my $clusteredList = $sprout->ClusterPEGs($sub, \@pegs); >>
991    
992  List the features which overlap a specified region in a contig.  Cluster the PEGs in a list according to the cluster coding scheme of the specified
993    subsystem. In order for this to work properly, the subsystem object must have
994    been used recently to retrieve the PEGs using the B<get_pegs_from_cell> method.
995    This causes the cluster numbers to be pulled into the subsystem's color hash.
996    If a PEG is not found in the color hash, it will not appear in the output
997    sequence.
998    
999  =over 4  =over 4
1000    
1001  =item contigID  =item sub
1002    
1003  ID of the contig containing the region of interest.  Sprout subsystem object for the relevant subsystem, from the L</get_subsystem>
1004    method.
1005    
1006  =item start  =item pegs
1007    
1008  Offset of the first residue in the region of interest.  Reference to the list of PEGs to be clustered.
1009    
1010  =item stop  =item RETURN
1011    
1012    Returns a list of the PEGs, grouped into smaller lists by cluster number.
1013    
1014    =back
1015    
1016    =cut
1017    #: Return Type $@@;
1018    sub ClusterPEGs {
1019        # Get the parameters.
1020        my ($self, $sub, $pegs) = @_;
1021        # Declare the return variable.
1022        my $retVal = [];
1023        # Loop through the PEGs, creating arrays for each cluster.
1024        for my $pegID (@{$pegs}) {
1025            my $clusterNumber = $sub->get_cluster_number($pegID);
1026            # Only proceed if the PEG is in a cluster.
1027            if ($clusterNumber >= 0) {
1028                # Push this PEG onto the sub-list for the specified cluster number.
1029                push @{$retVal->[$clusterNumber]}, $pegID;
1030            }
1031        }
1032        # Return the result.
1033        return $retVal;
1034    }
1035    
1036    =head3 GenesInRegion
1037    
1038    C<< my (\@featureIDList, $beg, $end) = $sprout->GenesInRegion($contigID, $start, $stop); >>
1039    
1040    List the features which overlap a specified region in a contig.
1041    
1042    =over 4
1043    
1044    =item contigID
1045    
1046    ID of the contig containing the region of interest.
1047    
1048    =item start
1049    
1050    Offset of the first residue in the region of interest.
1051    
1052    =item stop
1053    
1054  Offset of the last residue in the region of interest.  Offset of the last residue in the region of interest.
1055    
# Line 1007  Line 1177 
1177    
1178  =head3 FeatureAnnotations  =head3 FeatureAnnotations
1179    
1180  C<< my @descriptors = $sprout->FeatureAnnotations($featureID); >>  C<< my @descriptors = $sprout->FeatureAnnotations($featureID, $rawFlag); >>
1181    
1182  Return the annotations of a feature.  Return the annotations of a feature.
1183    
# Line 1017  Line 1187 
1187    
1188  ID of the feature whose annotations are desired.  ID of the feature whose annotations are desired.
1189    
1190    =item rawFlag
1191    
1192    If TRUE, the annotation timestamps will be returned in raw form; otherwise, they
1193    will be returned in human-readable form.
1194    
1195  =item RETURN  =item RETURN
1196    
1197  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.
1198    
1199  * B<featureID> ID of the relevant feature.  * B<featureID> ID of the relevant feature.
1200    
1201  * B<timeStamp> time the annotation was made, in user-friendly format.  * B<timeStamp> time the annotation was made.
1202    
1203  * B<user> ID of the user who made the annotation  * B<user> ID of the user who made the annotation
1204    
# Line 1035  Line 1210 
1210  #: Return Type @%;  #: Return Type @%;
1211  sub FeatureAnnotations {  sub FeatureAnnotations {
1212      # Get the parameters.      # Get the parameters.
1213      my ($self, $featureID) = @_;      my ($self, $featureID, $rawFlag) = @_;
1214      # 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.
1215      my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],      my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1216                             "IsTargetOfAnnotation(from-link) = ?", [$featureID]);                             "IsTargetOfAnnotation(from-link) = ?", [$featureID]);
# Line 1048  Line 1223 
1223              $annotation->Values(['IsTargetOfAnnotation(from-link)',              $annotation->Values(['IsTargetOfAnnotation(from-link)',
1224                                   'Annotation(time)', 'MadeAnnotation(from-link)',                                   'Annotation(time)', 'MadeAnnotation(from-link)',
1225                                   'Annotation(annotation)']);                                   'Annotation(annotation)']);
1226            # Convert the time, if necessary.
1227            if (! $rawFlag) {
1228                $timeStamp = FriendlyTimestamp($timeStamp);
1229            }
1230          # Assemble them into a hash.          # Assemble them into a hash.
1231          my $annotationHash = { featureID => $featureID,          my $annotationHash = { featureID => $featureID,
1232                                 timeStamp => FriendlyTimestamp($timeStamp),                                 timeStamp => $timeStamp,
1233                                 user => $user, text => $text };                                 user => $user, text => $text };
1234          # Add it to the return list.          # Add it to the return list.
1235          push @retVal, $annotationHash;          push @retVal, $annotationHash;
# Line 1079  Line 1258 
1258    
1259  =item RETURN  =item RETURN
1260    
1261  Returns a hash mapping the functional assignment IDs to user IDs.  Returns a hash mapping the user IDs to functional assignment IDs.
1262    
1263  =back  =back
1264    
# Line 1089  Line 1268 
1268      # Get the parameters.      # Get the parameters.
1269      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
1270      # Get all of the feature's annotations.      # Get all of the feature's annotations.
1271      my @query = $self->GetAll(['IsTargetOfAnnotation', 'Annotation'],      my @query = $self->GetAll(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1272                              "IsTargetOfAnnotation(from-link) = ?",                              "IsTargetOfAnnotation(from-link) = ?",
1273                              [$featureID], ['Annotation(time)', 'Annotation(annotation)']);                              [$featureID], ['Annotation(time)', 'Annotation(annotation)',
1274                                               'MadeAnnotation(from-link)']);
1275      # Declare the return hash.      # Declare the return hash.
1276      my %retVal;      my %retVal;
     # Declare a hash for insuring we only make one assignment per user.  
     my %timeHash = ();  
1277      # Now we sort the assignments by timestamp in reverse.      # Now we sort the assignments by timestamp in reverse.
1278      my @sortedQuery = sort { -($a->[0] <=> $b->[0]) } @query;      my @sortedQuery = sort { -($a->[0] <=> $b->[0]) } @query;
1279      # Loop until we run out of annotations.      # Loop until we run out of annotations.
1280      for my $annotation (@sortedQuery) {      for my $annotation (@sortedQuery) {
1281          # Get the annotation fields.          # Get the annotation fields.
1282          my ($timeStamp, $text) = @{$annotation};          my ($timeStamp, $text, $user) = @{$annotation};
1283          # Check to see if this is a functional assignment.          # Check to see if this is a functional assignment.
1284          my ($user, $function) = _ParseAssignment($text);          my ($actualUser, $function) = _ParseAssignment($user, $text);
1285          if ($user && ! exists $timeHash{$user}) {          if ($actualUser && ! exists $retVal{$actualUser}) {
1286              # Here it is a functional assignment and there has been no              # Here it is a functional assignment and there has been no
1287              # previous assignment for this user, so we stuff it in the              # previous assignment for this user, so we stuff it in the
1288              # return hash.              # return hash.
1289              $retVal{$function} = $user;              $retVal{$actualUser} = $function;
             # Insure we don't assign to this user again.  
             $timeHash{$user} = 1;  
1290          }          }
1291      }      }
1292      # Return the hash of assignments found.      # Return the hash of assignments found.
# Line 1124  Line 1300 
1300  Return the most recently-determined functional assignment of a particular feature.  Return the most recently-determined functional assignment of a particular feature.
1301    
1302  The functional assignment is handled differently depending on the type of feature. If  The functional assignment is handled differently depending on the type of feature. If
1303  the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional  the feature is identified by a FIG ID (begins with the string C<fig|>), then the functional
1304  assignment is a type of annotation. The format of an assignment is described in  assignment is taken from the B<Feature> or C<Annotation> table, depending.
 L</ParseLocation>. Its worth noting that we cannot filter on the content of the  
 annotation itself because it's a text field; however, this is not a big problem because  
 most features only have a small number of annotations.  
1305    
1306  Each user has an associated list of trusted users. The assignment returned will be the most  Each user has an associated list of trusted users. The assignment returned will be the most
1307  recent one by at least one of the trusted users. If no trusted user list is available, then  recent one by at least one of the trusted users. If no trusted user list is available, then
# Line 1147  Line 1320 
1320    
1321  =item userID (optional)  =item userID (optional)
1322    
1323  ID of the user whose function determination is desired. If omitted, only the latest  ID of the user whose function determination is desired. If omitted, the primary
1324  C<FIG> assignment will be returned.  functional assignment in the B<Feature> table will be returned.
1325    
1326  =item RETURN  =item RETURN
1327    
# Line 1165  Line 1338 
1338      my $retVal;      my $retVal;
1339      # Determine the ID type.      # Determine the ID type.
1340      if ($featureID =~ m/^fig\|/) {      if ($featureID =~ m/^fig\|/) {
1341          # Here we have a FIG feature ID. We must build the list of trusted          # Here we have a FIG feature ID.
1342          # users.          if (!$userID) {
1343                # Use the primary assignment.
1344                ($retVal) = $self->GetEntityValues('Feature', $featureID, ['Feature(assignment)']);
1345            } else {
1346                # We must build the list of trusted users.
1347          my %trusteeTable = ();          my %trusteeTable = ();
1348          # Check the user ID.          # Check the user ID.
1349          if (!$userID) {          if (!$userID) {
# Line 1188  Line 1365 
1365              }              }
1366          }          }
1367          # Build a query for all of the feature's annotations, sorted by date.          # Build a query for all of the feature's annotations, sorted by date.
1368          my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation'],              my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1369                                 "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",                                 "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",
1370                                 [$featureID]);                                 [$featureID]);
1371          my $timeSelected = 0;          my $timeSelected = 0;
1372          # Loop until we run out of annotations.          # Loop until we run out of annotations.
1373          while (my $annotation = $query->Fetch()) {          while (my $annotation = $query->Fetch()) {
1374              # Get the annotation text.              # Get the annotation text.
1375              my ($text, $time) = $annotation->Values(['Annotation(annotation)','Annotation(time)']);                  my ($text, $time, $user) = $annotation->Values(['Annotation(annotation)',
1376                                                             'Annotation(time)', 'MadeAnnotation(from-link)']);
1377              # Check to see if this is a functional assignment for a trusted user.              # Check to see if this is a functional assignment for a trusted user.
1378              my ($user, $function) = _ParseAssignment($text);                  my ($actualUser, $function) = _ParseAssignment($user, $text);
1379              if ($user) {                  Trace("Assignment user is $actualUser, text is $function.") if T(4);
1380                    if ($actualUser) {
1381                  # Here it is a functional assignment. Check the time and the user                  # Here it is a functional assignment. Check the time and the user
1382                  # name. The time must be recent and the user must be trusted.                  # name. The time must be recent and the user must be trusted.
1383                  if ((exists $trusteeTable{$user}) && ($time > $timeSelected)) {                      if ((exists $trusteeTable{$actualUser}) && ($time > $timeSelected)) {
1384                      $retVal = $function;                      $retVal = $function;
1385                      $timeSelected = $time;                      $timeSelected = $time;
1386                  }                  }
1387              }              }
1388          }          }
1389            }
1390      } else {      } else {
1391          # Here we have a non-FIG feature ID. In this case the user ID does not          # Here we have a non-FIG feature ID. In this case the user ID does not
1392          # matter. We simply get the information from the External Alias Function          # matter. We simply get the information from the External Alias Function
# Line 1217  Line 1397 
1397      return $retVal;      return $retVal;
1398  }  }
1399    
1400    =head3 FunctionsOf
1401    
1402    C<< my @functionList = $sprout->FunctionOf($featureID, $userID); >>
1403    
1404    Return the functional assignments of a particular feature.
1405    
1406    The functional assignment is handled differently depending on the type of feature. If
1407    the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional
1408    assignment is a type of annotation. The format of an assignment is described in
1409    L</ParseAssignment>. Its worth noting that we cannot filter on the content of the
1410    annotation itself because it's a text field; however, this is not a big problem because
1411    most features only have a small number of annotations.
1412    
1413    If the feature is B<not> identified by a FIG ID, then the functional assignment
1414    information is taken from the B<ExternalAliasFunc> table. If the table does
1415    not contain an entry for the feature, an empty list is returned.
1416    
1417    =over 4
1418    
1419    =item featureID
1420    
1421    ID of the feature whose functional assignments are desired.
1422    
1423    =item RETURN
1424    
1425    Returns a list of 2-tuples, each consisting of a user ID and the text of an assignment by
1426    that user.
1427    
1428    =back
1429    
1430    =cut
1431    #: Return Type @@;
1432    sub FunctionsOf {
1433        # Get the parameters.
1434        my ($self, $featureID) = @_;
1435        # Declare the return value.
1436        my @retVal = ();
1437        # Determine the ID type.
1438        if ($featureID =~ m/^fig\|/) {
1439            # Here we have a FIG feature ID. We must build the list of trusted
1440            # users.
1441            my %trusteeTable = ();
1442            # Build a query for all of the feature's annotations, sorted by date.
1443            my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1444                                   "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",
1445                                   [$featureID]);
1446            my $timeSelected = 0;
1447            # Loop until we run out of annotations.
1448            while (my $annotation = $query->Fetch()) {
1449                # Get the annotation text.
1450                my ($text, $time, $user) = $annotation->Values(['Annotation(annotation)',
1451                                                                'Annotation(time)',
1452                                                                'MadeAnnotation(user)']);
1453                # Check to see if this is a functional assignment for a trusted user.
1454                my ($actualUser, $function) = _ParseAssignment($user, $text);
1455                if ($actualUser) {
1456                    # Here it is a functional assignment.
1457                    push @retVal, [$actualUser, $function];
1458                }
1459            }
1460        } else {
1461            # Here we have a non-FIG feature ID. In this case the user ID does not
1462            # matter. We simply get the information from the External Alias Function
1463            # table.
1464            my @assignments = $self->GetEntityValues('ExternalAliasFunc', $featureID,
1465                                                     ['ExternalAliasFunc(func)']);
1466            push @retVal, map { ['master', $_] } @assignments;
1467        }
1468        # Return the assignments found.
1469        return @retVal;
1470    }
1471    
1472  =head3 BBHList  =head3 BBHList
1473    
1474  C<< my $bbhHash = $sprout->BBHList($genomeID, \@featureList); >>  C<< my $bbhHash = $sprout->BBHList($genomeID, \@featureList); >>
# Line 1250  Line 1502 
1502      my %retVal = ();      my %retVal = ();
1503      # Loop through the incoming features.      # Loop through the incoming features.
1504      for my $featureID (@{$featureList}) {      for my $featureID (@{$featureList}) {
1505          # Create a query to get the feature's best hit.          # Ask the server for the feature's best hit.
1506          my $query = $self->Get(['IsBidirectionalBestHitOf'],          my @bbhData = FIGRules::BBHData($featureID);
1507                                 "IsBidirectionalBestHitOf(from-link) = ? AND IsBidirectionalBestHitOf(genome) = ?",          # Peel off the BBHs found.
1508                                 [$featureID, $genomeID]);          my @found = ();
1509          # Look for the best hit.          for my $bbh (@bbhData) {
1510          my $bbh = $query->Fetch;              my $fid = $bbh->[0];
1511          if ($bbh) {              my $bbGenome = $self->GenomeOf($fid);
1512              my ($targetFeature) = $bbh->Value('IsBidirectionalBestHitOf(to-link)');              if ($bbGenome eq $genomeID) {
1513              $retVal{$featureID} = $targetFeature;                  push @found, $fid;
1514                }
1515          }          }
1516            $retVal{$featureID} = \@found;
1517      }      }
1518      # Return the mapping.      # Return the mapping.
1519      return \%retVal;      return \%retVal;
# Line 1271  Line 1525 
1525    
1526  Return a list of the similarities to the specified feature.  Return a list of the similarities to the specified feature.
1527    
1528  Sprout does not support real similarities, so this method just returns the bidirectional  This method just returns the bidirectional best hits for performance reasons.
 best hits.  
1529    
1530  =over 4  =over 4
1531    
# Line 1292  Line 1545 
1545      # Get the parameters.      # Get the parameters.
1546      my ($self, $featureID, $count) = @_;      my ($self, $featureID, $count) = @_;
1547      # Ask for the best hits.      # Ask for the best hits.
1548      my @lists = $self->GetAll(['IsBidirectionalBestHitOf'],      my @lists = FIGRules::BBHData($featureID);
                               "IsBidirectionalBestHitOf(from-link) = ? ORDER BY IsBidirectionalBestHitOf(score) DESC",  
                               [$featureID], ['IsBidirectionalBestHitOf(to-link)', 'IsBidirectionalBestHitOf(score)'],  
                               $count);  
1549      # Create the return value.      # Create the return value.
1550      my %retVal = ();      my %retVal = ();
1551      for my $tuple (@lists) {      for my $tuple (@lists) {
# Line 1305  Line 1555 
1555      return %retVal;      return %retVal;
1556  }  }
1557    
   
   
1558  =head3 IsComplete  =head3 IsComplete
1559    
1560  C<< my $flag = $sprout->IsComplete($genomeID); >>  C<< my $flag = $sprout->IsComplete($genomeID); >>
# Line 1337  Line 1585 
1585      my $genomeData = $self->GetEntity('Genome', $genomeID);      my $genomeData = $self->GetEntity('Genome', $genomeID);
1586      if ($genomeData) {      if ($genomeData) {
1587          # The genome exists, so get the completeness flag.          # The genome exists, so get the completeness flag.
1588          ($retVal) = $genomeData->Value('complete');          ($retVal) = $genomeData->Value('Genome(complete)');
1589      }      }
1590      # Return the result.      # Return the result.
1591      return $retVal;      return $retVal;
# Line 1377  Line 1625 
1625    
1626  C<< my $genomeID = $sprout->GenomeOf($featureID); >>  C<< my $genomeID = $sprout->GenomeOf($featureID); >>
1627    
1628  Return the genome that contains a specified feature.  Return the genome that contains a specified feature or contig.
1629    
1630  =over 4  =over 4
1631    
1632  =item featureID  =item featureID
1633    
1634  ID of the feature whose genome is desired.  ID of the feature or contig whose genome is desired.
1635    
1636  =item RETURN  =item RETURN
1637    
1638  Returns the ID of the genome for the specified feature. If the feature is not found, returns  Returns the ID of the genome for the specified feature or contig. If the feature or contig is not
1639  an undefined value.  found, returns an undefined value.
1640    
1641  =back  =back
1642    
# Line 1397  Line 1645 
1645  sub GenomeOf {  sub GenomeOf {
1646      # Get the parameters.      # Get the parameters.
1647      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
1648      # Create a query to find the genome associated with the feature.      # Create a query to find the genome associated with the incoming ID.
1649      my $query = $self->Get(['IsLocatedIn', 'HasContig'], "IsLocatedIn(from-link) = ?", [$featureID]);      my $query = $self->Get(['IsLocatedIn', 'HasContig'], "IsLocatedIn(from-link) = ? OR HasContig(to-link) = ?",
1650                               [$featureID, $featureID]);
1651      # Declare the return value.      # Declare the return value.
1652      my $retVal;      my $retVal;
1653      # Get the genome ID.      # Get the genome ID.
# Line 1433  Line 1682 
1682  sub CoupledFeatures {  sub CoupledFeatures {
1683      # Get the parameters.      # Get the parameters.
1684      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
1685        Trace("Looking for features coupled to $featureID.") if T(coupling => 3);
1686      # Create a query to retrieve the functionally-coupled features.      # Create a query to retrieve the functionally-coupled features.
1687      my $query = $self->Get(['ParticipatesInCoupling', 'Coupling'],      my $query = $self->Get(['ParticipatesInCoupling', 'Coupling'],
1688                             "ParticipatesInCoupling(from-link) = ?", [$featureID]);                             "ParticipatesInCoupling(from-link) = ?", [$featureID]);
# Line 1445  Line 1695 
1695          # Get the ID and score of the coupling.          # Get the ID and score of the coupling.
1696          my ($couplingID, $score) = $clustering->Values(['Coupling(id)',          my ($couplingID, $score) = $clustering->Values(['Coupling(id)',
1697                                                          'Coupling(score)']);                                                          'Coupling(score)']);
1698          # The coupling ID contains the two feature IDs separated by a space. We use          Trace("$featureID coupled with score $score to ID $couplingID.") if T(coupling => 4);
1699          # this information to find the ID of the other feature.          # Get the other feature that participates in the coupling.
1700          my ($fid1, $fid2) = split / /, $couplingID;          my ($otherFeatureID) = $self->GetFlat(['ParticipatesInCoupling'],
1701          my $otherFeatureID = ($featureID eq $fid1 ? $fid2 : $fid1);                                             "ParticipatesInCoupling(to-link) = ? AND ParticipatesInCoupling(from-link) <> ?",
1702                                               [$couplingID, $featureID], 'ParticipatesInCoupling(from-link)');
1703            Trace("$couplingID target feature is $otherFeatureID.") if T(coupling => 4);
1704          # Attach the other feature's score to its ID.          # Attach the other feature's score to its ID.
1705          $retVal{$otherFeatureID} = $score;          $retVal{$otherFeatureID} = $score;
1706          $found = 1;          $found = 1;
# Line 1521  Line 1773 
1773          # Determine the ordering to place on the evidence items. If we're          # Determine the ordering to place on the evidence items. If we're
1774          # inverted, we want to see feature 2 before feature 1 (descending); otherwise,          # inverted, we want to see feature 2 before feature 1 (descending); otherwise,
1775          # we want feature 1 before feature 2 (normal).          # we want feature 1 before feature 2 (normal).
1776            Trace("Coupling evidence for ($peg1, $peg2) with inversion flag $inverted.") if T(Coupling => 4);
1777          my $ordering = ($inverted ? "DESC" : "");          my $ordering = ($inverted ? "DESC" : "");
1778          # Get the coupling evidence.          # Get the coupling evidence.
1779          my @evidenceList = $self->GetAll(['IsEvidencedBy', 'PCH', 'UsesAsEvidence'],          my @evidenceList = $self->GetAll(['IsEvidencedBy', 'PCH', 'UsesAsEvidence'],
# Line 1534  Line 1787 
1787          while (@evidenceList > 0) {          while (@evidenceList > 0) {
1788              my $peg1Data = shift @evidenceList;              my $peg1Data = shift @evidenceList;
1789              my $peg2Data = shift @evidenceList;              my $peg2Data = shift @evidenceList;
1790                Trace("Peg 1 is " . $peg1Data->[1] . " and Peg 2 is " . $peg2Data->[1] . ".") if T(Coupling => 4);
1791              push @retVal, [$peg1Data->[1], $peg2Data->[1], $peg1Data->[0]];              push @retVal, [$peg1Data->[1], $peg2Data->[1], $peg1Data->[0]];
1792          }          }
1793            Trace("Last index in evidence result is is $#retVal.") if T(Coupling => 4);
1794      }      }
1795      # Return the result.      # Return the result.
1796      return @retVal;      return @retVal;
# Line 1578  Line 1833 
1833      my ($self, $peg1, $peg2) = @_;      my ($self, $peg1, $peg2) = @_;
1834      # Declare the return values. We'll start with the coupling ID and undefine the      # Declare the return values. We'll start with the coupling ID and undefine the
1835      # flag and score until we have more information.      # flag and score until we have more information.
1836      my ($retVal, $inverted, $score) = (CouplingID($peg1, $peg2), undef, undef);      my ($retVal, $inverted, $score) = ($self->CouplingID($peg1, $peg2), undef, undef);
1837      # Find the coupling data.      # Find the coupling data.
1838      my @pegs = $self->GetAll(['Coupling', 'ParticipatesInCoupling'],      my @pegs = $self->GetAll(['Coupling', 'ParticipatesInCoupling'],
1839                                   "Coupling(id) = ? ORDER BY ParticipatesInCoupling(pos)",                                   "Coupling(id) = ? ORDER BY ParticipatesInCoupling(pos)",
1840                                   [$retVal], ["ParticipatesInCoupling(from-link)", "Coupling(score)"]);                                   [$retVal], ["ParticipatesInCoupling(from-link)", "Coupling(score)"]);
1841      # Check to see if we found anything.      # Check to see if we found anything.
1842      if (!@pegs) {      if (!@pegs) {
1843            Trace("No coupling found.") if T(Coupling => 4);
1844          # No coupling, so undefine the return value.          # No coupling, so undefine the return value.
1845          $retVal = undef;          $retVal = undef;
1846      } else {      } else {
1847          # We have a coupling! Get the score and check for inversion.          # We have a coupling! Get the score and check for inversion.
1848          $score = $pegs[0]->[1];          $score = $pegs[0]->[1];
1849          $inverted = ($pegs[0]->[0] eq $peg1);          my $firstFound = $pegs[0]->[0];
1850            $inverted = ($firstFound ne $peg1);
1851            Trace("Coupling score is $score. First peg is $firstFound, peg 1 is $peg1.") if T(Coupling => 4);
1852      }      }
1853      # Return the result.      # Return the result.
1854      return ($retVal, $inverted, $score);      return ($retVal, $inverted, $score);
1855  }  }
1856    
1857    =head3 GetSynonymGroup
1858    
1859    C<< my $id = $sprout->GetSynonymGroup($fid); >>
1860    
1861    Return the synonym group name for the specified feature.
1862    
1863    =over 4
1864    
1865    =item fid
1866    
1867    ID of the feature whose synonym group is desired.
1868    
1869    =item RETURN
1870    
1871    The name of the synonym group to which the feature belongs. If the feature does
1872    not belong to a synonym group, the feature ID itself is returned.
1873    
1874    =back
1875    
1876    =cut
1877    
1878    sub GetSynonymGroup {
1879        # Get the parameters.
1880        my ($self, $fid) = @_;
1881        # Declare the return variable.
1882        my $retVal;
1883        # Find the synonym group.
1884        my @groups = $self->GetFlat(['IsSynonymGroupFor'], "IsSynonymGroupFor(to-link) = ?",
1885                                       [$fid], 'IsSynonymGroupFor(from-link)');
1886        # Check to see if we found anything.
1887        if (@groups) {
1888            $retVal = $groups[0];
1889        } else {
1890            $retVal = $fid;
1891        }
1892        # Return the result.
1893        return $retVal;
1894    }
1895    
1896    =head3 GetBoundaries
1897    
1898    C<< my ($contig, $beg, $end) = $sprout->GetBoundaries(@locList); >>
1899    
1900    Determine the begin and end boundaries for the locations in a list. All of the
1901    locations must belong to the same contig and have mostly the same direction in
1902    order for this method to produce a meaningful result. The resulting
1903    begin/end pair will contain all of the bases in any of the locations.
1904    
1905    =over 4
1906    
1907    =item locList
1908    
1909    List of locations to process.
1910    
1911    =item RETURN
1912    
1913    Returns a 3-tuple consisting of the contig ID, the beginning boundary,
1914    and the ending boundary. The beginning boundary will be left of the
1915    end for mostly-forward locations and right of the end for mostly-backward
1916    locations.
1917    
1918    =back
1919    
1920    =cut
1921    
1922    sub GetBoundaries {
1923        # Get the parameters.
1924        my ($self, @locList) = @_;
1925        # Set up the counters used to determine the most popular direction.
1926        my %counts = ( '+' => 0, '-' => 0 );
1927        # Get the last location and parse it.
1928        my $locObject = BasicLocation->new(pop @locList);
1929        # Prime the loop with its data.
1930        my ($contig, $beg, $end) = ($locObject->Contig, $locObject->Left, $locObject->Right);
1931        # Count its direction.
1932        $counts{$locObject->Dir}++;
1933        # Loop through the remaining locations. Note that in most situations, this loop
1934        # will not iterate at all, because most of the time we will be dealing with a
1935        # singleton list.
1936        for my $loc (@locList) {
1937            # Create a location object.
1938            my $locObject = BasicLocation->new($loc);
1939            # Count the direction.
1940            $counts{$locObject->Dir}++;
1941            # Get the left end and the right end.
1942            my $left = $locObject->Left;
1943            my $right = $locObject->Right;
1944            # Merge them into the return variables.
1945            if ($left < $beg) {
1946                $beg = $left;
1947            }
1948            if ($right > $end) {
1949                $end = $right;
1950            }
1951        }
1952        # If the most common direction is reverse, flip the begin and end markers.
1953        if ($counts{'-'} > $counts{'+'}) {
1954            ($beg, $end) = ($end, $beg);
1955        }
1956        # Return the result.
1957        return ($contig, $beg, $end);
1958    }
1959    
1960  =head3 CouplingID  =head3 CouplingID
1961    
1962  C<< my $couplingID = Sprout::CouplingID($peg1, $peg2); >>  C<< my $couplingID = $sprout->CouplingID($peg1, $peg2); >>
1963    
1964  Return the coupling ID for a pair of feature IDs.  Return the coupling ID for a pair of feature IDs.
1965    
# Line 1631  Line 1992 
1992  =cut  =cut
1993  #: Return Type $;  #: Return Type $;
1994  sub CouplingID {  sub CouplingID {
1995      return join " ", sort @_;      my ($self, @pegs) = @_;
1996  }      return $self->DigestKey(join " ", sort @pegs);
   
 =head3 GetEntityTypes  
   
 C<< my @entityList = $sprout->GetEntityTypes(); >>  
   
 Return the list of supported entity types.  
   
 =cut  
 #: Return Type @;  
 sub GetEntityTypes {  
     # Get the parameters.  
     my ($self) = @_;  
     # Get the underlying database object.  
     my $erdb = $self->{_erdb};  
     # Get its entity type list.  
     my @retVal = $erdb->GetEntityTypes();  
1997  }  }
1998    
1999  =head3 ReadFasta  =head3 ReadFasta
# Line 1695  Line 2040 
2040          if ($line =~ m/^>\s*(.+?)(\s|\n)/) {          if ($line =~ m/^>\s*(.+?)(\s|\n)/) {
2041              # 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.
2042              if ($id) {              if ($id) {
2043                  $retVal{$id} = uc $sequence;                  $retVal{$id} = lc $sequence;
2044              }              }
2045              # Clear the sequence accumulator and save the new ID.              # Clear the sequence accumulator and save the new ID.
2046              ($id, $sequence) = ("$prefix$1", "");              ($id, $sequence) = ("$prefix$1", "");
2047          } else {          } else {
2048              # 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.
2049              # First, we get the actual data out. Note that we normalize to upper              # First, we get the actual data out. Note that we normalize to lower
2050              # case.              # case.
2051              $line =~ /^\s*(.*?)(\s|\n)/;              $line =~ /^\s*(.*?)(\s|\n)/;
2052              $sequence .= $1;              $sequence .= $1;
# Line 1709  Line 2054 
2054      }      }
2055      # Flush out the last sequence (if any).      # Flush out the last sequence (if any).
2056      if ($sequence) {      if ($sequence) {
2057          $retVal{$id} = uc $sequence;          $retVal{$id} = lc $sequence;
2058      }      }
2059      # Close the file.      # Close the file.
2060      close FASTAFILE;      close FASTAFILE;
# Line 1796  Line 2141 
2141      # Get the data directory name.      # Get the data directory name.
2142      my $outputDirectory = $self->{_options}->{dataDir};      my $outputDirectory = $self->{_options}->{dataDir};
2143      # Dump the relations.      # Dump the relations.
2144      $self->{_erdb}->DumpRelations($outputDirectory);      $self->DumpRelations($outputDirectory);
2145  }  }
2146    
2147  =head3 XMLFileName  =head3 XMLFileName
# Line 1848  Line 2193 
2193      # Get the parameters.      # Get the parameters.
2194      my ($self, $objectType, $fieldHash) = @_;      my ($self, $objectType, $fieldHash) = @_;
2195      # Call the underlying method.      # Call the underlying method.
2196      $self->{_erdb}->InsertObject($objectType, $fieldHash);      $self->InsertObject($objectType, $fieldHash);
2197  }  }
2198    
2199  =head3 Annotate  =head3 Annotate
# Line 2007  Line 2352 
2352      return @retVal;      return @retVal;
2353  }  }
2354    
 =head3 Exists  
   
 C<< my $found = $sprout->Exists($entityName, $entityID); >>  
   
 Return TRUE if an entity exists, else FALSE.  
   
 =over 4  
   
 =item entityName  
   
 Name of the entity type (e.g. C<Feature>) relevant to the existence check.  
   
 =item entityID  
   
 ID of the entity instance whose existence is to be checked.  
   
 =item RETURN  
   
 Returns TRUE if the entity instance exists, else FALSE.  
   
 =back  
   
 =cut  
 #: Return Type $;  
 sub Exists {  
     # Get the parameters.  
     my ($self, $entityName, $entityID) = @_;  
     # Check for the entity instance.  
     my $testInstance = $self->GetEntity($entityName, $entityID);  
     # Return an existence indicator.  
     my $retVal = ($testInstance ? 1 : 0);  
     return $retVal;  
 }  
   
2355  =head3 FeatureTranslation  =head3 FeatureTranslation
2356    
2357  C<< my $translation = $sprout->FeatureTranslation($featureID); >>  C<< my $translation = $sprout->FeatureTranslation($featureID); >>
# Line 2232  Line 2543 
2543    
2544  Return a list of the properties with the specified characteristics.  Return a list of the properties with the specified characteristics.
2545    
2546  Properties are arbitrary key-value pairs associated with a feature. (At some point they  Properties are the Sprout analog of the FIG attributes. The call is
2547  will also be associated with genomes.) A property value is represented by a 4-tuple of  passed directly to the CustomAttributes or RemoteCustomAttributes object
2548  the form B<($fid, $key, $value, $url)>. These exactly correspond to the parameter  contained in this object.
2549    
2550  =over 4  This method returns a series of tuples that match the specified criteria. Each tuple
2551    will contain an object ID, a key, and one or more values. The parameters to this
2552    method therefore correspond structurally to the values expected in each tuple. In
2553    addition, you can ask for a generic search by suffixing a percent sign (C<%>) to any
2554    of the parameters. So, for example,
2555    
2556  =item fid      my @attributeList = $sprout->GetProperties('fig|100226.1.peg.1004', 'structure%', 1, 2);
2557    
2558  ID of the feature possessing the property.  would return something like
2559    
2560  =item key      ['fig}100226.1.peg.1004', 'structure', 1, 2]
2561        ['fig}100226.1.peg.1004', 'structure1', 1, 2]
2562        ['fig}100226.1.peg.1004', 'structure2', 1, 2]
2563        ['fig}100226.1.peg.1004', 'structureA', 1, 2]
2564    
2565  Name or key of the property.  Use of C<undef> in any position acts as a wild card (all values). You can also specify
2566    a list reference in the ID column. Thus,
2567    
2568  =item value      my @attributeList = $sprout->GetProperties(['100226.1', 'fig|100226.1.%'], 'PUBMED');
2569    
2570  Value of the property.  would get the PUBMED attribute data for Streptomyces coelicolor A3(2) and all its
2571    features.
2572    
2573  =item url  In addition to values in multiple sections, a single attribute key can have multiple
2574    values, so even
2575    
2576  URL of the document that indicated the property should have this particular value, or an      my @attributeList = $sprout->GetProperties($peg, 'virulent');
 empty string if no such document exists.  
2577    
2578  =back  which has no wildcard in the key or the object ID, may return multiple tuples.
2579    
2580    =over 4
2581    
2582    =item objectID
2583    
2584    ID of object whose attributes are desired. If the attributes are desired for multiple
2585    objects, this parameter can be specified as a list reference. If the attributes are
2586    desired for all objects, specify C<undef> or an empty string. Finally, you can specify
2587    attributes for a range of object IDs by putting a percent sign (C<%>) at the end.
2588    
2589  The parameters act as a filter for the desired data. Any non-null parameter will  =item key
 automatically match all the tuples returned. So, specifying just the I<$fid> will  
 return all the properties of the specified feature; similarly, specifying the I<$key>  
 and I<$value> parameters will return all the features having the specified property  
 value.  
2590    
2591  A single property key can have many values, representing different ideas about the  Attribute key name. A value of C<undef> or an empty string will match all
2592  feature in question. For example, one paper may declare that a feature C<fig|83333.1.peg.10> is  attribute keys. If the values are desired for multiple keys, this parameter can be
2593  virulent, and another may declare that it is not virulent. A query about the virulence of  specified as a list reference. Finally, you can specify attributes for a range of
2594  C<fig|83333.1.peg.10> would be coded as  keys by putting a percent sign (C<%>) at the end.
2595    
2596    =item values
2597    
2598    List of the desired attribute values, section by section. If C<undef>
2599    or an empty string is specified, all values in that section will match. A
2600    generic match can be requested by placing a percent sign (C<%>) at the end.
2601    In that case, all values that match up to and not including the percent sign
2602    will match. You may also specify a regular expression enclosed
2603    in slashes. All values that match the regular expression will be returned. For
2604    performance reasons, only values have this extra capability.
2605    
2606      my @list = $sprout->GetProperties('fig|83333.1.peg.10', 'virulence', '', '');  =item RETURN
2607    
2608  Here the I<$value> and I<$url> fields are left blank, indicating that those fields are  Returns a list of tuples. The first element in the tuple is an object ID, the
2609  not to be filtered. The tuples returned would be  second is an attribute key, and the remaining elements are the sections of
2610    the attribute value. All of the tuples will match the criteria set forth in
2611    the parameter list.
2612    
2613      ('fig|83333.1.peg.10', 'virulence', 'yes', 'http://www.somewhere.edu/first.paper.pdf')  =back
     ('fig|83333.1.peg.10', 'virulence', 'no', 'http://www.somewhere.edu/second.paper.pdf')  
2614    
2615  =cut  =cut
2616  #: Return Type @@;  
2617  sub GetProperties {  sub GetProperties {
2618      # Get the parameters.      # Get the parameters.
2619      my ($self, @parms) = @_;      my ($self, @parms) = @_;
2620      # Declare the return variable.      # Declare the return variable.
2621      my @retVal = ();      my @retVal = $self->{_ca}->GetAttributes(@parms);
     # Now we need to create a WHERE clause that will get us the data we want. First,  
     # we create a list of the columns containing the data for each parameter.  
     my @colNames = ('HasProperty(from-link)', 'Property(property-name)',  
                     'Property(property-value)', 'HasProperty(evidence)');  
     # Now we build the WHERE clause and the list of parameter values.  
     my @where = ();  
     my @values = ();  
     for (my $i = 0; $i <= $#colNames; $i++) {  
         my $parm = $parms[$i];  
         if (defined $parm && ($parm ne '')) {  
             push @where, "$colNames[$i] = ?";  
             push @values, $parm;  
         }  
     }  
     # Format the WHERE clause.  
     my $filter = (@values > 0 ? (join " AND ", @where) : undef);  
     # Ask for all the propertie values with the desired characteristics.  
     my $query = $self->Get(['HasProperty', 'Property'], $filter, \@values);  
     while (my $valueObject = $query->Fetch()) {  
         my @tuple = $valueObject->Values(\@colNames);  
         push @retVal, \@tuple;  
     }  
2622      # Return the result.      # Return the result.
2623      return @retVal;      return @retVal;
2624  }  }
# Line 2317  Line 2631 
2631  that specify special characteristics of the feature. For example, a property could indicate  that specify special characteristics of the feature. For example, a property could indicate
2632  that a feature is essential to the survival of the organism or that it has benign influence  that a feature is essential to the survival of the organism or that it has benign influence
2633  on the activities of a pathogen. Each property is returned as a triple of the form  on the activities of a pathogen. Each property is returned as a triple of the form
2634  C<($key,$value,$url)>, where C<$key> is the property name, C<$value> is its value (commonly  C<($key,@values)>, where C<$key> is the property name and  C<@values> are its values.
 a 1 or a 0, but possibly a string or a floating-point value), and C<$url> is a string describing  
 the web address or citation in which the property's value for the feature was identified.  
2635    
2636  =over 4  =over 4
2637    
# Line 2329  Line 2641 
2641    
2642  =item RETURN  =item RETURN
2643    
2644  Returns a list of triples, each triple containing the property name, its value, and a URL or  Returns a list of tuples, each tuple containing the property name and its values.
 citation.  
2645    
2646  =back  =back
2647    
# Line 2340  Line 2651 
2651      # Get the parameters.      # Get the parameters.
2652      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
2653      # Get the properties.      # Get the properties.
2654      my @retVal = $self->GetAll(['HasProperty', 'Property'], "HasProperty(from-link) = ?", [$featureID],      my @attributes = $self->{_ca}->GetAttributes($featureID);
2655                              ['Property(property-name)', 'Property(property-value)',      # Strip the feature ID off each tuple.
2656                               'HasProperty(evidence)']);      my @retVal = ();
2657        for my $attributeRow (@attributes) {
2658            shift @{$attributeRow};
2659            push @retVal, $attributeRow;
2660        }
2661      # Return the resulting list.      # Return the resulting list.
2662      return @retVal;      return @retVal;
2663  }  }
# Line 2375  Line 2690 
2690      return $retVal;      return $retVal;
2691  }  }
2692    
2693    =head3 PropertyID
2694    
2695    C<< my $id = $sprout->PropertyID($propName, $propValue); >>
2696    
2697    Return the ID of the specified property name and value pair, if the
2698    pair exists. Only a small subset of the FIG attributes are stored as
2699    Sprout properties, mostly for use in search optimization.
2700    
2701    =over 4
2702    
2703    =item propName
2704    
2705    Name of the desired property.
2706    
2707    =item propValue
2708    
2709    Value expected for the desired property.
2710    
2711    =item RETURN
2712    
2713    Returns the ID of the name/value pair, or C<undef> if the pair does not exist.
2714    
2715    =back
2716    
2717    =cut
2718    
2719    sub PropertyID {
2720        # Get the parameters.
2721        my ($self, $propName, $propValue) = @_;
2722        # Try to find the ID.
2723        my ($retVal) = $self->GetFlat(['Property'],
2724                                      "Property(property-name) = ? AND Property(property-value) = ?",
2725                                      [$propName, $propValue], 'Property(id)');
2726        # Return the result.
2727        return $retVal;
2728    }
2729    
2730  =head3 MergedAnnotations  =head3 MergedAnnotations
2731    
2732  C<< my @annotationList = $sprout->MergedAnnotations(\@list); >>  C<< my @annotationList = $sprout->MergedAnnotations(\@list); >>
# Line 2503  Line 2855 
2855  C<< my %subsystems = $sprout->SubsystemsOf($featureID); >>  C<< my %subsystems = $sprout->SubsystemsOf($featureID); >>
2856    
2857  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
2858  to the role the feature performs.  to the roles the feature performs.
2859    
2860  =over 4  =over 4
2861    
# Line 2513  Line 2865 
2865    
2866  =item RETURN  =item RETURN
2867    
2868  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.
2869    
2870  =back  =back
2871    
2872  =cut  =cut
2873  #: Return Type %;  #: Return Type %@;
2874  sub SubsystemsOf {  sub SubsystemsOf {
2875      # Get the parameters.      # Get the parameters.
2876      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
# Line 2528  Line 2880 
2880                                      ['HasSSCell(from-link)', 'IsRoleOf(from-link)']);                                      ['HasSSCell(from-link)', 'IsRoleOf(from-link)']);
2881      # Create the return value.      # Create the return value.
2882      my %retVal = ();      my %retVal = ();
2883        # Build a hash to weed out duplicates. Sometimes the same PEG and role appears
2884        # in two spreadsheet cells.
2885        my %dupHash = ();
2886      # Loop through the results, adding them to the hash.      # Loop through the results, adding them to the hash.
2887      for my $record (@subsystems) {      for my $record (@subsystems) {
2888          $retVal{$record->[0]} = $record->[1];          # Get this subsystem and role.
2889            my ($subsys, $role) = @{$record};
2890            # Insure it's the first time for both.
2891            my $dupKey = "$subsys\n$role";
2892            if (! exists $dupHash{"$subsys\n$role"}) {
2893                $dupHash{$dupKey} = 1;
2894                push @{$retVal{$subsys}}, $role;
2895            }
2896      }      }
2897      # Return the hash.      # Return the hash.
2898      return %retVal;      return %retVal;
# Line 2562  Line 2924 
2924      # Get the parameters.      # Get the parameters.
2925      my ($self, $featureID) = @_;      my ($self, $featureID) = @_;
2926      # Get the list of names.      # Get the list of names.
2927      my @retVal = $self->GetFlat(['ContainsFeature', 'HasSSCell'], "ContainsFeature(to-link) = ?",      my @retVal = $self->GetFlat(['HasRoleInSubsystem'], "HasRoleInSubsystem(from-link) = ?",
2928                                  [$featureID], 'HasSSCell(from-link)');                                  [$featureID], 'HasRoleInSubsystem(to-link)');
2929        # Return the result, sorted.
2930        return sort @retVal;
2931    }
2932    
2933    =head3 GenomeSubsystemData
2934    
2935    C<< my %featureData = $sprout->GenomeSubsystemData($genomeID); >>
2936    
2937    Return a hash mapping genome features to their subsystem roles.
2938    
2939    =over 4
2940    
2941    =item genomeID
2942    
2943    ID of the genome whose subsystem feature map is desired.
2944    
2945    =item RETURN
2946    
2947    Returns a hash mapping each feature of the genome to a list of 2-tuples. Eacb
2948    2-tuple contains a subsystem name followed by a role ID.
2949    
2950    =back
2951    
2952    =cut
2953    
2954    sub GenomeSubsystemData {
2955        # Get the parameters.
2956        my ($self, $genomeID) = @_;
2957        # Declare the return variable.
2958        my %retVal = ();
2959        # Get a list of the genome features that participate in subsystems. For each
2960        # feature we get its spreadsheet cells and the corresponding roles.
2961        my @roleData = $self->GetAll(['HasFeature', 'ContainsFeature', 'IsRoleOf'],
2962                                 "HasFeature(from-link) = ?", [$genomeID],
2963                                 ['HasFeature(to-link)', 'IsRoleOf(to-link)', 'IsRoleOf(from-link)']);
2964        # Now we get a list of the spreadsheet cells and their associated subsystems. Subsystems
2965        # with an unknown variant code (-1) are skipped. Note the genome ID is at both ends of the
2966        # list. We use it at the beginning to get all the spreadsheet cells for the genome and
2967        # again at the end to filter out participation in subsystems with a negative variant code.
2968        my @cellData = $self->GetAll(['IsGenomeOf', 'HasSSCell', 'ParticipatesIn'],
2969                                     "IsGenomeOf(from-link) = ? AND ParticipatesIn(variant-code) >= 0 AND ParticipatesIn(from-link) = ?",
2970                                     [$genomeID, $genomeID], ['HasSSCell(to-link)', 'HasSSCell(from-link)']);
2971        # Now "@roleData" lists the spreadsheet cell and role for each of the genome's features.
2972        # "@cellData" lists the subsystem name for each of the genome's spreadsheet cells. We
2973        # link these two lists together to create the result. First, we want a hash mapping
2974        # spreadsheet cells to subsystem names.
2975        my %subHash = map { $_->[0] => $_->[1] } @cellData;
2976        # We loop through @cellData to build the hash.
2977        for my $roleEntry (@roleData) {
2978            # Get the data for this feature and cell.
2979            my ($fid, $cellID, $role) = @{$roleEntry};
2980            # Check for a subsystem name.
2981            my $subsys = $subHash{$cellID};
2982            if ($subsys) {
2983                # Insure this feature has an entry in the return hash.
2984                if (! exists $retVal{$fid}) { $retVal{$fid} = []; }
2985                # Merge in this new data.
2986                push @{$retVal{$fid}}, [$subsys, $role];
2987            }
2988        }
2989      # Return the result.      # Return the result.
2990      return @retVal;      return %retVal;
2991  }  }
2992    
2993  =head3 RelatedFeatures  =head3 RelatedFeatures
# Line 2603  Line 3025 
3025      # Get the parameters.      # Get the parameters.
3026      my ($self, $featureID, $function, $userID) = @_;      my ($self, $featureID, $function, $userID) = @_;
3027      # 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.
3028      my @bbhFeatures = $self->GetFlat(['IsBidirectionalBestHitOf'],      my @bbhFeatures = map { $_->[0] } FIGRules::BBHData($featureID);
                                      "IsBidirectionalBestHitOf(from-link) = ?", [$featureID],  
                                      'IsBidirectionalBestHitOf(to-link)');  
3029      # Now we loop through the features, pulling out the ones that have the correct      # Now we loop through the features, pulling out the ones that have the correct
3030      # functional assignment.      # functional assignment.
3031      my @retVal = ();      my @retVal = ();
# Line 2669  Line 3089 
3089      return @retVal;      return @retVal;
3090  }  }
3091    
3092  =head3 GetAll  =head3 Protein
   
 C<< my @list = $sprout->GetAll(\@objectNames, $filterClause, \@parameters, \@fields, $count); >>  
   
 Return a list of values taken from the objects returned by a query. The first three  
 parameters correspond to the parameters of the L</Get> method. The final parameter is  
 a list of the fields desired from each record found by the query. The field name  
 syntax is the standard syntax used for fields in the B<ERDB> system--  
 B<I<objectName>(I<fieldName>)>-- where I<objectName> is the name of the relevant entity  
 or relationship and I<fieldName> is the name of the field.  
3093    
3094  The list returned will be a list of lists. Each element of the list will contain  C<< my $protein = Sprout::Protein($sequence, $table); >>
 the values returned for the fields specified in the fourth parameter. If one of the  
 fields specified returns multiple values, they are flattened in with the rest. For  
 example, the following call will return a list of the features in a particular  
 spreadsheet cell, and each feature will be represented by a list containing the  
 feature ID followed by all of its aliases.  
3095    
3096  C<< $query = $sprout->Get(['ContainsFeature', 'Feature'], "ContainsFeature(from-link) = ?", [$ssCellID], ['Feature(id)', 'Feature(alias)']); >>  Translate a DNA sequence into a protein sequence.
3097    
3098  =over 4  =over 4
3099    
3100  =item objectNames  =item sequence
3101    
3102  List containing the names of the entity and relationship objects to be retrieved.  DNA sequence to translate.
3103    
3104  =item filterClause  =item table (optional)
3105    
3106  WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can  Reference to a Hash that translates DNA triples to proteins. A triple that does not
3107  be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form  appear in the hash will be translated automatically to C<X>.
 B<I<objectName>(I<fieldName>)>. Any parameters specified in the filter clause should be added to the  
 parameter list as additional parameters. The fields in a filter clause can come from primary  
 entity relations, relationship relations, or secondary entity relations; however, all of the  
 entities and relationships involved must be included in the list of object names.  
3108    
3109  =item parameterList  =item RETURN
3110    
3111  List of the parameters to be substituted in for the parameters marks in the filter clause.  Returns the protein sequence that would be created by the DNA sequence.
3112    
3113  =item fields  =back
   
 List of the fields to be returned in each element of the list returned.  
   
 =item count  
   
 Maximum number of records to return. If omitted or 0, all available records will be returned.  
   
 =item RETURN  
   
 Returns a list of list references. Each element of the return list contains the values for the  
 fields specified in the B<fields> parameter.  
   
 =back  
   
 =cut  
 #: Return Type @@;  
 sub GetAll {  
     # Get the parameters.  
     my ($self, $objectNames, $filterClause, $parameterList, $fields, $count) = @_;  
     # Call the ERDB method.  
     my @retVal = $self->{_erdb}->GetAll($objectNames, $filterClause, $parameterList,  
                                         $fields, $count);  
     # Return the resulting list.  
     return @retVal;  
 }  
   
 =head3 GetFlat  
   
 C<< my @list = $sprout->GetFlat(\@objectNames, $filterClause, $parameterList, $field); >>  
   
 This is a variation of L</GetAll> that asks for only a single field per record and  
 returns a single flattened list.  
   
 =over 4  
   
 =item objectNames  
   
 List containing the names of the entity and relationship objects to be retrieved.  
   
 =item filterClause  
   
 WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can  
 be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form  
 B<I<objectName>(I<fieldName>)>. Any parameters specified in the filter clause should be added to the  
 parameter list as additional parameters. The fields in a filter clause can come from primary  
 entity relations, relationship relations, or secondary entity relations; however, all of the  
 entities and relationships involved must be included in the list of object names.  
   
 =item parameterList  
   
 List of the parameters to be substituted in for the parameters marks in the filter clause.  
   
 =item field  
   
 Name of the field to be used to get the elements of the list returned.  
   
 =item RETURN  
   
 Returns a list of values.  
   
 =back  
   
 =cut  
 #: Return Type @;  
 sub GetFlat {  
     # Get the parameters.  
     my ($self, $objectNames, $filterClause, $parameterList, $field) = @_;  
     # Construct the query.  
     my $query = $self->Get($objectNames, $filterClause, $parameterList);  
     # Create the result list.  
     my @retVal = ();  
     # Loop through the records, adding the field values found to the result list.  
     while (my $row = $query->Fetch()) {  
         push @retVal, $row->Value($field);  
     }  
     # Return the list created.  
     return @retVal;  
 }  
   
 =head3 Protein  
   
 C<< my $protein = Sprout::Protein($sequence, $table); >>  
   
 Translate a DNA sequence into a protein sequence.  
   
 =over 4  
   
 =item sequence  
   
 DNA sequence to translate.  
   
 =item table (optional)  
   
 Reference to a Hash that translates DNA triples to proteins. A triple that does not  
 appear in the hash will be translated automatically to C<X>.  
   
 =item RETURN  
   
 Returns the protein sequence that would be created by the DNA sequence.  
   
 =back  
3114    
3115  =cut  =cut
3116    
# Line 2860  Line 3161 
3161      # Loop through the input triples.      # Loop through the input triples.
3162      my $n = length $sequence;      my $n = length $sequence;
3163      for (my $i = 0; $i < $n; $i += 3) {      for (my $i = 0; $i < $n; $i += 3) {
3164          # Get the current triple from the sequence.          # Get the current triple from the sequence. Note we convert to
3165          my $triple = substr($sequence, $i, 3);          # upper case to insure a match.
3166            my $triple = uc substr($sequence, $i, 3);
3167          # Translate it using the table.          # Translate it using the table.
3168          my $protein = "X";          my $protein = "X";
3169          if (exists $table->{$triple}) { $protein = $table->{$triple}; }          if (exists $table->{$triple}) { $protein = $table->{$triple}; }
# Line 2889  Line 3191 
3191      # 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.
3192      my @retVal = ($self->{_options}->{dataDir});      my @retVal = ($self->{_options}->{dataDir});
3193      # Concatenate the table names.      # Concatenate the table names.
3194      push @retVal, $self->{_erdb}->GetTableNames();      push @retVal, $self->GetTableNames();
3195      # Return the result.      # Return the result.
3196      return @retVal;      return @retVal;
3197  }  }
3198    
3199    =head3 BBHMatrix
3200    
3201    C<< my %bbhMap = $sprout->BBHMatrix($genomeID, $cutoff, @targets); >>
3202    
3203    Find all the bidirectional best hits for the features of a genome in a
3204    specified list of target genomes. The return value will be a hash mapping
3205    features in the original genome to their bidirectional best hits in the
3206    target genomes.
3207    
3208    =over 4
3209    
3210    =item genomeID
3211    
3212    ID of the genome whose features are to be examined for bidirectional best hits.
3213    
3214    =item cutoff
3215    
3216    A cutoff value. Only hits with a score lower than the cutoff will be returned.
3217    
3218    =item targets
3219    
3220    List of target genomes. Only pairs originating in the original
3221    genome and landing in one of the target genomes will be returned.
3222    
3223    =item RETURN
3224    
3225    Returns a hash mapping each feature in the original genome to a hash mapping its
3226    BBH pegs in the target genomes to their scores.
3227    
3228    =back
3229    
3230    =cut
3231    
3232    sub BBHMatrix {
3233        # Get the parameters.
3234        my ($self, $genomeID, $cutoff, @targets) = @_;
3235        # Declare the return variable.
3236        my %retVal = ();
3237        # Ask for the BBHs.
3238        my @bbhList = FIGRules::BatchBBHs("fig|$genomeID.%", $cutoff, @targets);
3239        # We now have a set of 4-tuples that we need to convert into a hash of hashes.
3240        for my $bbhData (@bbhList) {
3241            my ($peg1, $peg2, $score) = @{$bbhData};
3242            if (! exists $retVal{$peg1}) {
3243                $retVal{$peg1} = { $peg2 => $score };
3244            } else {
3245                $retVal{$peg1}->{$peg2} = $score;
3246            }
3247        }
3248        # Return the result.
3249        return %retVal;
3250    }
3251    
3252    
3253    =head3 SimMatrix
3254    
3255    C<< my %simMap = $sprout->SimMatrix($genomeID, $cutoff, @targets); >>
3256    
3257    Find all the similarities for the features of a genome in a
3258    specified list of target genomes. The return value will be a hash mapping
3259    features in the original genome to their similarites in the
3260    target genomes.
3261    
3262    =over 4
3263    
3264    =item genomeID
3265    
3266    ID of the genome whose features are to be examined for similarities.
3267    
3268    =item cutoff
3269    
3270    A cutoff value. Only hits with a score lower than the cutoff will be returned.
3271    
3272    =item targets
3273    
3274    List of target genomes. Only pairs originating in the original
3275    genome and landing in one of the target genomes will be returned.
3276    
3277    =item RETURN
3278    
3279    Returns a hash mapping each feature in the original genome to a hash mapping its
3280    similar pegs in the target genomes to their scores.
3281    
3282    =back
3283    
3284    =cut
3285    
3286    sub SimMatrix {
3287        # Get the parameters.
3288        my ($self, $genomeID, $cutoff, @targets) = @_;
3289        # Declare the return variable.
3290        my %retVal = ();
3291        # Get the list of features in the source organism.
3292        my @fids = $self->FeaturesOf($genomeID);
3293        # Ask for the sims. We only want similarities to fig features.
3294        my $simList = FIGRules::GetNetworkSims($self, \@fids, {}, 1000, $cutoff, "fig");
3295        if (! defined $simList) {
3296            Confess("Unable to retrieve similarities from server.");
3297        } else {
3298            Trace("Processing sims.") if T(3);
3299            # We now have a set of sims that we need to convert into a hash of hashes. First, we
3300            # Create a hash for the target genomes.
3301            my %targetHash = map { $_ => 1 } @targets;
3302            for my $simData (@{$simList}) {
3303                # Get the PEGs and the score.
3304                my ($peg1, $peg2, $score) = ($simData->id1, $simData->id2, $simData->psc);
3305                # Insure the second ID is in the target list.
3306                my ($genome2) = FIGRules::ParseFeatureID($peg2);
3307                if (exists $targetHash{$genome2}) {
3308                    # Here it is. Now we need to add it to the return hash. How we do that depends
3309                    # on whether or not $peg1 is new to us.
3310                    if (! exists $retVal{$peg1}) {
3311                        $retVal{$peg1} = { $peg2 => $score };
3312                    } else {
3313                        $retVal{$peg1}->{$peg2} = $score;
3314                    }
3315                }
3316            }
3317        }
3318        # Return the result.
3319        return %retVal;
3320    }
3321    
3322    
3323  =head3 LowBBHs  =head3 LowBBHs
3324    
3325  C<< my %bbhMap = $sprout->GoodBBHs($featureID, $cutoff); >>  C<< my %bbhMap = $sprout->LowBBHs($featureID, $cutoff); >>
3326    
3327  Return the bidirectional best hits of a feature whose score is no greater than a  Return the bidirectional best hits of a feature whose score is no greater than a
3328  specified cutoff value. A higher cutoff value will allow inclusion of hits with  specified cutoff value. A higher cutoff value will allow inclusion of hits with
# Line 2925  Line 3351 
3351      my ($self, $featureID, $cutoff) = @_;      my ($self, $featureID, $cutoff) = @_;
3352      # Create the return hash.      # Create the return hash.
3353      my %retVal = ();      my %retVal = ();
3354      # Create a query to get the desired BBHs.      # Query for the desired BBHs.
3355      my @bbhList = $self->GetAll(['IsBidirectionalBestHitOf'],      my @bbhList = FIGRules::BBHData($featureID, $cutoff);
                                 'IsBidirectionalBestHitOf(sc) <= ? AND IsBidirectionalBestHitOf(from-link) = ?',  
                                 [$cutoff, $featureID],  
                                 ['IsBidirectionalBestHitOf(to-link)', 'IsBidirectionalBestHitOf(sc)']);  
3356      # Form the results into the return hash.      # Form the results into the return hash.
3357      for my $pair (@bbhList) {      for my $pair (@bbhList) {
3358          $retVal{$pair->[0]} = $pair->[1];          my $fid = $pair->[0];
3359            if ($self->Exists('Feature', $fid)) {
3360                $retVal{$fid} = $pair->[1];
3361            }
3362      }      }
3363      # Return the result.      # Return the result.
3364      return %retVal;      return %retVal;
3365  }  }
3366    
3367    =head3 Sims
3368    
3369    C<< my $simList = $sprout->Sims($fid, $maxN, $maxP, $select, $max_expand, $filters); >>
3370    
3371    Get a list of similarities for a specified feature. Similarity information is not kept in the
3372    Sprout database; rather, they are retrieved from a network server. The similarities are
3373    returned as B<Sim> objects. A Sim object is actually a list reference that has been blessed
3374    so that its elements can be accessed by name.
3375    
3376    Similarities can be either raw or expanded. The raw similarities are basic
3377    hits between features with similar DNA. Expanding a raw similarity drags in any
3378    features considered substantially identical. So, for example, if features B<A1>,
3379    B<A2>, and B<A3> are all substantially identical to B<A>, then a raw similarity
3380    B<[C,A]> would be expanded to B<[C,A] [C,A1] [C,A2] [C,A3]>.
3381    
3382    =over 4
3383    
3384    =item fid
3385    
3386    ID of the feature whose similarities are desired.
3387    
3388    =item maxN
3389    
3390    Maximum number of similarities to return.
3391    
3392    =item maxP
3393    
3394    Minumum allowable similarity score.
3395    
3396    =item select
3397    
3398    Selection criterion: C<raw> means only raw similarities are returned; C<fig>
3399    means only similarities to FIG features are returned; C<all> means all expanded
3400    similarities are returned; and C<figx> means similarities are expanded until the
3401    number of FIG features equals the maximum.
3402    
3403    =item max_expand
3404    
3405    The maximum number of features to expand.
3406    
3407    =item filters
3408    
3409    Reference to a hash containing filter information, or a subroutine that can be
3410    used to filter the sims.
3411    
3412    =item RETURN
3413    
3414    Returns a reference to a list of similarity objects, or C<undef> if an error
3415    occurred.
3416    
3417    =back
3418    
3419    =cut
3420    
3421    sub Sims {
3422        # Get the parameters.
3423        my ($self, $fid, $maxN, $maxP, $select, $max_expand, $filters) = @_;
3424        # Create the shim object to test for deleted FIDs.
3425        my $shim = FidCheck->new($self);
3426        # Ask the network for sims.
3427        my $retVal = FIGRules::GetNetworkSims($shim, $fid, {}, $maxN, $maxP, $select, $max_expand, $filters);
3428        # Return the result.
3429        return $retVal;
3430    }
3431    
3432    =head3 IsAllGenomes
3433    
3434    C<< my $flag = $sprout->IsAllGenomes(\@list, \@checkList); >>
3435    
3436    Return TRUE if all genomes in the second list are represented in the first list at
3437    least one. Otherwise, return FALSE. If the second list is omitted, the first list is
3438    compared to a list of all the genomes.
3439    
3440    =over 4
3441    
3442    =item list
3443    
3444    Reference to the list to be compared to the second list.
3445    
3446    =item checkList (optional)
3447    
3448    Reference to the comparison target list. Every genome ID in this list must occur at
3449    least once in the first list. If this parameter is omitted, a list of all the genomes
3450    is used.
3451    
3452    =item RETURN
3453    
3454    Returns TRUE if every item in the second list appears at least once in the
3455    first list, else FALSE.
3456    
3457    =back
3458    
3459    =cut
3460    
3461    sub IsAllGenomes {
3462        # Get the parameters.
3463        my ($self, $list, $checkList) = @_;
3464        # Supply the checklist if it was omitted.
3465        $checkList = [$self->Genomes()] if ! defined($checkList);
3466        # Create a hash of the original list.
3467        my %testList = map { $_ => 1 } @{$list};
3468        # Declare the return variable. We assume that the representation
3469        # is complete and stop at the first failure.
3470        my $retVal = 1;
3471        my $n = scalar @{$checkList};
3472        for (my $i = 0; $retVal && $i < $n; $i++) {
3473            if (! $testList{$checkList->[$i]}) {
3474                $retVal = 0;
3475            }
3476        }
3477        # Return the result.
3478        return $retVal;
3479    }
3480    
3481  =head3 GetGroups  =head3 GetGroups
3482    
3483  C<< my %groups = $sprout->GetGroups(\@groupList); >>  C<< my %groups = $sprout->GetGroups(\@groupList); >>
# Line 2959  Line 3499 
3499          # Here we have a group list. Loop through them individually,          # Here we have a group list. Loop through them individually,
3500          # getting a list of the relevant genomes.          # getting a list of the relevant genomes.
3501          for my $group (@{$groupList}) {          for my $group (@{$groupList}) {
3502              my @genomeIDs = $self->GetFlat(['Genome'], "Genome(group-name) = ?",              my @genomeIDs = $self->GetFlat(['Genome'], "Genome(primary-group) = ?",
3503                  [$group], "Genome(id)");                  [$group], "Genome(id)");
3504              $retVal{$group} = \@genomeIDs;              $retVal{$group} = \@genomeIDs;
3505          }          }
# Line 2967  Line 3507 
3507          # Here we need all of the groups. In this case, we run through all          # Here we need all of the groups. In this case, we run through all
3508          # of the genome records, putting each one found into the appropriate          # of the genome records, putting each one found into the appropriate
3509          # group. Note that we use a filter clause to insure that only genomes          # group. Note that we use a filter clause to insure that only genomes
3510          # in groups are included in the return set.          # in real NMPDR groups are included in the return set.
3511          my @genomes = $self->GetAll(['Genome'], "Genome(group-name) > ' '", [],          my @genomes = $self->GetAll(['Genome'], "Genome(primary-group) <> ?",
3512                                      ['Genome(id)', 'Genome(group-name)']);                                      [$FIG_Config::otherGroup], ['Genome(id)', 'Genome(primary-group)']);
3513          # Loop through the genomes found.          # Loop through the genomes found.
3514          for my $genome (@genomes) {          for my $genome (@genomes) {
3515              # Pop this genome's ID off the current list.              # Pop this genome's ID off the current list.
# Line 3059  Line 3599 
3599      return $retVal;      return $retVal;
3600  }  }
3601    
3602  =head2 Internal Utility Methods  =head3 DeleteGenome
3603    
3604  =head3 ParseAssignment  C<< my $stats = $sprout->DeleteGenome($genomeID, $testFlag); >>
3605    
3606  Parse annotation text to determine whether or not it is a functional assignment. If it is,  Delete a genome from the database.
 the user, function text, and assigning user will be returned as a 3-element list. If it  
 isn't, an empty list will be returned.  
3607    
3608  A functional assignment is always of the form  =over 4
3609    
3610      I<XXXX>C<\nset >I<YYYY>C< function to\n>I<ZZZZZ>  =item genomeID
3611    
3612  where I<XXXX> is the B<assigning user>, I<YYYY> is the B<user>, and I<ZZZZ> is the  ID of the genome to delete
 actual functional role. In most cases, the user and the assigning user will be the  
 same, but that is not always the case.  
3613    
3614  This is a static method.  =item testFlag
3615    
3616    If TRUE, then the DELETE statements will be traced, but no deletions will occur.
3617    
3618    =item RETURN
3619    
3620    Returns a statistics object describing the rows deleted.
3621    
3622    =back
3623    
3624    =cut
3625    #: Return Type $%;
3626    sub DeleteGenome {
3627        # Get the parameters.
3628        my ($self, $genomeID, $testFlag) = @_;
3629        # Perform the delete for the genome's features.
3630        my $retVal = $self->Delete('Feature', "fig|$genomeID.%", testMode => $testFlag);
3631        # Perform the delete for the primary genome data.
3632        my $stats = $self->Delete('Genome', $genomeID, testMode => $testFlag);
3633        $retVal->Accumulate($stats);
3634        # Return the result.
3635        return $retVal;
3636    }
3637    
3638    =head3 Fix
3639    
3640    C<< my %fixedHash = Sprout::Fix(%groupHash); >>
3641    
3642    Prepare a genome group hash (like that returned by L</GetGroups> for processing.
3643    Groups with the same primary name will be combined. The primary name is the
3644    first capitalized word in the group name.
3645    
3646  =over 4  =over 4
3647    
3648  =item text  =item groupHash
3649    
3650  Text of the annotation.  Hash to be fixed up.
3651    
3652  =item RETURN  =item RETURN
3653    
3654  Returns an empty list if the annotation is not a functional assignment; otherwise, returns  Returns a fixed-up version of the hash.
 a two-element list containing the user name and the function text.  
3655    
3656  =back  =back
3657    
3658  =cut  =cut
3659    
3660  sub _ParseAssignment {  sub Fix {
3661      # Get the parameters.      # Get the parameters.
3662      my ($text) = @_;      my (%groupHash) = @_;
3663      # Declare the return value.      # Create the result hash.
3664      my @retVal = ();      my %retVal = ();
3665      # Check to see if this is a functional assignment.      # Copy over the genomes.
3666      my ($user, $type, $function) = split(/\n/, $text);      for my $groupID (keys %groupHash) {
3667      if ($type =~ m/^set ([^ ]+) function to$/i) {          # Make a safety copy of the group ID.
3668          # Here it is, so we return the user name (which is in $1), the functional role text,          my $realGroupID = $groupID;
3669          # and the assigning user.          # Yank the primary name.
3670          @retVal = ($1, $function, $user);          if ($groupID =~ /([A-Z]\w+)/) {
3671                $realGroupID = $1;
3672      }      }
3673      # Return the result list.          # Append this group's genomes into the result hash.
3674      return @retVal;          Tracer::AddToListMap(\%retVal, $realGroupID, @{$groupHash{$groupID}});
3675        }
3676        # Return the result hash.
3677        return %retVal;
3678  }  }
3679    
3680  =head3 FriendlyTimestamp  =head3 GroupPageName
3681    
3682  Convert a time number to a user-friendly time stamp for display.  C<< my $name = $sprout->GroupPageName($group); >>
3683    
3684  This is a static method.  Return the name of the page for the specified NMPDR group.
3685    
3686  =over 4  =over 4
3687    
3688  =item timeValue  =item group
3689    
3690  Numeric time value.  Name of the relevant group.
3691    
3692  =item RETURN  =item RETURN
3693    
3694  Returns a string containing the same time in user-readable format.  Returns the relative page name (e.g. C<../content/campy.php>). If the group file is not in
3695    memory it will be read in.
3696    
3697  =back  =back
3698    
3699  =cut  =cut
3700    
3701  sub FriendlyTimestamp {  sub GroupPageName {
3702      my ($timeValue) = @_;      # Get the parameters.
3703      my $retVal = strftime("%a %b %e %H:%M:%S %Y", localtime($timeValue));      my ($self, $group) = @_;
3704        # Declare the return variable.
3705        my $retVal;
3706        # Check for the group file data.
3707        if (! defined $self->{groupHash}) {
3708            # Read the group file.
3709            my %groupData = Sprout::ReadGroupFile($self->{_options}->{dataDir} . "/groups.tbl");
3710            # Store it in our object.
3711            $self->{groupHash} = \%groupData;
3712        }
3713        # Compute the real group name.
3714        my $realGroup = $group;
3715        if ($group =~ /([A-Z]\w+)/) {
3716            $realGroup = $1;
3717        }
3718        # Return the page name.
3719        $retVal = "../content/" . $self->{groupHash}->{$realGroup}->[1];
3720        # Return the result.
3721      return $retVal;      return $retVal;
3722  }  }
3723    
3724    =head3 ReadGroupFile
3725    
3726    C<< my %groupData = Sprout::ReadGroupFile($groupFileName); >>
3727    
3728    Read in the data from the specified group file. The group file contains information
3729    about each of the NMPDR groups.
3730    
3731    =over 4
3732    
3733    =item name
3734    
3735    Name of the group.
3736    
3737    =item page
3738    
3739    Name of the group's page on the web site (e.g. C<campy.php> for
3740    Campylobacter)
3741    
3742    =item genus
3743    
3744    Genus of the group
3745    
3746    =item species
3747    
3748    Species of the group, or an empty string if the group is for an entire
3749    genus. If the group contains more than one species, the species names
3750    should be separated by commas.
3751    
3752    =back
3753    
3754    The parameters to this method are as follows
3755    
3756    =over 4
3757    
3758    =item groupFile
3759    
3760    Name of the file containing the group data.
3761    
3762    =item RETURN
3763    
3764    Returns a hash keyed on group name. The value of each hash
3765    
3766    =back
3767    
3768    =cut
3769    
3770    sub ReadGroupFile {
3771        # Get the parameters.
3772        my ($groupFileName) = @_;
3773        # Declare the return variable.
3774        my %retVal;
3775        # Read the group file.
3776        my @groupLines = Tracer::GetFile($groupFileName);
3777        for my $groupLine (@groupLines) {
3778            my ($name, $page, $genus, $species) = split(/\t/, $groupLine);
3779            $retVal{$name} = [$page, $genus, $species];
3780        }
3781        # Return the result.
3782        return %retVal;
3783    }
3784    
3785  =head3 AddProperty  =head3 AddProperty
3786    
3787  C<< my  = $sprout->AddProperty($featureID, $key, $value, $url); >>  C<< my  = $sprout->AddProperty($featureID, $key, @values); >>
3788    
3789  Add a new attribute value (Property) to a feature. In the SEED system, attributes can  Add a new attribute value (Property) to a feature.
 be added to almost any object. In Sprout, they can only be added to features. In  
 Sprout, attributes are implemented using I<properties>. A property represents a key/value  
 pair. If the particular key/value pair coming in is not already in the database, a new  
 B<Property> record is created to hold it.  
3790    
3791  =over 4  =over 4
3792    
3793  =item peg  =item peg
3794    
3795  ID of the feature to which the attribute is to be replied.  ID of the feature to which the attribute is to be added.
3796    
3797  =item key  =item key
3798    
3799  Name of the attribute (key).  Name of the attribute (key).
3800    
3801  =item value  =item values
   
 Value of the attribute.  
   
 =item url  
3802    
3803  URL or text citation from which the property was obtained.  Values of the attribute.
3804    
3805  =back  =back
3806    
# Line 3168  Line 3808 
3808  #: Return Type ;  #: Return Type ;
3809  sub AddProperty {  sub AddProperty {
3810      # Get the parameters.      # Get the parameters.
3811      my ($self, $featureID, $key, $value, $url) = @_;      my ($self, $featureID, $key, @values) = @_;
3812      # Declare the variable to hold the desired property ID.      # Add the property using the attached attributes object.
3813      my $propID;      $self->{_ca}->AddAttribute($featureID, $key, @values);
3814      # Attempt to find a property record for this key/value pair.  }
3815      my @properties = $self->GetFlat(['Property'],  
3816                                     "Property(property-name) = ? AND Property(property-value) = ?",  =head2 Virtual Methods
3817                                     [$key, $value], 'Property(id)');  
3818      if (@properties) {  =head3 CleanKeywords
3819          # Here the property is already in the database. We save its ID.  
3820          $propID = $properties[0];  C<< my $cleanedString = $sprout->CleanKeywords($searchExpression); >>
3821          # Here the property value does not exist. We need to generate an ID. It will be set  
3822          # to a number one greater than the maximum value in the database. This call to  Clean up a search expression or keyword list. This involves converting the periods
3823          # GetAll will stop after one record.  in EC numbers to underscores, converting non-leading minus signs to underscores,
3824          my @maxProperty = $self->GetAll(['Property'], "ORDER BY Property(id) DESC", [], ['Property(id)'],  a vertical bar or colon to an apostrophe, and forcing lower case for all alphabetic
3825                                          1);  characters. In addition, any extra spaces are removed.
3826          $propID = $maxProperty[0]->[0] + 1;  
3827          # Insert the new property value.  =over 4
3828          $self->Insert('Property', { 'property-name' => $key, 'property-value' => $value, id => $propID });  
3829    =item searchExpression
3830    
3831    Search expression or keyword list to clean. Note that a search expression may
3832    contain boolean operators which need to be preserved. This includes leading
3833    minus signs.
3834    
3835    =item RETURN
3836    
3837    Cleaned expression or keyword list.
3838    
3839    =back
3840    
3841    =cut
3842    
3843    sub CleanKeywords {
3844        # Get the parameters.
3845        my ($self, $searchExpression) = @_;
3846        # Perform the standard cleanup.
3847        my $retVal = $self->ERDB::CleanKeywords($searchExpression);
3848        # Fix the periods in EC and TC numbers.
3849        $retVal =~ s/(\d+|\-)\.(\d+|-)\.(\d+|-)\.(\d+|-)/$1_$2_$3_$4/g;
3850        # Fix non-trailing periods.
3851        $retVal =~ s/\.(\w)/_$1/g;
3852        # Fix non-leading minus signs.
3853        $retVal =~ s/(\w)[\-]/$1_/g;
3854        # Fix the vertical bars and colons
3855        $retVal =~ s/(\w)[|:](\w)/$1'$2/g;
3856        # Return the result.
3857        return $retVal;
3858    }
3859    
3860    =head2 Internal Utility Methods
3861    
3862    =head3 ParseAssignment
3863    
3864    Parse annotation text to determine whether or not it is a functional assignment. If it is,
3865    the user, function text, and assigning user will be returned as a 3-element list. If it
3866    isn't, an empty list will be returned.
3867    
3868    A functional assignment is always of the form
3869    
3870        C<set >I<YYYY>C< function to\n>I<ZZZZZ>
3871    
3872    where I<YYYY> is the B<user>, and I<ZZZZ> is the actual functional role. In most cases,
3873    the user and the assigning user (from MadeAnnotation) will be the same, but that is
3874    not always the case.
3875    
3876    In addition, the functional role may contain extra data that is stripped, such as
3877    terminating spaces or a comment separated from the rest of the text by a tab.
3878    
3879    This is a static method.
3880    
3881    =over 4
3882    
3883    =item user
3884    
3885    Name of the assigning user.
3886    
3887    =item text
3888    
3889    Text of the annotation.
3890    
3891    =item RETURN
3892    
3893    Returns an empty list if the annotation is not a functional assignment; otherwise, returns
3894    a two-element list containing the user name and the function text.
3895    
3896    =back
3897    
3898    =cut
3899    
3900    sub _ParseAssignment {
3901        # Get the parameters.
3902        my ($user, $text) = @_;
3903        # Declare the return value.
3904        my @retVal = ();
3905        # Check to see if this is a functional assignment.
3906        my ($type, $function) = split(/\n/, $text);
3907        if ($type =~ m/^set function to$/i) {
3908            # Here we have an assignment without a user, so we use the incoming user ID.
3909            @retVal = ($user, $function);
3910        } elsif ($type =~ m/^set (\S+) function to$/i) {
3911            # Here we have an assignment with a user that is passed back to the caller.
3912            @retVal = ($1, $function);
3913        }
3914        # If we have an assignment, we need to clean the function text. There may be
3915        # extra junk at the end added as a note from the user.
3916        if (defined( $retVal[1] )) {
3917            $retVal[1] =~ s/(\t\S)?\s*$//;
3918      }      }
3919      # Now we connect the incoming feature to the property.      # Return the result list.
3920      $self->Insert('HasProperty', { 'from-link' => $featureID, 'to-link' => $propID, evidence => $url });      return @retVal;
3921  }  }
3922    
3923    =head3 FriendlyTimestamp
3924    
3925    Convert a time number to a user-friendly time stamp for display.
3926    
3927    This is a static method.
3928    
3929    =over 4
3930    
3931    =item timeValue
3932    
3933    Numeric time value.
3934    
3935    =item RETURN
3936    
3937    Returns a string containing the same time in user-readable format.
3938    
3939    =back
3940    
3941    =cut
3942    
3943    sub FriendlyTimestamp {
3944        my ($timeValue) = @_;
3945        my $retVal = localtime($timeValue);
3946        return $retVal;
3947    }
3948    
3949    
3950  1;  1;

Legend:
Removed from v.1.19  
changed lines
  Added in v.1.99

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3