[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.6, Wed Jan 26 17:41:53 2005 UTC revision 1.114, Wed Sep 3 20:59:57 2008 UTC
# Line 2  Line 2 
2    
3          use Data::Dumper;          use Data::Dumper;
4          use strict;          use strict;
         use Carp;  
5          use DBKernel;          use DBKernel;
6          use XML::Simple;          use XML::Simple;
7          use DBQuery;          use DBQuery;
8          use DBObject;      use ERDBObject;
         use ERDB;  
9          use Tracer;          use Tracer;
10          use FIGRules;          use FIGRules;
11        use FidCheck;
12          use Stats;          use Stats;
13      use POSIX qw(strftime);      use POSIX qw(strftime);
14        use BasicLocation;
15        use CustomAttributes;
16        use RemoteCustomAttributes;
17        use CGI;
18        use WikiTools;
19        use base qw(ERDB);
20    
21  =head1 Sprout Database Manipulation Object  =head1 Sprout Database Manipulation Object
22    
# Line 25  Line 29 
29  on the constructor. For example, the following invocation specifies a PostgreSQL database named I<GenDB>  on the constructor. For example, the following invocation specifies a PostgreSQL database named I<GenDB>
30  whose definition and data files are in a co-directory named F<Data>.  whose definition and data files are in a co-directory named F<Data>.
31    
32  C<< my $sprout = Sprout->new('GenDB', { dbType => 'pg', dataDir => '../Data', xmlFileName => '../Data/SproutDBD.xml' }); >>      my $sprout = Sprout->new('GenDB', { dbType => 'pg', dataDir => '../Data', xmlFileName => '../Data/SproutDBD.xml' });
33    
34  Once you have a sprout object, you may use it to re-create the database, load the tables from  Once you have a sprout object, you may use it to re-create the database, load the tables from
35  tab-delimited flat files and perform queries. Several special methods are provided for common  tab-delimited flat files and perform queries. Several special methods are provided for common
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</DNASeq> 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    
# Line 40  Line 46 
46    
47  =head3 new  =head3 new
48    
49  C<< my $sprout = Sprout->new($dbName, \%options); >>      my $sprout = Sprout->new($dbName, \%options);
50    
51  This is the constructor for a sprout object. It connects to the database and loads the  This is the constructor for a sprout object. It connects to the database and loads the
52  database definition into memory. The positional first parameter specifies the name of the  database definition into memory. The positional first parameter specifies the name of the
# 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    * B<host> name of the database host
84    
85  =back  =back
86    
87  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
88  I<fig> with a password of I<admin>. The database load files are in the directory  I<fig> with a password of I<admin>. The database load files are in the directory
89  F</usr/fig/SproutData>.  F</usr/fig/SproutData>.
90    
91  C<< my $sprout = Sprout->new('Sprout', { userData =>; 'fig/admin', dataDir => '/usr/fig/SproutData' }); >>      my $sprout = Sprout->new('Sprout', { userData => 'fig/admin', dataDir => '/usr/fig/SproutData' });
92    
93  =cut  =cut
94    
95  sub new {  sub new {
96          # Get the parameters.          # Get the parameters.
97          my ($class, $dbName, $options) = @_;          my ($class, $dbName, $options) = @_;
98        # Compute the DBD directory.
99        my $dbd_dir = (defined($FIG_Config::dbd_dir) ? $FIG_Config::dbd_dir :
100                                                      $FIG_Config::fig );
101          # 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
102          # the incoming data.          # the incoming data.
103          my $optionTable = Tracer::GetOptions({          my $optionTable = Tracer::GetOptions({
104                                             dbType               => 'mysql',                     # database type                         dbType       => $FIG_Config::dbms,
105                                             dataDir              => 'Data',                      # data file directory                                                          # database type
106                                             xmlFileName  => 'SproutDBD.xml', # database definition file name                         dataDir      => $FIG_Config::sproutData,
107                                             userData             => 'root/',                     # user name and password                                                          # data file directory
108                                             port                 => 0,                           # database connection port                         xmlFileName  => "$dbd_dir/SproutDBD.xml",
109                                                            # database definition file name
110                           userData     => "$FIG_Config::dbuser/$FIG_Config::dbpass",
111                                                            # user name and password
112                           port         => $FIG_Config::dbport,
113                                                            # database connection port
114                           sock         => $FIG_Config::dbsock,
115                           host         => $FIG_Config::sprout_host,
116                                             maxSegmentLength => 4500,            # maximum feature segment length                                             maxSegmentLength => 4500,            # maximum feature segment length
117                                             maxSequenceLength => 8000,           # maximum contig sequence length                                             maxSequenceLength => 8000,           # maximum contig sequence length
118                           noDBOpen     => 0,               # 1 to suppress the database open
119                                            }, $options);                                            }, $options);
120          # Get the data directory.          # Get the data directory.
121          my $dataDir = $optionTable->{dataDir};          my $dataDir = $optionTable->{dataDir};
# Line 100  Line 123 
123          $optionTable->{userData} =~ m!([^/]*)/(.*)$!;          $optionTable->{userData} =~ m!([^/]*)/(.*)$!;
124          my ($userName, $password) = ($1, $2);          my ($userName, $password) = ($1, $2);
125          # Connect to the database.          # Connect to the database.
126          my $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName, $password, $optionTable->{port});      my $dbh;
127        if (! $optionTable->{noDBOpen}) {
128            Trace("Connect data: host = $optionTable->{host}, port = $optionTable->{port}.") if T(3);
129            $dbh = DBKernel->new($optionTable->{dbType}, $dbName, $userName,
130                                    $password, $optionTable->{port}, $optionTable->{host}, $optionTable->{sock});
131        }
132          # Create the ERDB object.          # Create the ERDB object.
133          my $xmlFileName = "$optionTable->{xmlFileName}";          my $xmlFileName = "$optionTable->{xmlFileName}";
134          my $erdb = ERDB->new($dbh, $xmlFileName);      my $retVal = ERDB::new($class, $dbh, $xmlFileName);
135          # Create this object.      # Add the option table and XML file name.
136          my $self = { _erdb => $erdb, _options => $optionTable, _xmlName => $xmlFileName };      $retVal->{_options} = $optionTable;
137          # Bless and return it.      $retVal->{_xmlName} = $xmlFileName;
138          bless $self;      # Set up space for the group file data.
139          return $self;      $retVal->{groupHash} = undef;
140        # Set up space for the genome hash. We use this to identify NMPDR genomes.
141        $retVal->{genomeHash} = undef;
142        # Connect to the attributes.
143        if ($FIG_Config::attrURL) {
144            Trace("Remote attribute server $FIG_Config::attrURL chosen.") if T(3);
145            $retVal->{_ca} = RemoteCustomAttributes->new($FIG_Config::attrURL);
146        } elsif ($FIG_Config::attrDbName) {
147            Trace("Local attribute database $FIG_Config::attrDbName chosen.") if T(3);
148            my $user = ($FIG_Config::arch eq 'win' ? 'self' : scalar(getpwent()));
149            $retVal->{_ca} = CustomAttributes->new(user => $user);
150        }
151        # Insure we have access to the stem module.
152        WikiUse('Lingua::Stem');
153        $retVal->{stemmer} = Lingua::Stem->new();
154        $retVal->{stemmer}->stem_caching({ -level => 2 });
155        # Return it.
156        return $retVal;
157    }
158    
159    =head3 CoreGenomes
160    
161        my @genomes = $sprout->CoreGenomes($scope);
162    
163    Return the IDs of NMPDR genomes in the specified scope.
164    
165    =over 4
166    
167    =item scope
168    
169    Scope of the desired genomes. C<core> covers the original core genomes,
170    C<nmpdr> covers all genomes in NMPDR groups, and C<all> covers all
171    genomes in the system.
172    
173    =item RETURN
174    
175    Returns a list of the IDs for the genomes in the specified scope.
176    
177    =back
178    
179    =cut
180    
181    sub CoreGenomes {
182        # Get the parameters.
183        my ($self, $scope) = @_;
184        # Declare the return variable.
185        my @retVal = ();
186        # If we want all genomes, then this is easy.
187        if ($scope eq 'all') {
188            @retVal = $self->Genomes();
189        } else {
190            # Here we're dealing with groups. Get the hash of all the
191            # genome groups.
192            my %groups = $self->GetGroups();
193            # Loop through the groups, keeping the ones that we want.
194            for my $group (keys %groups) {
195                # Decide if we want to keep this group.
196                my $keepGroup = 0;
197                if ($scope eq 'nmpdr') {
198                    # NMPDR mode: keep all groups.
199                    $keepGroup = 1;
200                } elsif ($scope eq 'core') {
201                    # CORE mode. Only keep real core groups.
202                    if (grep { $group =~ /$_/ } @{$FIG_Config::realCoreGroups}) {
203                        $keepGroup = 1;
204                    }
205                }
206                # Add this group if we're keeping it.
207                if ($keepGroup) {
208                    push @retVal, @{$groups{$group}};
209                }
210            }
211        }
212        # Return the result.
213        return @retVal;
214    }
215    
216    =head3 SuperGroup
217    
218        my $superGroup = $sprout->SuperGroup($groupName);
219    
220    Return the name of the super-group containing the specified NMPDR genome
221    group. If no appropriate super-group can be found, an error will be
222    thrown.
223    
224    =over 4
225    
226    =item groupName
227    
228    Name of the group whose super-group is desired.
229    
230    =item RETURN
231    
232    Returns the name of the super-group containing the incoming group.
233    
234    =back
235    
236    =cut
237    
238    sub SuperGroup {
239        # Get the parameters.
240        my ($self, $groupName) = @_;
241        # Declare the return variable.
242        my $retVal;
243        # Get the group hash.
244        my %groupHash = $self->CheckGroupFile();
245        # Find the super-group genus.
246        $groupName =~ /([A-Z]\w+)/;
247        my $nameThing = $1;
248        # See if it's directly in the group hash.
249        if (exists $groupHash{$nameThing}) {
250            # Yes, then it's our result.
251            $retVal = $nameThing;
252        } else {
253            # No, so we have to search.
254            for my $superGroup (keys %groupHash) {
255                # Get this super-group's item list.
256                my $list = $groupHash{$superGroup}->{contents};
257                # Search it.
258                if (grep { $_->[0] eq $nameThing } @{$list}) {
259                    $retVal = $superGroup;
260                }
261            }
262            # Make sure we found something.
263            if (! $retVal) {
264                Confess("No super-group found for \"$groupName\".");
265            }
266        }
267        # Return the result.
268        return $retVal;
269  }  }
270    
271  =head3 MaxSegment  =head3 MaxSegment
272    
273  C<< my $length = $sprout->MaxSegment(); >>      my $length = $sprout->MaxSegment();
274    
275  This method returns the maximum permissible length of a feature segment. The length is important  This method returns the maximum permissible length of a feature segment. The length is important
276  because it enables us to make reasonable guesses at how to find features inside a particular  because it enables us to make reasonable guesses at how to find features inside a particular
# Line 124  Line 281 
281  =cut  =cut
282  #: Return Type $;  #: Return Type $;
283  sub MaxSegment {  sub MaxSegment {
284          my $self = shift @_;      my ($self) = @_;
285          return $self->{_options}->{maxSegmentLength};          return $self->{_options}->{maxSegmentLength};
286  }  }
287    
288  =head3 MaxSequence  =head3 MaxSequence
289    
290  C<< my $length = $sprout->MaxSequence(); >>      my $length = $sprout->MaxSequence();
291    
292  This method returns the maximum permissible length of a contig sequence. A contig is broken  This method returns the maximum permissible length of a contig sequence. A contig is broken
293  into sequences in order to save memory resources. In particular, when manipulating features,  into sequences in order to save memory resources. In particular, when manipulating features,
# Line 139  Line 296 
296  =cut  =cut
297  #: Return Type $;  #: Return Type $;
298  sub MaxSequence {  sub MaxSequence {
299          my $self = shift @_;      my ($self) = @_;
300          return $self->{_options}->{maxSequenceLength};          return $self->{_options}->{maxSequenceLength};
301  }  }
302    
303  =head3 Get  =head3 Load
   
 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.  
304    
305  C<< $query = $sprout->Get(['Genome'], "Genome(genus) = ?", [$genus]); >>      $sprout->Load($rebuild);;
306    
307  The WHERE clause contains a single question mark, so there is a single additional  Load the database from files in the data directory, optionally re-creating the tables.
 parameter representing the parameter value. It would also be possible to code  
308    
309  C<< $query = $sprout->Get(['Genome'], "Genome(genus) = \'$genus\'"); >>  This method always deletes the data from the database before loading, even if the tables are not
310    re-created. The data is loaded into the relations from files in the data directory either having the
311    same name as the target relation with no extension or with an extension of C<.dtx>. Files without an
312    extension are used in preference to the files with an extension.
313    
314  however, this version of the call would generate a syntax error if there were any quote  The files are loaded based on the presumption that each line of the file is a record in the
315  characters inside the variable C<$genus>.  relation, and the individual fields are delimited by tabs. Tab and new-line characters inside
316    fields must be represented by the escape sequences C<\t> and C<\n>, respectively. The fields must
317    be presented in the order given in the relation tables produced by the L</ShowMetaData> method.
318    
319  The use of the strange parenthesized notation for field names enables us to distinguish  =over 4
 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.  
320    
321  It is possible to specify multiple entity and relationship names in order to retrieve more than  =item rebuild
 one object's data at the same time, which allows highly complex joined queries. For example,  
322    
323  C<< $query = $sprout->Get(['Genome', 'ComesFrom', 'Source'], "Genome(genus) = ?", [$genus]); >>  TRUE if the data tables need to be created or re-created, else FALSE
324    
325  This query returns all the genomes for a particular genus and allows access to the  =item RETURN
 sources from which they came. The join clauses to go from Genome to Source are generated  
 automatically.  
326    
327  Finally, the filter clause can contain sort information. To do this, simply put an C<ORDER BY>  Returns a statistical object containing the number of records read, the number of duplicates found,
328  clause at the end of the filter. Field references in the ORDER BY section follow the same rules  the number of errors, and a list of the error messages.
 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.  
329    
330  C<< $query = $sprout->Get(['Genome'], "Genome(genus) = ? ORDER BY Genome(species)", [$genus]); >>  =back
331    
332  It is also permissible to specify I<only> an ORDER BY clause. For example, the following invocation gets  =cut
333  all genomes ordered by genus and species.  #: Return Type %;
334    sub Load {
335        # Get the parameters.
336        my ($self, $rebuild) = @_;
337        # Load the tables from the data directory.
338        my $retVal = $self->LoadTables($self->{_options}->{dataDir}, $rebuild);
339        # Return the statistics.
340        return $retVal;
341    }
342    
343  C<< $query = $sprout->Get(['Genome'], "ORDER BY Genome(genus), Genome(species)"); >>  =head3 LoadUpdate
344    
345  Odd things may happen if one of the ORDER BY fields is in a secondary relation. So, for example, an      my $stats = $sprout->LoadUpdate($truncateFlag, \@tableList);
 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.  
346    
347  If multiple names are specified, then the query processor will automatically determine a  Load updates to one or more database tables. This method enables the client to make changes to one
348  join path between the entities and relationships. The algorithm used is very simplistic.  or two tables without reloading the whole database. For each table, there must be a corresponding
349  In particular, you can't specify any entity or relationship more than once, and if a  file in the data directory, either with the same name as the table, or with a C<.dtx> suffix. So,
350  relationship is recursive, the path is determined by the order in which the entity  for example, to make updates to the B<FeatureTranslation> relation, there must be a
351  and the relationship appear. For example, consider a recursive relationship B<IsParentOf>  C<FeatureTranslation.dtx> file in the data directory. Unlike a full load, files without an extension
352  which relates B<People> objects to other B<People> objects. If the join path is  are not examined. This allows update files to co-exist with files from an original load.
 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.  
353    
354  =over 4  =over 4
355    
356  =item objectNames  =item truncateFlag
   
 List containing the names of the entity and relationship objects to be retrieved.  
   
 =item filterClause  
357    
358  WHERE/ORDER BY clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can  TRUE if the tables should be rebuilt before loading, else FALSE. A value of TRUE therefore causes
359  be parameterized with parameter markers (C<?>). Each field used must be specified in the standard form  current data and schema of the tables to be replaced, while a value of FALSE means the new data
360  B<I<objectName>(I<fieldName>)>. Any parameters specified in the filter clause should be added to the  is added to the existing data in the various relations.
 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.  
361    
362  =item parameterList  =item tableList
363    
364  List of the parameters to be substituted in for the parameters marks in the filter clause.  List of the tables to be updated.
365    
366  =item RETURN  =item RETURN
367    
368  Returns a B<DBQuery> that can be used to iterate through all of the results.  Returns a statistical object containing the number of records read, the number of duplicates found,
369    the number of errors encountered, and a list of error messages.
370    
371  =back  =back
372    
373  =cut  =cut
374    #: Return Type $%;
375  sub Get {  sub LoadUpdate {
376          # Get the parameters.          # Get the parameters.
377          my $self = shift @_;      my ($self, $truncateFlag, $tableList) = @_;
378          my ($objectNames, $filterClause, $parameterList) = @_;      # Declare the return value.
379          # We differ from the ERDB Get method in that the parameter list is passed in as a list reference      my $retVal = Stats->new();
380          # rather than a list of parameters. The next step is to convert the parameters from a reference      # Get the data directory.
381          # to a real list. We can only do this if the parameters have been specified.      my $optionTable = $self->{_options};
382          my @parameters;      my $dataDir = $optionTable->{dataDir};
383          if ($parameterList) { @parameters = @{$parameterList}; }      # Loop through the incoming table names.
384          return $self->{_erdb}->Get($objectNames, $filterClause, @parameters);      for my $tableName (@{$tableList}) {
385            # Find the table's file.
386            my $fileName = LoadFileName($dataDir, $tableName);
387            if (! $fileName) {
388                Trace("No load file found for $tableName in $dataDir.") if T(0);
389            } else {
390                # Attempt to load this table.
391                my $result = $self->LoadTable($fileName, $tableName, truncate => $truncateFlag);
392                # Accumulate the resulting statistics.
393                $retVal->Accumulate($result);
394            }
395        }
396        # Return the statistics.
397        return $retVal;
398  }  }
399    
400  =head3 GetEntity  =head3 GenomeCounts
401    
402  C<< my $entityObject = $sprout->GetEntity($entityType, $ID); >>      my ($arch, $bact, $euk, $vir, $env, $unk) = $sprout->GenomeCounts($complete);
403    
404  Return an object describing the entity instance with a specified ID.  Count the number of genomes in each domain. If I<$complete> is TRUE, only complete
405    genomes will be included in the counts.
406    
407  =over 4  =over 4
408    
409  =item entityType  =item complete
   
 Entity type name.  
   
 =item ID  
410    
411  ID of the desired entity.  TRUE if only complete genomes are to be counted, FALSE if all genomes are to be
412    counted
413    
414  =item RETURN  =item RETURN
415    
416  Returns a B<DBObject> representing the desired entity instance, or an undefined value if no  A six-element list containing the number of genomes in each of six categories--
417  instance is found with the specified key.  Archaea, Bacteria, Eukaryota, Viral, Environmental, and Unknown, respectively.
418    
419  =back  =back
420    
421  =cut  =cut
422    
423  sub GetEntity {  sub GenomeCounts {
424          # Get the parameters.          # Get the parameters.
425          my $self = shift @_;      my ($self, $complete) = @_;
426          my ($entityType, $ID) = @_;      # Set the filter based on the completeness flag.
427          # Create a query.      my $filter = ($complete ? "Genome(complete) = 1" : "");
428          my $query = $self->Get([$entityType], "$entityType(id) = ?", [$ID]);      # Get all the genomes and the related taxonomy information.
429          # Get the first (and only) object.      my @genomes = $self->GetAll(['Genome'], $filter, [], ['Genome(id)', 'Genome(taxonomy)']);
430          my $retVal = $query->Fetch();      # Clear the counters.
431          # Return the result.      my ($arch, $bact, $euk, $vir, $env, $unk) = (0, 0, 0, 0, 0, 0);
432          return $retVal;      # Loop through, counting the domains.
433        for my $genome (@genomes) {
434            if    ($genome->[1] =~ /^archaea/i)  { ++$arch }
435            elsif ($genome->[1] =~ /^bacter/i)   { ++$bact }
436            elsif ($genome->[1] =~ /^eukar/i)    { ++$euk }
437            elsif ($genome->[1] =~ /^vir/i)      { ++$vir }
438            elsif ($genome->[1] =~ /^env/i)      { ++$env }
439            else  { ++$unk }
440        }
441        # Return the counts.
442        return ($arch, $bact, $euk, $vir, $env, $unk);
443  }  }
444    
445  =head3 GetEntityValues  =head3 ContigCount
446    
447  C<< my @values = GetEntityValues($entityType, $ID, \@fields); >>      my $count = $sprout->ContigCount($genomeID);
448    
449  Return a list of values from a specified entity instance.  Return the number of contigs for the specified genome ID.
450    
451  =over 4  =over 4
452    
453  =item entityType  =item genomeID
   
 Entity type name.  
   
 =item ID  
   
 ID of the desired entity.  
   
 =item fields  
454    
455  List of field names, each of the form I<objectName>C<(>I<fieldName>C<)>.  ID of the genome whose contig count is desired.
456    
457  =item RETURN  =item RETURN
458    
459  Returns a flattened list of the values of the specified fields for the specified entity.  Returns the number of contigs for the specified genome.
460    
461  =back  =back
462    
463  =cut  =cut
464  #: Return Type @;  
465  sub GetEntityValues {  sub ContigCount {
466          # Get the parameters.          # Get the parameters.
467          my $self = shift @_;      my ($self, $genomeID) = @_;
468          my ($entityType, $ID, $fields) = @_;      # Get the contig count.
469          # Get the specified entity.      my $retVal = $self->GetCount(['Contig', 'HasContig'], "HasContig(from-link) = ?", [$genomeID]);
         my $entity = $self->GetEntity($entityType, $ID);  
         # Declare the return list.  
         my @retVal = ();  
         # If we found the entity, push the values into the return list.  
         if ($entity) {  
                 push @retVal, $entity->Values($fields);  
         }  
470          # Return the result.          # Return the result.
471          return @retVal;      return $retVal;
472  }  }
473    
474  =head3 ShowMetaData  =head3 GenomeMenu
475    
476  C<< $sprout->ShowMetaData($fileName); >>      my $html = $sprout->GenomeMenu(%options);
477    
478  This method outputs a description of the database to an HTML file in the data directory.  Generate a genome selection control with the specified name and options.
479    This control is almost but not quite the same as the genome control in the
480    B<SearchHelper> class. Eventually, the two will be combined.
481    
482  =over 4  =over 4
483    
484  =item fileName  =item options
485    
486  Fully-qualified name to give to the output file.  Optional parameters for the control (see below).
487    
488    =item RETURN
489    
490    Returns the HTML for a genome selection control on a form (sometimes called a popup menu).
491    
492  =back  =back
493    
494  =cut  The valid options are as follows.
495    
496  sub ShowMetaData {  =over 4
         # Get the parameters.  
         my $self = shift @_;  
         my ($fileName) = @_;  
         # Compute the file name.  
         my $options = $self->{_options};  
         # Call the show method on the underlying ERDB object.  
         $self->{_erdb}->ShowMetaData($fileName);  
 }  
497    
498  =head3 Load  =item name
499    
500  C<< $sprout->Load($rebuild); >>;  Name to give this control for use in passing it to the form. The default is C<myGenomeControl>.
501    Terrible things will happen if you have two controls with the same name on the same page.
502    
503  Load the database from files in the data directory, optionally re-creating the tables.  =item filter
504    
505  This method always deletes the data from the database before loading, even if the tables are not  If specified, a filter for the list of genomes to display. The filter should be in the form of a
506  re-created. The data is loaded into the relations from files in the data directory either having the  list reference. The first element of the list should be the filter string, and the remaining elements
507  same name as the target relation with no extension or with an extension of C<.dtx>. Files without an  the filter parameters.
 extension are used in preference to the files with an extension.  
508    
509  The files are loaded based on the presumption that each line of the file is a record in the  =item multiSelect
 relation, and the individual fields are delimited by tabs. Tab and new-line characters inside  
 fields must be represented by the escape sequences C<\t> and C<\n>, respectively. The fields must  
 be presented in the order given in the relation tables produced by the L</ShowMetaData> method.  
510    
511  =over 4  If TRUE, then the user can select multiple genomes. If FALSE, the user can only select one genome.
512    
513  =item rebuild  =item size
514    
515  TRUE if the data tables need to be created or re-created, else FALSE  Number of rows to display in the control. The default is C<10>
516    
517  =item RETURN  =item id
518    
519  Returns a statistical object containing the number of records read, the number of duplicates found,  ID to give this control. The default is the value of the C<name> option. Nothing will work correctly
520  the number of errors, and a list of the error messages.  unless this ID is unique.
521    
522    =item selected
523    
524    A comma-delimited list of selected genomes, or a reference to a list of selected genomes. The
525    default is none.
526    
527    =item class
528    
529    If specified, a style class to assign to the genome control.
530    
531  =back  =back
532    
533  =cut  =cut
534  #: Return Type %;  
535  sub Load {  sub GenomeMenu {
536          # Get the parameters.          # Get the parameters.
537          my $self = shift @_;      my ($self, %options) = @_;
538          my ($rebuild) = @_;      # Get the control's name and ID.
539          # Get the database object.      my $menuName = $options{name} || $options{id} || 'myGenomeControl';
540          my $erdb = $self->{_erdb};      my $menuID = $options{id} || $menuName;
541          # Load the tables from the data directory.      Trace("Genome menu name = $menuName with ID $menuID.") if T(3);
542          my $retVal = $erdb->LoadTables($self->{_options}->{dataDir}, $rebuild);      # Compute the IDs for the status display.
543          # Return the statistics.      my $divID = "${menuID}_status";
544        my $urlID = "${menuID}_url";
545        # Compute the code to show selected genomes in the status area.
546        my $showSelect = "showSelected('$menuID', '$divID', '$urlID', 1000)";
547        # Check for single-select or multi-select.
548        my $multiSelect = $options{multiSelect} || 0;
549        # Get the style data.
550        my $class = $options{class} || '';
551        # Get the list of pre-selected items.
552        my $selections = $options{selected} || [];
553        if (ref $selections ne 'ARRAY') {
554            $selections = [ split /\s*,\s*/, $selections ];
555        }
556        my %selected = map { $_ => 1 } @{$selections};
557        # Extract the filter information. The default is no filtering. It can be passed as a tab-delimited
558        # string or a list reference.
559        my $filterParms = $options{filter} || "";
560        if (! ref $filterParms) {
561            $filterParms = [split /\t|\\t/, $filterParms];
562        }
563        my $filterString = shift @{$filterParms};
564        # Get a list of all the genomes in group order. In fact, we only need them ordered
565        # by name (genus,species,strain), but putting primary-group in front enables us to
566        # take advantage of an existing index.
567        my @genomeList = $self->GetAll(['Genome'], "$filterString ORDER BY Genome(primary-group), Genome(genus), Genome(species), Genome(unique-characterization)",
568                                       $filterParms,
569                                       [qw(Genome(primary-group) Genome(id) Genome(genus) Genome(species) Genome(unique-characterization) Genome(taxonomy) Genome(contigs))]);
570        # Create a hash to organize the genomes by group. Each group will contain a list of
571        # 2-tuples, the first element being the genome ID and the second being the genome
572        # name.
573        my %gHash = ();
574        for my $genome (@genomeList) {
575            # Get the genome data.
576            my ($group, $genomeID, $genus, $species, $strain, $taxonomy, $contigs) = @{$genome};
577            # Compute its name. This is the genus, species, strain (if any), and the contig count.
578            my $name = "$genus $species ";
579            $name .= "$strain " if $strain;
580            my $contigCount = ($contigs == 1 ? "" : ", $contigs contigs");
581            # Now we get the domain. The domain tells us the display style of the organism.
582            my ($domain) = split /\s*;\s*/, $taxonomy, 2;
583            # Now compute the display group. This is normally the primary group, but if the
584            # organism is supporting, we blank it out.
585            my $displayGroup = ($group eq $FIG_Config::otherGroup ? "" : $group);
586            # Push the genome into the group's list. Note that we use the real group
587            # name for the hash key here, not the display group name.
588            push @{$gHash{$group}}, [$genomeID, $name, $contigCount, $domain];
589        }
590        # We are almost ready to unroll the menu out of the group hash. The final step is to separate
591        # the supporting genomes by domain. First, we extract the NMPDR groups and sort them. They
592        # are sorted by the first capitalized word. Groups with "other" are sorted after groups
593        # that aren't "other". At some point, we will want to make this less complicated.
594        my %sortGroups = map { $_ =~ /(other)?(.*)([A-Z].+)/; "$3$1$2" => $_ }
595                             grep { $_ ne $FIG_Config::otherGroup } keys %gHash;
596        my @groups = map { $sortGroups{$_} } sort keys %sortGroups;
597        # Remember the number of NMPDR groups.
598        my $nmpdrGroupCount = scalar @groups;
599        # Loop through the supporting genomes, classifying them by domain. We'll also keep a list
600        # of the domains found.
601        my @otherGenomes = @{$gHash{$FIG_Config::otherGroup}};
602        my @domains = ();
603        for my $genomeData (@otherGenomes) {
604            my ($genomeID, $name, $contigCount, $domain) = @{$genomeData};
605            if (exists $gHash{$domain}) {
606                push @{$gHash{$domain}}, $genomeData;
607            } else {
608                $gHash{$domain} = [$genomeData];
609                push @domains, $domain;
610            }
611        }
612        # Add the domain groups at the end of the main group list. The main group list will now
613        # contain all the categories we need to display the genomes.
614        push @groups, sort @domains;
615        # Delete the supporting group.
616        delete $gHash{$FIG_Config::otherGroup};
617        # Now it gets complicated. We need a way to mark all the NMPDR genomes. We take advantage
618        # of the fact they come first in the list. We'll accumulate a count of the NMPDR genomes
619        # and use that to make the selections.
620        my $nmpdrCount = 0;
621        # Create the type counters.
622        my $groupCount = 1;
623        # Get the number of rows to display.
624        my $rows = $options{size} || 10;
625        # If we're multi-row, create an onChange event.
626        my $onChangeTag = ( $rows > 1 ? " onChange=\"$showSelect;\" onFocus=\"$showSelect;\"" : "" );
627        # Set up the multiple-select flag.
628        my $multipleTag = ($multiSelect ? " multiple" : "" );
629        # Set up the style class.
630        my $classTag = ($class ? " class=\"$class\"" : "" );
631        # Create the SELECT tag and stuff it into the output array.
632        my @lines = ("<SELECT name=\"$menuName\" id=\"$menuID\" $onChangeTag$multipleTag$classTag size=\"$rows\">");
633        # Loop through the groups.
634        for my $group (@groups) {
635            # Get the genomes in the group.
636            for my $genome (@{$gHash{$group}}) {
637                # If this is an NMPDR organism, we add an extra style and count it.
638                my $nmpdrStyle = "";
639                if ($nmpdrGroupCount > 0) {
640                    $nmpdrCount++;
641                    $nmpdrStyle = " Core";
642                }
643                # Get the organism ID, name, contig count, and domain.
644                my ($genomeID, $name, $contigCount, $domain) = @{$genome};
645                # See if we're pre-selected.
646                my $selectTag = ($selected{$genomeID} ? " SELECTED" : "");
647                # Compute the display name.
648                my $nameString = "$name ($genomeID$contigCount)";
649                # Generate the option tag.
650                my $optionTag = "<OPTION class=\"$domain$nmpdrStyle\" title=\"$group\" value=\"$genomeID\"$selectTag>$nameString</OPTION>";
651                push @lines, "    $optionTag";
652            }
653            # Record this group in the nmpdrGroup count. When that gets to 0, we've finished the NMPDR
654            # groups.
655            $nmpdrGroupCount--;
656        }
657        # Close the SELECT tag.
658        push @lines, "</SELECT>";
659        if ($rows > 1) {
660            # We're in a non-compact mode, so we need to add some selection helpers. First is
661            # the search box. This allows the user to type text and change which genomes are
662            # displayed. For multiple-select mode, we include a button that selects the displayed
663            # genes. For single-select mode, we use a plain label instead.
664            my $searchThingName = "${menuID}_SearchThing";
665            my $searchThingLabel = ($multiSelect ? "<INPUT type=\"button\" name=\"MacroSearch\" class=\"button\" value=\"Select genomes containing\" onClick=\"selectShowing('$menuID', '$searchThingName'); $showSelect;\" />"
666                                                 : "Show genomes containing");
667            push @lines, "<br />$searchThingLabel&nbsp;" .
668                         "<INPUT type=\"text\" id=\"$searchThingName\" name=\"$searchThingName\" size=\"30\" onKeyup=\"showTyped('$menuID', '$searchThingName');\" />" .
669                         Hint("GenomeControl", "Type here to filter the genomes displayed.") . "<br />";
670            # For multi-select mode, we also have buttons to set and clear selections.
671            if ($multiSelect) {
672                push @lines, "<INPUT type=\"button\" name=\"ClearAll\" class=\"bigButton\"  value=\"Clear All\" onClick=\"clearAll('$menuID'); $showSelect\" />";
673                push @lines, "<INPUT type=\"button\" name=\"SelectAll\" class=\"bigButton\" value=\"Select All\" onClick=\"selectAll('$menuID'); $showSelect\" />";
674                push @lines, "<INPUT type=\"button\" name=\"NMPDROnly\" class=\"bigButton\"  value=\"Select NMPDR\" onClick=\"selectSome('$menuID', $nmpdrCount, true); $showSelect;\" />";
675            }
676            # Add a hidden field we can use to generate organism page hyperlinks.
677            push @lines, "<INPUT type=\"hidden\" id=\"$urlID\" value=\"$FIG_Config::cgi_url/wiki/rest.cgi/NmpdrPlugin/SeedViewer?page=Organism;organism=\" />";
678            # Add the status display. This tells the user what's selected no matter where the list is scrolled.
679            push @lines, "<DIV id=\"$divID\" class=\"Panel\"></DIV>";
680        }
681        # Assemble all the lines into a string.
682        my $retVal = join("\n", @lines, "");
683        # Return the result.
684          return $retVal;          return $retVal;
685  }  }
686    
 =head3 LoadUpdate  
   
 C<< my %stats = $sprout->LoadUpdate($truncateFlag, \@tableList); >>  
687    
688  Load updates to one or more database tables. This method enables the client to make changes to one  =head3 Stem
 or two tables without reloading the whole database. For each table, there must be a corresponding  
 file in the data directory, either with the same name as the table, or with a C<.dtx> suffix. So,  
 for example, to make updates to the B<FeatureTranslation> relation, there must be a  
 C<FeatureTranslation.dtx> file in the data directory. Unlike a full load, files without an extension  
 are not examined. This allows update files to co-exist with files from an original load.  
689    
690  =over 4      my $stem = $sprout->Stem($word);
691    
692  =item truncateFlag  Return the stem of the specified word, or C<undef> if the word is not
693    stemmable. Note that even if the word is stemmable, the stem may be
694    the same as the original word.
695    
696  TRUE if the tables should be rebuilt before loading, else FALSE. A value of TRUE therefore causes  =over 4
 current data and schema of the tables to be replaced, while a value of FALSE means the new data  
 is added to the existing data in the various relations.  
697    
698  =item tableList  =item word
699    
700  List of the tables to be updated.  Word to convert into a stem.
701    
702  =item RETURN  =item RETURN
703    
704  Returns a statistical object containing the number of records read, the number of duplicates found,  Returns a stem of the word (which may be the word itself), or C<undef> if
705  the number of errors encountered, and a list of error messages.  the word is not stemmable.
706    
707  =back  =back
708    
709  =cut  =cut
710  #: Return Type %;  
711  sub LoadUpdate {  sub Stem {
712          # Get the parameters.          # Get the parameters.
713          my $self = shift @_;      my ($self, $word) = @_;
714          my ($truncateFlag, $tableList) = @_;      # Declare the return variable.
715          # Get the database object.      my $retVal;
716          my $erdb = $self->{_erdb};      # See if it's stemmable.
717          # Declare the return value.      if ($word =~ /^[A-Za-z]+$/) {
718          my $retVal = Stats->new();          # Compute the stem.
719          # Get the data directory.          my $stemList = $self->{stemmer}->stem($word);
720          my $optionTable = $self->{_options};          my $stem = $stemList->[0];
721          my $dataDir = $optionTable->{dataDir};          # Check to see if it's long enough.
722          # Loop through the incoming table names.          if (length $stem >= 3) {
723          for my $tableName (@{$tableList}) {              # Yes, keep it.
724                  # Find the table's file.              $retVal = $stem;
725                  my $fileName = "$dataDir/$tableName";          } else {
726                  if (! -e $fileName) {              # No, use the original word.
727                          $fileName = "$fileName.dtx";              $retVal = $word;
728                  }                  }
                 # Attempt to load this table.  
                 my $result = $erdb->LoadTable($fileName, $tableName, $truncateFlag);  
                 # Accumulate the resulting statistics.  
                 $retVal->Accumulate($result);  
729          }          }
730          # Return the statistics.      # Return the result.
731          return $retVal;          return $retVal;
732  }  }
733    
734    
735  =head3 Build  =head3 Build
736    
737  C<< $sprout->Build(); >>      $sprout->Build();
738    
739  Build the database. The database will be cleared and the tables re-created from the metadata.  Build the database. The database will be cleared and the tables re-created from the metadata.
740  This method is useful when a database is brand new or when the database definition has  This method is useful when a database is brand new or when the database definition has
# Line 463  Line 744 
744  #: Return Type ;  #: Return Type ;
745  sub Build {  sub Build {
746          # Get the parameters.          # Get the parameters.
747          my $self = shift @_;      my ($self) = @_;
748          # Create the tables.          # Create the tables.
749          $self->{_erdb}->CreateTables;      $self->CreateTables();
750  }  }
751    
752  =head3 Genomes  =head3 Genomes
753    
754  C<< my @genomes = $sprout->Genomes(); >>      my @genomes = $sprout->Genomes();
755    
756  Return a list of all the genome IDs.  Return a list of all the genome IDs.
757    
# Line 478  Line 759 
759  #: Return Type @;  #: Return Type @;
760  sub Genomes {  sub Genomes {
761          # Get the parameters.          # Get the parameters.
762          my $self = shift @_;      my ($self) = @_;
763          # Get all the genomes.          # Get all the genomes.
764          my @retVal = $self->GetFlat(['Genome'], "", [], 'Genome(id)');          my @retVal = $self->GetFlat(['Genome'], "", [], 'Genome(id)');
765          # Return the list of IDs.          # Return the list of IDs.
# Line 487  Line 768 
768    
769  =head3 GenusSpecies  =head3 GenusSpecies
770    
771  C<< my $infoString = $sprout->GenusSpecies($genomeID); >>      my $infoString = $sprout->GenusSpecies($genomeID);
772    
773  Return the genus, species, and unique characterization for a genome.  Return the genus, species, and unique characterization for a genome.
774    
# Line 508  Line 789 
789  #: Return Type $;  #: Return Type $;
790  sub GenusSpecies {  sub GenusSpecies {
791          # Get the parameters.          # Get the parameters.
792          my $self = shift @_;      my ($self, $genomeID) = @_;
         my ($genomeID) = @_;  
793          # Get the data for the specified genome.          # Get the data for the specified genome.
794          my @values = $self->GetEntityValues('Genome', $genomeID, ['Genome(genus)', 'Genome(species)',          my @values = $self->GetEntityValues('Genome', $genomeID, ['Genome(genus)', 'Genome(species)',
795                                                                                                                            'Genome(unique-characterization)']);                                                                                                                            'Genome(unique-characterization)']);
# Line 520  Line 800 
800    
801  =head3 FeaturesOf  =head3 FeaturesOf
802    
803  C<< my @features = $sprout->FeaturesOf($genomeID, $ftype); >>      my @features = $sprout->FeaturesOf($genomeID, $ftype);
804    
805  Return a list of the features relevant to a specified genome.  Return a list of the features relevant to a specified genome.
806    
# Line 545  Line 825 
825  #: Return Type @;  #: Return Type @;
826  sub FeaturesOf {  sub FeaturesOf {
827          # Get the parameters.          # Get the parameters.
828          my $self = shift @_;      my ($self, $genomeID,$ftype) = @_;
         my ($genomeID,$ftype) = @_;  
829          # Get the features we want.          # Get the features we want.
830          my @features;          my @features;
831          if (!$ftype) {          if (!$ftype) {
# Line 566  Line 845 
845    
846  =head3 FeatureLocation  =head3 FeatureLocation
847    
848  C<< my @locations = $sprout->FeatureLocation($featureID); >>      my @locations = $sprout->FeatureLocation($featureID);
849    
850  Return the location of a feature in its genome's contig segments. In a list context, this method  Return the location of a feature in its genome's contig segments. In a list context, this method
851  will return a list of the locations. In a scalar context, it will return the locations as a space-  will return a list of the locations. In a scalar context, it will return the locations as a space-
# Line 590  Line 869 
869  =item RETURN  =item RETURN
870    
871  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
872  context and as a space-delimited string in a scalar context.  context and as a comma-delimited string in a scalar context. An empty list means the feature
873    wasn't found.
874    
875  =back  =back
876    
877  =cut  =cut
878  #: Return Type @;  
 #: Return Type $;  
879  sub FeatureLocation {  sub FeatureLocation {
880          # Get the parameters.          # Get the parameters.
881          my $self = shift @_;      my ($self, $featureID) = @_;
882          my ($featureID) = @_;      # Declare the return variable.
         # Create a query for the feature locations.  
         my $query = $self->Get(['IsLocatedIn'], "IsLocatedIn(from-link) = ? ORDER BY IsLocatedIn(locN)",  
                                                    [$featureID]);  
         # Create the return list.  
883          my @retVal = ();          my @retVal = ();
884          # Set up the variables used to determine if we have adjacent segments. This initial setup will      # Get the feature record.
885          # not match anything.      my $object = $self->GetEntity('Feature', $featureID);
886          my ($prevContig, $prevBeg, $prevDir, $prevLen) = ("", 0, "0", 0);      # Only proceed if we found it.
887          # Loop through the query results, creating location specifiers.      if (defined $object) {
888          while (my $location = $query->Fetch()) {          # Get the location string.
889                  # Get the location parameters.          my $locString = $object->PrimaryValue('Feature(location-string)');
890                  my ($contigID, $beg, $dir, $len) = $location->Values(['IsLocatedIn(to-link)',          # Create the return list.
891                          'IsLocatedIn(beg)', 'IsLocatedIn(dir)', 'IsLocatedIn(len)']);          @retVal = split /\s*,\s*/, $locString;
                 # Check to see if we are adjacent to the previous segment.  
                 if ($prevContig eq $contigID && $dir eq $prevDir) {  
                         # Here the new segment is in the same direction on the same contig. Insure the  
                         # new segment's beginning is next to the old segment's end.  
                         if (($dir eq "-" && $beg == $prevBeg - $prevLen) ||  
                                 ($dir eq "+" && $beg == $prevBeg + $prevLen)) {  
                                 # Here we need to merge two segments. Adjust the beginning and length values  
                                 # to include both segments.  
                                 $beg = $prevBeg;  
                                 $len += $prevLen;  
                                 # Pop the old segment off. The new one will replace it later.  
                                 pop @retVal;  
                         }  
                 }  
                 # Remember this specifier for the adjacent-segment test the next time through.  
                 ($prevContig, $prevBeg, $prevDir, $prevLen) = ($contigID, $beg, $dir, $len);  
                 # Add the specifier to the list.  
                 push @retVal, "${contigID}_$beg$dir$len";  
892          }          }
893          # Return the list in the format indicated by the context.          # Return the list in the format indicated by the context.
894          return (wantarray ? @retVal : join(' ', @retVal));      return (wantarray ? @retVal : join(',', @retVal));
895  }  }
896    
897  =head3 ParseLocation  =head3 ParseLocation
898    
899  C<< my ($contigID, $start, $dir, $len) = Sprout::ParseLocation($location); >>      my ($contigID, $start, $dir, $len) = Sprout::ParseLocation($location);
900    
901  Split a location specifier into the contig ID, the starting point, the direction, and the  Split a location specifier into the contig ID, the starting point, the direction, and the
902  length.  length.
# Line 658  Line 915 
915  =back  =back
916    
917  =cut  =cut
918  #: Return Type @;  
919  sub ParseLocation {  sub ParseLocation {
920          # Get the parameter.      # Get the parameter. Note that if we're called as an instance method, we ignore
921        # the first parameter.
922        shift if UNIVERSAL::isa($_[0],__PACKAGE__);
923          my ($location) = @_;          my ($location) = @_;
924          # Parse it into segments.          # Parse it into segments.
925          $location =~ /^(.*)_(\d*)([+-_])(\d*)$/;      $location =~ /^(.+)_(\d+)([+\-_])(\d+)$/;
926          my ($contigID, $start, $dir, $len) = ($1, $2, $3, $4);          my ($contigID, $start, $dir, $len) = ($1, $2, $3, $4);
927          # If the direction is an underscore, convert it to a + or -.          # If the direction is an underscore, convert it to a + or -.
928          if ($dir eq "_") {          if ($dir eq "_") {
# Line 679  Line 938 
938          return ($contigID, $start, $dir, $len);          return ($contigID, $start, $dir, $len);
939  }  }
940    
941    
942    
943    =head3 PointLocation
944    
945        my $found = Sprout::PointLocation($location, $point);
946    
947    Return the offset into the specified location of the specified point on the contig. If
948    the specified point is before the location, a negative value will be returned. If it is
949    beyond the location, an undefined value will be returned. It is assumed that the offset
950    is for the location's contig. The location can either be new-style (using a C<+> or C<->
951    and a length) or old-style (using C<_> and start and end positions.
952    
953    =over 4
954    
955    =item location
956    
957    A location specifier (see L</FeatureLocation> for a description).
958    
959    =item point
960    
961    The offset into the contig of the point in which we're interested.
962    
963    =item RETURN
964    
965    Returns the offset inside the specified location of the specified point, a negative
966    number if the point is before the location, or an undefined value if the point is past
967    the location. If the length of the location is 0, this method will B<always> denote
968    that it is outside the location. The offset will always be relative to the left-most
969    position in the location.
970    
971    =back
972    
973    =cut
974    
975    sub PointLocation {
976        # Get the parameter. Note that if we're called as an instance method, we ignore
977        # the first parameter.
978        shift if UNIVERSAL::isa($_[0],__PACKAGE__);
979        my ($location, $point) = @_;
980        # Parse out the location elements. Note that this works on both old-style and new-style
981        # locations.
982        my ($contigID, $start, $dir, $len) = ParseLocation($location);
983        # Declare the return variable.
984        my $retVal;
985        # Compute the offset. The computation is dependent on the direction of the location.
986        my $offset = (($dir == '+') ? $point - $start : $point - ($start - $len + 1));
987        # Return the offset if it's valid.
988        if ($offset < $len) {
989            $retVal = $offset;
990        }
991        # Return the offset found.
992        return $retVal;
993    }
994    
995  =head3 DNASeq  =head3 DNASeq
996    
997  C<< my $sequence = $sprout->DNASeq(\@locationList); >>      my $sequence = $sprout->DNASeq(\@locationList);
998    
999  This method returns the DNA sequence represented by a list of locations. The list of locations  This method returns the DNA sequence represented by a list of locations. The list of locations
1000  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,
1001  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>.
1002    
1003    For example, the following would return the DNA sequence for contig C<83333.1:NC_000913>
1004    between positions 1401 and 1532, inclusive.
1005    
1006        my $sequence = $sprout->DNASeq('83333.1:NC_000913_1401_1532');
1007    
1008  =over 4  =over 4
1009    
1010  =item locationList  =item locationList
1011    
1012  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
1013  L</FeatureLocation> for more about this format).  I<contigID>C<_>I<begin>C<_>I<end> (see L</FeatureLocation> for more about this format).
1014    
1015  =item RETURN  =item RETURN
1016    
# Line 704  Line 1022 
1022  #: Return Type $;  #: Return Type $;
1023  sub DNASeq {  sub DNASeq {
1024          # Get the parameters.          # Get the parameters.
1025          my $self = shift @_;      my ($self, $locationList) = @_;
         my ($locationList) = @_;  
1026          # Create the return string.          # Create the return string.
1027          my $retVal = "";          my $retVal = "";
1028          # Loop through the locations.          # Loop through the locations.
# Line 720  Line 1037 
1037                  # 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
1038                  # before putting it in the return value.                  # before putting it in the return value.
1039                  my ($start, $stop);                  my ($start, $stop);
1040            Trace("Parse of \"$location\" is $beg$dir$len.") if T(SDNA => 4);
1041                  if ($dir eq "+") {                  if ($dir eq "+") {
1042                          $start = $beg;                          $start = $beg;
1043                          $stop = $beg + $len - 1;                          $stop = $beg + $len - 1;
1044                  } else {                  } else {
1045                          $start = $beg + $len + 1;              $start = $beg - $len + 1;
1046                          $stop = $beg;                          $stop = $beg;
1047                  }                  }
1048            Trace("Looking for sequences containing $start through $stop.") if T(SDNA => 4);
1049                  my $query = $self->Get(['IsMadeUpOf','Sequence'],                  my $query = $self->Get(['IsMadeUpOf','Sequence'],
1050                          "IsMadeUpOf(from-link) = ? AND IsMadeUpOf(start-position) + IsMadeUpOf(len) > ? AND " .                          "IsMadeUpOf(from-link) = ? AND IsMadeUpOf(start-position) + IsMadeUpOf(len) > ? AND " .
1051                          " IsMadeUpOf(start-position) <= ? ORDER BY IsMadeUpOf(start-position)",                          " IsMadeUpOf(start-position) <= ? ORDER BY IsMadeUpOf(start-position)",
# Line 738  Line 1057 
1057                                  $sequence->Values(['IsMadeUpOf(start-position)', 'Sequence(sequence)',                                  $sequence->Values(['IsMadeUpOf(start-position)', 'Sequence(sequence)',
1058                                                                     'IsMadeUpOf(len)']);                                                                     'IsMadeUpOf(len)']);
1059                          my $stopPosition = $startPosition + $sequenceLength;                          my $stopPosition = $startPosition + $sequenceLength;
1060                Trace("Sequence is from $startPosition to $stopPosition.") if T(SDNA => 4);
1061                          # Figure out the start point and length of the relevant section.                          # Figure out the start point and length of the relevant section.
1062                          my $pos1 = ($start < $startPosition ? 0 : $start - $startPosition);                          my $pos1 = ($start < $startPosition ? 0 : $start - $startPosition);
1063                          my $len = ($stopPosition <= $stop ? $stopPosition : $stop) - $startPosition - $pos1;              my $len1 = ($stopPosition < $stop ? $stopPosition : $stop) + 1 - $startPosition - $pos1;
1064                Trace("Position is $pos1 for length $len1.") if T(SDNA => 4);
1065                          # Add the relevant data to the location data.                          # Add the relevant data to the location data.
1066                          $locationDNA .= substr($sequenceData, $pos1, $len);              $locationDNA .= substr($sequenceData, $pos1, $len1);
1067                  }                  }
1068                  # 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.
1069                  if ($dir eq '+') {                  if ($dir eq '+') {
1070                          $retVal .= $locationDNA;                          $retVal .= $locationDNA;
1071                  } else {                  } else {
1072                          $locationDNA = join('', reverse split //, $locationDNA);              $retVal .= FIG::reverse_comp($locationDNA);
                         $retVal .= $locationDNA;  
1073                  }                  }
1074          }          }
1075          # Return the result.          # Return the result.
# Line 758  Line 1078 
1078    
1079  =head3 AllContigs  =head3 AllContigs
1080    
1081  C<< my @idList = $sprout->AllContigs($genomeID); >>      my @idList = $sprout->AllContigs($genomeID);
1082    
1083  Return a list of all the contigs for a genome.  Return a list of all the contigs for a genome.
1084    
# Line 778  Line 1098 
1098  #: Return Type @;  #: Return Type @;
1099  sub AllContigs {  sub AllContigs {
1100          # Get the parameters.          # Get the parameters.
1101          my $self = shift @_;      my ($self, $genomeID) = @_;
         my ($genomeID) = @_;  
1102          # Ask for the genome's Contigs.          # Ask for the genome's Contigs.
1103          my @retVal = $self->GetFlat(['HasContig'], "HasContig(from-link) = ?", [$genomeID],          my @retVal = $self->GetFlat(['HasContig'], "HasContig(from-link) = ?", [$genomeID],
1104                                                                  'HasContig(to-link)');                                                                  'HasContig(to-link)');
# Line 787  Line 1106 
1106          return @retVal;          return @retVal;
1107  }  }
1108    
1109    =head3 GenomeLength
1110    
1111        my $length = $sprout->GenomeLength($genomeID);
1112    
1113    Return the length of the specified genome in base pairs.
1114    
1115    =over 4
1116    
1117    =item genomeID
1118    
1119    ID of the genome whose base pair count is desired.
1120    
1121    =item RETURN
1122    
1123    Returns the number of base pairs in all the contigs of the specified
1124    genome.
1125    
1126    =back
1127    
1128    =cut
1129    
1130    sub GenomeLength {
1131        # Get the parameters.
1132        my ($self, $genomeID) = @_;
1133        # Declare the return variable.
1134        my $retVal = 0;
1135        # Get the genome's contig sequence lengths.
1136        my @lens = $self->GetFlat(['HasContig', 'IsMadeUpOf'], 'HasContig(from-link) = ?',
1137                           [$genomeID], 'IsMadeUpOf(len)');
1138        # Sum the lengths.
1139        map { $retVal += $_ } @lens;
1140        # Return the result.
1141        return $retVal;
1142    }
1143    
1144    =head3 FeatureCount
1145    
1146        my $count = $sprout->FeatureCount($genomeID, $type);
1147    
1148    Return the number of features of the specified type in the specified genome.
1149    
1150    =over 4
1151    
1152    =item genomeID
1153    
1154    ID of the genome whose feature count is desired.
1155    
1156    =item type
1157    
1158    Type of feature to count (eg. C<peg>, C<rna>, etc.).
1159    
1160    =item RETURN
1161    
1162    Returns the number of features of the specified type for the specified genome.
1163    
1164    =back
1165    
1166    =cut
1167    
1168    sub FeatureCount {
1169        # Get the parameters.
1170        my ($self, $genomeID, $type) = @_;
1171        # Compute the count.
1172        my $retVal = $self->GetCount(['HasFeature', 'Feature'],
1173                                    "HasFeature(from-link) = ? AND Feature(feature-type) = ?",
1174                                    [$genomeID, $type]);
1175        # Return the result.
1176        return $retVal;
1177    }
1178    
1179    =head3 GenomeAssignments
1180    
1181        my $fidHash = $sprout->GenomeAssignments($genomeID);
1182    
1183    Return a list of a genome's assigned features. The return hash will contain each
1184    assigned feature of the genome mapped to the text of its most recent functional
1185    assignment.
1186    
1187    =over 4
1188    
1189    =item genomeID
1190    
1191    ID of the genome whose functional assignments are desired.
1192    
1193    =item RETURN
1194    
1195    Returns a reference to a hash which maps each feature to its most recent
1196    functional assignment.
1197    
1198    =back
1199    
1200    =cut
1201    
1202    sub GenomeAssignments {
1203        # Get the parameters.
1204        my ($self, $genomeID) = @_;
1205        # Declare the return variable.
1206        my $retVal = {};
1207        # Query the genome's features.
1208        my $query = $self->Get(['HasFeature', 'Feature'], "HasFeature(from-link) = ?",
1209                               [$genomeID]);
1210        # Loop through the features.
1211        while (my $data = $query->Fetch) {
1212            # Get the feature ID and assignment.
1213            my ($fid, $assignment) = $data->Values(['Feature(id)', 'Feature(assignment)']);
1214            if ($assignment) {
1215                $retVal->{$fid} = $assignment;
1216            }
1217        }
1218        # Return the result.
1219        return $retVal;
1220    }
1221    
1222  =head3 ContigLength  =head3 ContigLength
1223    
1224  C<< my $length = $sprout->ContigLength($contigID); >>      my $length = $sprout->ContigLength($contigID);
1225    
1226  Compute the length of a contig.  Compute the length of a contig.
1227    
# Line 809  Line 1241 
1241  #: Return Type $;  #: Return Type $;
1242  sub ContigLength {  sub ContigLength {
1243          # Get the parameters.          # Get the parameters.
1244          my $self = shift @_;      my ($self, $contigID) = @_;
         my ($contigID) = @_;  
1245          # Get the contig's last sequence.          # Get the contig's last sequence.
1246          my $query = $self->Get(['IsMadeUpOf'],          my $query = $self->Get(['IsMadeUpOf'],
1247                  "IsMadeUpOf(from-link) = ? ORDER BY IsMadeUpOf(start-position) DESC",                  "IsMadeUpOf(from-link) = ? ORDER BY IsMadeUpOf(start-position) DESC",
# Line 821  Line 1252 
1252          # Set it from the sequence data, if any.          # Set it from the sequence data, if any.
1253          if ($sequence) {          if ($sequence) {
1254                  my ($start, $len) = $sequence->Values(['IsMadeUpOf(start-position)', 'IsMadeUpOf(len)']);                  my ($start, $len) = $sequence->Values(['IsMadeUpOf(start-position)', 'IsMadeUpOf(len)']);
1255                  $retVal = $start + $len;          $retVal = $start + $len - 1;
1256        }
1257        # Return the result.
1258        return $retVal;
1259    }
1260    
1261    =head3 ClusterPEGs
1262    
1263        my $clusteredList = $sprout->ClusterPEGs($sub, \@pegs);
1264    
1265    Cluster the PEGs in a list according to the cluster coding scheme of the specified
1266    subsystem. In order for this to work properly, the subsystem object must have
1267    been used recently to retrieve the PEGs using the B<get_pegs_from_cell> or
1268    B<get_row> methods. This causes the cluster numbers to be pulled into the
1269    subsystem's color hash. If a PEG is not found in the color hash, it will not
1270    appear in the output sequence.
1271    
1272    =over 4
1273    
1274    =item sub
1275    
1276    Sprout subsystem object for the relevant subsystem, from the L</get_subsystem>
1277    method.
1278    
1279    =item pegs
1280    
1281    Reference to the list of PEGs to be clustered.
1282    
1283    =item RETURN
1284    
1285    Returns a list of the PEGs, grouped into smaller lists by cluster number.
1286    
1287    =back
1288    
1289    =cut
1290    #: Return Type $@@;
1291    sub ClusterPEGs {
1292        # Get the parameters.
1293        my ($self, $sub, $pegs) = @_;
1294        # Declare the return variable.
1295        my $retVal = [];
1296        # Loop through the PEGs, creating arrays for each cluster.
1297        for my $pegID (@{$pegs}) {
1298            my $clusterNumber = $sub->get_cluster_number($pegID);
1299            # Only proceed if the PEG is in a cluster.
1300            if ($clusterNumber >= 0) {
1301                # Push this PEG onto the sub-list for the specified cluster number.
1302                push @{$retVal->[$clusterNumber]}, $pegID;
1303            }
1304          }          }
1305          # Return the result.          # Return the result.
1306          return $retVal;          return $retVal;
# Line 829  Line 1308 
1308    
1309  =head3 GenesInRegion  =head3 GenesInRegion
1310    
1311  C<< my (\@featureIDList, $beg, $end) = $sprout->GenesInRegion($contigID, $start, $stop); >>      my (\@featureIDList, $beg, $end) = $sprout->GenesInRegion($contigID, $start, $stop);
1312    
1313  List the features which overlap a specified region in a contig.  List the features which overlap a specified region in a contig.
1314    
# Line 852  Line 1331 
1331  Returns a three-element list. The first element is a list of feature IDs for the features that  Returns a three-element list. The first element is a list of feature IDs for the features that
1332  overlap the region of interest. The second and third elements are the minimum and maximum  overlap the region of interest. The second and third elements are the minimum and maximum
1333  locations of the features provided on the specified contig. These may extend outside  locations of the features provided on the specified contig. These may extend outside
1334  the start and stop values.  the start and stop values. The first element (that is, the list of features) is sorted
1335    roughly by location.
1336    
1337  =back  =back
1338    
1339  =cut  =cut
1340  #: Return Type @;  
1341  sub GenesInRegion {  sub GenesInRegion {
1342          # Get the parameters.          # Get the parameters.
1343          my $self = shift @_;      my ($self, $contigID, $start, $stop) = @_;
1344          my ($contigID, $start, $stop) = @_;      # Get the maximum segment length.
1345        my $maximumSegmentLength = $self->MaxSegment;
1346        # Prime the values we'll use for the returned beginning and end.
1347        my @initialMinMax = ($self->ContigLength($contigID), 0);
1348        my ($min, $max) = @initialMinMax;
1349        # Get the overlapping features.
1350        my @featureObjects = $self->GeneDataInRegion($contigID, $start, $stop);
1351        # We'l use this hash to help us track the feature IDs and sort them. The key is the
1352        # feature ID and the value is a [$left,$right] pair indicating the maximum extent
1353        # of the feature's locations.
1354        my %featureMap = ();
1355        # Loop through them to do the begin/end analysis.
1356        for my $featureObject (@featureObjects) {
1357            # Get the feature's location string. This may contain multiple actual locations.
1358            my ($locations, $fid) = $featureObject->Values([qw(Feature(location-string) Feature(id))]);
1359            my @locationSegments = split /\s*,\s*/, $locations;
1360            # Loop through the locations.
1361            for my $locationSegment (@locationSegments) {
1362                # Construct an object for the location.
1363                my $locationObject = BasicLocation->new($locationSegment);
1364                # Merge the current segment's begin and end into the min and max.
1365                my ($left, $right) = ($locationObject->Left, $locationObject->Right);
1366                my ($beg, $end);
1367                if (exists $featureMap{$fid}) {
1368                    ($beg, $end) = @{$featureMap{$fid}};
1369                    $beg = $left if $left < $beg;
1370                    $end = $right if $right > $end;
1371                } else {
1372                    ($beg, $end) = ($left, $right);
1373                }
1374                $min = $beg if $beg < $min;
1375                $max = $end if $end > $max;
1376                # Store the feature's new extent back into the hash table.
1377                $featureMap{$fid} = [$beg, $end];
1378            }
1379        }
1380        # Now we must compute the list of the IDs for the features found. We start with a list
1381        # of midpoints / feature ID pairs. (It's not really a midpoint, it's twice the midpoint,
1382        # but the result of the sort will be the same.)
1383        my @list = map { [$featureMap{$_}->[0] + $featureMap{$_}->[1], $_] } keys %featureMap;
1384        # Now we sort by midpoint and yank out the feature IDs.
1385        my @retVal = map { $_->[1] } sort { $a->[0] <=> $b->[0] } @list;
1386        # Return it along with the min and max.
1387        return (\@retVal, $min, $max);
1388    }
1389    
1390    =head3 GeneDataInRegion
1391    
1392        my @featureList = $sprout->GenesInRegion($contigID, $start, $stop);
1393    
1394    List the features which overlap a specified region in a contig.
1395    
1396    =over 4
1397    
1398    =item contigID
1399    
1400    ID of the contig containing the region of interest.
1401    
1402    =item start
1403    
1404    Offset of the first residue in the region of interest.
1405    
1406    =item stop
1407    
1408    Offset of the last residue in the region of interest.
1409    
1410    =item RETURN
1411    
1412    Returns a list of B<ERDBObjects> for the desired features. Each object will
1413    contain a B<Feature> record.
1414    
1415    =back
1416    
1417    =cut
1418    
1419    sub GeneDataInRegion {
1420        # Get the parameters.
1421        my ($self, $contigID, $start, $stop) = @_;
1422          # Get the maximum segment length.          # Get the maximum segment length.
1423          my $maximumSegmentLength = $self->MaxSegment;          my $maximumSegmentLength = $self->MaxSegment;
1424          # Create a hash to receive the feature list. We use a hash so that we can eliminate          # Create a hash to receive the feature list. We use a hash so that we can eliminate
1425          # duplicates easily.      # duplicates easily. The hash key will be the feature ID. The value will be the feature's
1426        # ERDBObject from the query.
1427          my %featuresFound = ();          my %featuresFound = ();
1428          # Prime the values we'll use for the returned beginning and end.      # Create a table of parameters for the queries. Each query looks for features travelling in
         my ($min, $max) = ($self->ContigLength($contigID), 0);  
         # Create a table of parameters for each query. Each query looks for features travelling in  
1429          # a particular direction. The query parameters include the contig ID, the feature direction,          # a particular direction. The query parameters include the contig ID, the feature direction,
1430          # the lowest possible start position, and the highest possible start position. This works          # the lowest possible start position, and the highest possible start position. This works
1431          # because each feature segment length must be no greater than the maximum segment length.          # because each feature segment length must be no greater than the maximum segment length.
# Line 878  Line 1434 
1434          # Loop through the query parameters.          # Loop through the query parameters.
1435          for my $parms (values %queryParms) {          for my $parms (values %queryParms) {
1436                  # Create the query.                  # Create the query.
1437                  my $query = $self->Get(['IsLocatedIn'],          my $query = $self->Get([qw(Feature IsLocatedIn)],
1438                          "IsLocatedIn(to-link)= ? AND IsLocatedIn(dir) = ? AND IsLocatedIn(beg) >= ? AND IsLocatedIn(beg) <= ?",                          "IsLocatedIn(to-link)= ? AND IsLocatedIn(dir) = ? AND IsLocatedIn(beg) >= ? AND IsLocatedIn(beg) <= ?",
1439                          $parms);                          $parms);
1440                  # Loop through the feature segments found.                  # Loop through the feature segments found.
1441                  while (my $segment = $query->Fetch) {                  while (my $segment = $query->Fetch) {
1442                          # Get the data about this segment.                          # Get the data about this segment.
1443                          my ($featureID, $dir, $beg, $len) = $segment->Values(['IsLocatedIn(from-link)',              my ($featureID, $contig, $dir, $beg, $len) = $segment->Values([qw(IsLocatedIn(from-link)
1444                                  'IsLocatedIn(dir)', 'IsLocatedIn(beg)', 'IsLocatedIn(len)']);                  IsLocatedIn(to-link) IsLocatedIn(dir) IsLocatedIn(beg) IsLocatedIn(len))]);
1445                          # Determine if this feature actually overlaps the region. The query insures that              # Determine if this feature segment actually overlaps the region. The query insures that
1446                          # this will be the case if the segment is the maximum length, so to fine-tune                          # this will be the case if the segment is the maximum length, so to fine-tune
1447                          # the results we insure that the inequality from the query holds using the actual                          # the results we insure that the inequality from the query holds using the actual
1448                          # length.                          # length.
1449                          my ($found, $end) = (0, 0);              my $loc = BasicLocation->new($contig, $beg, $dir, $len);
1450                          if ($dir eq '+') {              my $found = $loc->Overlap($start, $stop);
                                 $end = $beg + $len;  
                                 if ($end >= $start) {  
                                         # Denote we found a useful feature.  
                                         $found = 1;  
                                 }  
                         } elsif ($dir eq '-') {  
                                 $end = $beg - $len;  
                                 if ($end <= $stop) {  
                                         # Denote we found a useful feature.  
                                         $found = 1;  
                                 }  
                         }  
1451                          if ($found) {                          if ($found) {
1452                                  # Here we need to record the feature and update the minimum and maximum.                  # Save this feature in the result list.
1453                                  $featuresFound{$featureID} = 1;                  $featuresFound{$featureID} = $segment;
                                 if ($beg < $min) { $min = $beg; }  
                                 if ($end < $min) { $min = $end; }  
                                 if ($beg > $max) { $max = $beg; }  
                                 if ($end > $max) { $max = $end; }  
1454                          }                          }
1455                  }                  }
1456          }          }
1457          # Compute a list of the IDs for the features found.      # Return the ERDB objects for the features found.
1458          my @list = (sort (keys %featuresFound));      return values %featuresFound;
         # Return it along with the min and max.  
         return (\@list, $min, $max);  
1459  }  }
1460    
1461  =head3 FType  =head3 FType
1462    
1463  C<< my $ftype = $sprout->FType($featureID); >>      my $ftype = $sprout->FType($featureID);
1464    
1465  Return the type of a feature.  Return the type of a feature.
1466    
# Line 943  Line 1481 
1481  #: Return Type $;  #: Return Type $;
1482  sub FType {  sub FType {
1483          # Get the parameters.          # Get the parameters.
1484          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1485          # Get the specified feature's type.          # Get the specified feature's type.
1486          my ($retVal) = $self->GetEntityValues('Feature', $featureID, ['Feature(feature-type)']);          my ($retVal) = $self->GetEntityValues('Feature', $featureID, ['Feature(feature-type)']);
1487          # Return the result.          # Return the result.
# Line 953  Line 1490 
1490    
1491  =head3 FeatureAnnotations  =head3 FeatureAnnotations
1492    
1493  C<< my @descriptors = $sprout->FeatureAnnotations($featureID); >>      my @descriptors = $sprout->FeatureAnnotations($featureID, $rawFlag);
1494    
1495  Return the annotations of a feature.  Return the annotations of a feature.
1496    
# Line 963  Line 1500 
1500    
1501  ID of the feature whose annotations are desired.  ID of the feature whose annotations are desired.
1502    
1503    =item rawFlag
1504    
1505    If TRUE, the annotation timestamps will be returned in raw form; otherwise, they
1506    will be returned in human-readable form.
1507    
1508  =item RETURN  =item RETURN
1509    
1510  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.
1511    
1512  * B<featureID> ID of the relevant feature.  * B<featureID> ID of the relevant feature.
1513    
1514  * B<timeStamp> time the annotation was made, in user-friendly format.  * B<timeStamp> time the annotation was made.
1515    
1516  * B<user> ID of the user who made the annotation  * B<user> ID of the user who made the annotation
1517    
# Line 981  Line 1523 
1523  #: Return Type @%;  #: Return Type @%;
1524  sub FeatureAnnotations {  sub FeatureAnnotations {
1525          # Get the parameters.          # Get the parameters.
1526          my $self = shift @_;      my ($self, $featureID, $rawFlag) = @_;
         my ($featureID) = @_;  
1527          # 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.
1528          my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],          my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1529                                                     "IsTargetOfAnnotation(from-link) = ?", [$featureID]);                                                     "IsTargetOfAnnotation(from-link) = ?", [$featureID]);
# Line 995  Line 1536 
1536                          $annotation->Values(['IsTargetOfAnnotation(from-link)',                          $annotation->Values(['IsTargetOfAnnotation(from-link)',
1537                                                                   'Annotation(time)', 'MadeAnnotation(from-link)',                                                                   'Annotation(time)', 'MadeAnnotation(from-link)',
1538                                                                   'Annotation(annotation)']);                                                                   'Annotation(annotation)']);
1539            # Convert the time, if necessary.
1540            if (! $rawFlag) {
1541                $timeStamp = FriendlyTimestamp($timeStamp);
1542            }
1543                  # Assemble them into a hash.                  # Assemble them into a hash.
1544          my $annotationHash = { featureID => $featureID,          my $annotationHash = { featureID => $featureID,
1545                                 timeStamp => FriendlyTimestamp($timeStamp),                                 timeStamp => $timeStamp,
1546                                                             user => $user, text => $text };                                                             user => $user, text => $text };
1547                  # Add it to the return list.                  # Add it to the return list.
1548                  push @retVal, $annotationHash;                  push @retVal, $annotationHash;
# Line 1008  Line 1553 
1553    
1554  =head3 AllFunctionsOf  =head3 AllFunctionsOf
1555    
1556  C<< my %functions = $sprout->AllFunctionsOf($featureID); >>      my %functions = $sprout->AllFunctionsOf($featureID);
1557    
1558  Return all of the functional assignments for a particular feature. The data is returned as a  Return all of the functional assignments for a particular feature. The data is returned as a
1559  hash of functional assignments to user IDs. A functional assignment is a type of annotation.  hash of functional assignments to user IDs. A functional assignment is a type of annotation,
1560  It has the format "XXXX\nset XXXX function to\nYYYYY". In this instance, XXXX is the user ID  Functional assignments are described in the L</ParseAssignment> function. Its worth noting that
1561  and YYYYY is the functional assignment text. Its worth noting that we cannot filter on the content  we cannot filter on the content of the annotation itself because it's a text field; however,
1562  of the annotation itself because it's a text field; however, this is not a big problem because most  this is not a big problem because most features only have a small number of annotations.
1563  features only have a small number of annotations. Finally, if a single user has multiple  Finally, if a single user has multiple functional assignments, we will only keep the most
1564  functional assignments, we will only keep the most recent one.  recent one.
1565    
1566  =over 4  =over 4
1567    
# Line 1026  Line 1571 
1571    
1572  =item RETURN  =item RETURN
1573    
1574  Returns a hash mapping the functional assignment IDs to user IDs.  Returns a hash mapping the user IDs to functional assignment IDs.
1575    
1576  =back  =back
1577    
# Line 1034  Line 1579 
1579  #: Return Type %;  #: Return Type %;
1580  sub AllFunctionsOf {  sub AllFunctionsOf {
1581          # Get the parameters.          # Get the parameters.
1582          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1583          # Get all of the feature's annotations.          # Get all of the feature's annotations.
1584      my @query = $self->GetAll(['IsTargetOfAnnotation', 'Annotation'],      my @query = $self->GetAll(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1585                                                      "IsTargetOfAnnotation(from-link) = ?",                                                      "IsTargetOfAnnotation(from-link) = ?",
1586                              [$featureID], ['Annotation(time)', 'Annotation(annotation)']);                              [$featureID], ['Annotation(time)', 'Annotation(annotation)',
1587                                               'MadeAnnotation(from-link)']);
1588          # Declare the return hash.          # Declare the return hash.
1589          my %retVal;          my %retVal;
     # Declare a hash for insuring we only make one assignment per user.  
     my %timeHash = ();  
1590      # Now we sort the assignments by timestamp in reverse.      # Now we sort the assignments by timestamp in reverse.
1591      my @sortedQuery = sort { -($a->[0] <=> $b->[0]) } @query;      my @sortedQuery = sort { -($a->[0] <=> $b->[0]) } @query;
1592          # Loop until we run out of annotations.          # Loop until we run out of annotations.
1593      for my $annotation (@sortedQuery) {      for my $annotation (@sortedQuery) {
1594          # Get the annotation fields.          # Get the annotation fields.
1595          my ($timeStamp, $text) = @{$annotation};          my ($timeStamp, $text, $user) = @{$annotation};
1596                  # Check to see if this is a functional assignment.                  # Check to see if this is a functional assignment.
1597                  my ($user, $function) = ParseAssignment($text);          my ($actualUser, $function) = _ParseAssignment($user, $text);
1598          if ($user && ! exists $timeHash{$user}) {          if ($actualUser && ! exists $retVal{$actualUser}) {
1599              # Here it is a functional assignment and there has been no              # Here it is a functional assignment and there has been no
1600              # previous assignment for this user, so we stuff it in the              # previous assignment for this user, so we stuff it in the
1601              # return hash.              # return hash.
1602                          $retVal{$function} = $user;              $retVal{$actualUser} = $function;
             # Insure we don't assign to this user again.  
             $timeHash{$user} = 1;  
1603                  }                  }
1604          }          }
1605          # Return the hash of assignments found.          # Return the hash of assignments found.
# Line 1067  Line 1608 
1608    
1609  =head3 FunctionOf  =head3 FunctionOf
1610    
1611  C<< my $functionText = $sprout->FunctionOf($featureID, $userID); >>      my $functionText = $sprout->FunctionOf($featureID, $userID);
1612    
1613  Return the most recently-determined functional assignment of a particular feature.  Return the most recently-determined functional assignment of a particular feature.
1614    
1615  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
1616  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
1617  assignment is a type of annotation. It has the format "XXXX\nset XXXX function to\nYYYYY". In this  assignment is taken from the B<Feature> or C<Annotation> table, depending.
 instance, XXXX is the user ID and YYYYY is the functional assignment text. 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.  
1618    
1619  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
1620  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 1095  Line 1633 
1633    
1634  =item userID (optional)  =item userID (optional)
1635    
1636  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
1637  C<FIG> assignment will be returned.  functional assignment in the B<Feature> table will be returned.
1638    
1639  =item RETURN  =item RETURN
1640    
# Line 1108  Line 1646 
1646  #: Return Type $;  #: Return Type $;
1647  sub FunctionOf {  sub FunctionOf {
1648          # Get the parameters.          # Get the parameters.
1649          my $self = shift @_;      my ($self, $featureID, $userID) = @_;
         my ($featureID, $userID) = @_;  
1650      # Declare the return value.      # Declare the return value.
1651      my $retVal;      my $retVal;
1652      # Determine the ID type.      # Determine the ID type.
1653      if ($featureID =~ m/^fig\|/) {      if ($featureID =~ m/^fig\|/) {
1654          # Here we have a FIG feature ID. We must build the list of trusted          # Here we have a FIG feature ID.
1655          # users.          if (!$userID) {
1656                # Use the primary assignment.
1657                ($retVal) = $self->GetEntityValues('Feature', $featureID, ['Feature(assignment)']);
1658            } else {
1659                # We must build the list of trusted users.
1660          my %trusteeTable = ();          my %trusteeTable = ();
1661          # Check the user ID.          # Check the user ID.
1662          if (!$userID) {          if (!$userID) {
# Line 1137  Line 1678 
1678              }              }
1679          }          }
1680          # 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.
1681          my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation'],              my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1682                                 "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",                                 "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",
1683                                 [$featureID]);                                 [$featureID]);
1684          my $timeSelected = 0;          my $timeSelected = 0;
1685          # Loop until we run out of annotations.          # Loop until we run out of annotations.
1686          while (my $annotation = $query->Fetch()) {          while (my $annotation = $query->Fetch()) {
1687              # Get the annotation text.              # Get the annotation text.
1688              my ($text, $time) = $annotation->Values(['Annotation(annotation)','Annotation(time)']);                  my ($text, $time, $user) = $annotation->Values(['Annotation(annotation)',
1689                                                             'Annotation(time)', 'MadeAnnotation(from-link)']);
1690              # 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.
1691              my ($user, $type, $function) = split(/\n/, $text);                  my ($actualUser, $function) = _ParseAssignment($user, $text);
1692              if ($type =~ m/^set $user function to$/i) {                  Trace("Assignment user is $actualUser, text is $function.") if T(4);
1693                    if ($actualUser) {
1694                  # Here it is a functional assignment. Check the time and the user                  # Here it is a functional assignment. Check the time and the user
1695                  # name. The time must be recent and the user must be trusted.                  # name. The time must be recent and the user must be trusted.
1696                  if ((exists $trusteeTable{$user}) && ($time > $timeSelected)) {                      if ((exists $trusteeTable{$actualUser}) && ($time > $timeSelected)) {
1697                      $retVal = $function;                      $retVal = $function;
1698                      $timeSelected = $time;                      $timeSelected = $time;
1699                  }                  }
1700              }              }
1701          }          }
1702            }
1703      } else {      } else {
1704          # 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
1705          # matter. We simply get the information from the External Alias Function          # matter. We simply get the information from the External Alias Function
# Line 1166  Line 1710 
1710          return $retVal;          return $retVal;
1711  }  }
1712    
1713    =head3 FunctionsOf
1714    
1715        my @functionList = $sprout->FunctionOf($featureID, $userID);
1716    
1717    Return the functional assignments of a particular feature.
1718    
1719    The functional assignment is handled differently depending on the type of feature. If
1720    the feature is identified by a FIG ID (begins with the string C<fig|>), then a functional
1721    assignment is a type of annotation. The format of an assignment is described in
1722    L</ParseAssignment>. Its worth noting that we cannot filter on the content of the
1723    annotation itself because it's a text field; however, this is not a big problem because
1724    most features only have a small number of annotations.
1725    
1726    If the feature is B<not> identified by a FIG ID, then the functional assignment
1727    information is taken from the B<ExternalAliasFunc> table. If the table does
1728    not contain an entry for the feature, an empty list is returned.
1729    
1730    =over 4
1731    
1732    =item featureID
1733    
1734    ID of the feature whose functional assignments are desired.
1735    
1736    =item RETURN
1737    
1738    Returns a list of 2-tuples, each consisting of a user ID and the text of an assignment by
1739    that user.
1740    
1741    =back
1742    
1743    =cut
1744    #: Return Type @@;
1745    sub FunctionsOf {
1746        # Get the parameters.
1747        my ($self, $featureID) = @_;
1748        # Declare the return value.
1749        my @retVal = ();
1750        # Determine the ID type.
1751        if ($featureID =~ m/^fig\|/) {
1752            # Here we have a FIG feature ID. We must build the list of trusted
1753            # users.
1754            my %trusteeTable = ();
1755            # Build a query for all of the feature's annotations, sorted by date.
1756            my $query = $self->Get(['IsTargetOfAnnotation', 'Annotation', 'MadeAnnotation'],
1757                                   "IsTargetOfAnnotation(from-link) = ? ORDER BY Annotation(time) DESC",
1758                                   [$featureID]);
1759            my $timeSelected = 0;
1760            # Loop until we run out of annotations.
1761            while (my $annotation = $query->Fetch()) {
1762                # Get the annotation text.
1763                my ($text, $time, $user) = $annotation->Values(['Annotation(annotation)',
1764                                                                'Annotation(time)',
1765                                                                'MadeAnnotation(user)']);
1766                # Check to see if this is a functional assignment for a trusted user.
1767                my ($actualUser, $function) = _ParseAssignment($user, $text);
1768                if ($actualUser) {
1769                    # Here it is a functional assignment.
1770                    push @retVal, [$actualUser, $function];
1771                }
1772            }
1773        } else {
1774            # Here we have a non-FIG feature ID. In this case the user ID does not
1775            # matter. We simply get the information from the External Alias Function
1776            # table.
1777            my @assignments = $self->GetEntityValues('ExternalAliasFunc', $featureID,
1778                                                     ['ExternalAliasFunc(func)']);
1779            push @retVal, map { ['master', $_] } @assignments;
1780        }
1781        # Return the assignments found.
1782        return @retVal;
1783    }
1784    
1785  =head3 BBHList  =head3 BBHList
1786    
1787  C<< my $bbhHash = $sprout->BBHList($genomeID, \@featureList); >>      my $bbhHash = $sprout->BBHList($genomeID, \@featureList);
1788    
1789  Return a hash mapping the features in a specified list to their bidirectional best hits  Return a hash mapping the features in a specified list to their bidirectional best hits
1790  on a specified target genome.  on a specified target genome.
# Line 1185  Line 1801 
1801    
1802  =item RETURN  =item RETURN
1803    
1804  Returns a reference to a hash that maps the IDs of the incoming features to the IDs of  Returns a reference to a hash that maps the IDs of the incoming features to the best hits
1805  their best hits.  on the target genome.
1806    
1807  =back  =back
1808    
# Line 1194  Line 1810 
1810  #: Return Type %;  #: Return Type %;
1811  sub BBHList {  sub BBHList {
1812          # Get the parameters.          # Get the parameters.
1813          my $self = shift @_;      my ($self, $genomeID, $featureList) = @_;
         my ($genomeID, $featureList) = @_;  
1814          # Create the return structure.          # Create the return structure.
1815          my %retVal = ();          my %retVal = ();
1816          # Loop through the incoming features.          # Loop through the incoming features.
1817          for my $featureID (@{$featureList}) {          for my $featureID (@{$featureList}) {
1818                  # Create a query to get the feature's best hit.          # Ask the server for the feature's best hit.
1819                  my $query = $self->Get(['IsBidirectionalBestHitOf'],          my @bbhData = FIGRules::BBHData($featureID);
1820                                                             "IsBidirectionalBestHitOf(from-link) = ? AND IsBidirectionalBestHitOf(genome) = ?",          # Peel off the BBHs found.
1821                                                             [$featureID, $genomeID]);          my @found = ();
1822                  # Look for the best hit.          for my $bbh (@bbhData) {
1823                  my $bbh = $query->Fetch;              my $fid = $bbh->[0];
1824                  if ($bbh) {              my $bbGenome = $self->GenomeOf($fid);
1825                          my ($targetFeature) = $bbh->Value('IsBidirectionalBestHitOf(to-link)');              if ($bbGenome eq $genomeID) {
1826                          $retVal{$featureID} = $targetFeature;                  push @found, $fid;
1827                  }                  }
1828          }          }
1829            $retVal{$featureID} = \@found;
1830        }
1831          # Return the mapping.          # Return the mapping.
1832          return \%retVal;          return \%retVal;
1833  }  }
1834    
1835    =head3 SimList
1836    
1837        my %similarities = $sprout->SimList($featureID, $count);
1838    
1839    Return a list of the similarities to the specified feature.
1840    
1841    This method just returns the bidirectional best hits for performance reasons.
1842    
1843    =over 4
1844    
1845    =item featureID
1846    
1847    ID of the feature whose similarities are desired.
1848    
1849    =item count
1850    
1851    Maximum number of similar features to be returned, or C<0> to return them all.
1852    
1853    =back
1854    
1855    =cut
1856    #: Return Type %;
1857    sub SimList {
1858        # Get the parameters.
1859        my ($self, $featureID, $count) = @_;
1860        # Ask for the best hits.
1861        my @lists = FIGRules::BBHData($featureID);
1862        # Create the return value.
1863        my %retVal = ();
1864        for my $tuple (@lists) {
1865            $retVal{$tuple->[0]} = $tuple->[1];
1866        }
1867        # Return the result.
1868        return %retVal;
1869    }
1870    
1871    =head3 IsComplete
1872    
1873        my $flag = $sprout->IsComplete($genomeID);
1874    
1875    Return TRUE if the specified genome is complete, else FALSE.
1876    
1877    =over 4
1878    
1879    =item genomeID
1880    
1881    ID of the genome whose completeness status is desired.
1882    
1883    =item RETURN
1884    
1885    Returns TRUE if the genome is complete, FALSE if it is incomplete, and C<undef> if it is
1886    not found.
1887    
1888    =back
1889    
1890    =cut
1891    #: Return Type $;
1892    sub IsComplete {
1893        # Get the parameters.
1894        my ($self, $genomeID) = @_;
1895        # Declare the return variable.
1896        my $retVal;
1897        # Get the genome's data.
1898        my $genomeData = $self->GetEntity('Genome', $genomeID);
1899        if ($genomeData) {
1900            # The genome exists, so get the completeness flag.
1901            $retVal = $genomeData->PrimaryValue('Genome(complete)');
1902        }
1903        # Return the result.
1904        return $retVal;
1905    }
1906    
1907  =head3 FeatureAliases  =head3 FeatureAliases
1908    
1909  C<< my @aliasList = $sprout->FeatureAliases($featureID); >>      my @aliasList = $sprout->FeatureAliases($featureID);
1910    
1911  Return a list of the aliases for a specified feature.  Return a list of the aliases for a specified feature.
1912    
# Line 1238  Line 1927 
1927  #: Return Type @;  #: Return Type @;
1928  sub FeatureAliases {  sub FeatureAliases {
1929          # Get the parameters.          # Get the parameters.
1930          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
1931          # Get the desired feature's aliases          # Get the desired feature's aliases
1932          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(alias)']);      my @retVal = $self->GetFlat(['IsAliasOf'], "IsAliasOf(to-link) = ?", [$featureID], 'IsAliasOf(from-link)');
1933          # Return the result.          # Return the result.
1934          return @retVal;          return @retVal;
1935  }  }
1936    
1937  =head3 GenomeOf  =head3 GenomeOf
1938    
1939  C<< my $genomeID = $sprout->GenomeOf($featureID); >>      my $genomeID = $sprout->GenomeOf($featureID);
1940    
1941  Return the genome that contains a specified feature.  Return the genome that contains a specified feature or contig.
1942    
1943  =over 4  =over 4
1944    
1945  =item featureID  =item featureID
1946    
1947  ID of the feature whose genome is desired.  ID of the feature or contig whose genome is desired.
1948    
1949  =item RETURN  =item RETURN
1950    
1951  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
1952  an undefined value.  found, returns an undefined value.
1953    
1954  =back  =back
1955    
# Line 1269  Line 1957 
1957  #: Return Type $;  #: Return Type $;
1958  sub GenomeOf {  sub GenomeOf {
1959          # Get the parameters.          # Get the parameters.
1960          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
         # Create a query to find the genome associated with the feature.  
         my $query = $self->Get(['IsLocatedIn', 'HasContig'], "IsLocatedIn(from-link) = ?", [$featureID]);  
1961          # Declare the return value.          # Declare the return value.
1962          my $retVal;          my $retVal;
1963          # Get the genome ID.      # Parse the genome ID from the feature ID.
1964          if (my $relationship = $query->Fetch()) {      if ($featureID =~ /^fig\|(\d+\.\d+)/) {
1965                  ($retVal) = $relationship->Value('HasContig(from-link)');          $retVal = $1;
1966        } else {
1967            # Find the feature by alias.
1968            my ($realFeatureID) = $self->FeaturesByAlias($featureID);
1969            if ($realFeatureID && $realFeatureID =~ /^fig\|(\d+\.\d+)/) {
1970                $retVal = $1;
1971            } else {
1972                # Use the external table.
1973                my ($org) = $self->GetFlat(['ExternalAliasOrg'], "ExternalAliasOrg(id) = ?",
1974                                           [$featureID], "ExternalAliasOrg(org)");
1975                if ($org) {
1976                    $retVal = $org;
1977                } else {
1978                    Confess("Invalid feature ID $featureID.");
1979                }
1980            }
1981          }          }
1982          # Return the value found.          # Return the value found.
1983          return $retVal;          return $retVal;
# Line 1285  Line 1985 
1985    
1986  =head3 CoupledFeatures  =head3 CoupledFeatures
1987    
1988  C<< my %coupleHash = $sprout->CoupledFeatures($featureID); >>      my %coupleHash = $sprout->CoupledFeatures($featureID);
1989    
1990  Return the features functionally coupled with a specified feature. Features are considered  Return the features functionally coupled with a specified feature. Features are considered
1991  functionally coupled if they tend to be clustered on the same chromosome.  functionally coupled if they tend to be clustered on the same chromosome.
# Line 1306  Line 2006 
2006  #: Return Type %;  #: Return Type %;
2007  sub CoupledFeatures {  sub CoupledFeatures {
2008          # Get the parameters.          # Get the parameters.
2009          my $self = shift @_;      my ($self, $featureID) = @_;
2010          my ($featureID) = @_;      # Ask the coupling server for the data.
2011          # Create a query to retrieve the functionally-coupled features. Note that we depend on the      Trace("Looking for features coupled to $featureID.") if T(coupling => 3);
2012          # fact that the functional coupling is physically paired. If (A,B) is in the database, then      my @rawPairs = FIGRules::NetCouplingData('coupled_to', id1 => $featureID);
2013          # (B,A) will also be found.      Trace(scalar(@rawPairs) . " couplings returned.") if T(coupling => 3);
2014          my $query = $self->Get(['IsClusteredOnChromosomeWith'],      # Form them into a hash.
                                                    "IsClusteredOnChromosomeWith(from-link) = ?", [$featureID]);  
         # This value will be set to TRUE if we find at least one coupled feature.  
         my $found = 0;  
         # Create the return hash.  
2015          my %retVal = ();          my %retVal = ();
2016          # Retrieve the relationship records and store them in the hash.      for my $pair (@rawPairs) {
2017          while (my $clustering = $query->Fetch()) {          # Get the feature ID and score.
2018                  my ($otherFeatureID, $score) = $clustering->Values(['IsClusteredOnChromosomeWith(to-link)',          my ($featureID2, $score) = @{$pair};
2019                                                                      'IsClusteredOnChromosomeWith(score)']);          # Only proceed if the feature is in NMPDR.
2020                  $retVal{$otherFeatureID} = $score;          if ($self->_CheckFeature($featureID2)) {
2021                  $found = 1;              $retVal{$featureID2} = $score;
2022            }
2023          }          }
2024          # Functional coupling is reflexive. If we found at least one coupled feature, we must add          # Functional coupling is reflexive. If we found at least one coupled feature, we must add
2025          # the incoming feature as well.          # the incoming feature as well.
2026          if ($found) {      if (keys %retVal) {
2027                  $retVal{$featureID} = 9999;                  $retVal{$featureID} = 9999;
2028      }      }
2029          # Return the hash.          # Return the hash.
2030          return %retVal;          return %retVal;
2031  }  }
2032    
2033  =head3 GetEntityTypes  =head3 CouplingEvidence
2034    
2035  C<< my @entityList = $sprout->GetEntityTypes(); >>      my @evidence = $sprout->CouplingEvidence($peg1, $peg2);
2036    
2037  Return the list of supported entity types.  Return the evidence for a functional coupling.
2038    
2039  =cut  A pair of features is considered evidence of a coupling between two other
2040  #: Return Type @;  features if they occur close together on a contig and both are similar to
2041  sub GetEntityTypes {  the coupled features. So, if B<A1> and B<A2> are close together on a contig,
2042          # Get the parameters.  B<B1> and B<B2> are considered evidence for the coupling if (1) B<B1> and
2043          my $self = shift @_;  B<B2> are close together, (2) B<B1> is similar to B<A1>, and (3) B<B2> is
2044          # Get the underlying database object.  similar to B<A2>.
         my $erdb = $self->{_erdb};  
         # Get its entity type list.  
         my @retVal = $erdb->GetEntityTypes();  
 }  
2045    
2046  =head3 ReadFasta  The score of a coupling is determined by the number of pieces of evidence
2047    that are considered I<representative>. If several evidence items belong to
2048    a group of genomes that are close to each other, only one of those items
2049    is considered representative. The other evidence items are presumed to be
2050    there because of the relationship between the genomes rather than because
2051    the two proteins generated by the features have a related functionality.
2052    
2053  C<< my %sequenceData = Sprout::ReadFasta($fileName, $prefix); >>  Each evidence item is returned as a three-tuple in the form C<[>I<$peg1a>C<,>
2054    I<$peg2a>C<,> I<$rep>C<]>, where I<$peg1a> is similar to I<$peg1>, I<$peg2a>
2055    is similar to I<$peg2>, and I<$rep> is TRUE if the evidence is representative
2056    and FALSE otherwise.
2057    
2058  Read sequence data from a FASTA-format file. Each sequence in a FASTA file is represented by  =over 4
2059    
2060    =item peg1
2061    
2062    ID of the feature of interest.
2063    
2064    =item peg2
2065    
2066    ID of a feature functionally coupled to the feature of interest.
2067    
2068    =item RETURN
2069    
2070    Returns a list of 3-tuples. Each tuple consists of a feature similar to the feature
2071    of interest, a feature similar to the functionally coupled feature, and a flag
2072    that is TRUE for a representative piece of evidence and FALSE otherwise.
2073    
2074    =back
2075    
2076    =cut
2077    #: Return Type @@;
2078    sub CouplingEvidence {
2079        # Get the parameters.
2080        my ($self, $peg1, $peg2) = @_;
2081        # Declare the return variable.
2082        my @retVal = ();
2083        # Get the coupling and evidence data.
2084        my @rawData = FIGRules::NetCouplingData('coupling_evidence', id1 => $peg1, id2 => $peg2);
2085        # Loop through the raw data, saving the ones that are in NMPDR genomes.
2086        for my $rawTuple (@rawData) {
2087            if ($self->_CheckFeature($rawTuple->[0]) && $self->_CheckFeature($rawTuple->[1])) {
2088                push @retVal, $rawTuple;
2089            }
2090        }
2091        # Return the result.
2092        return @retVal;
2093    }
2094    
2095    =head3 GetSynonymGroup
2096    
2097        my $id = $sprout->GetSynonymGroup($fid);
2098    
2099    Return the synonym group name for the specified feature.
2100    
2101    =over 4
2102    
2103    =item fid
2104    
2105    ID of the feature whose synonym group is desired.
2106    
2107    =item RETURN
2108    
2109    The name of the synonym group to which the feature belongs. If the feature does
2110    not belong to a synonym group, the feature ID itself is returned.
2111    
2112    =back
2113    
2114    =cut
2115    
2116    sub GetSynonymGroup {
2117        # Get the parameters.
2118        my ($self, $fid) = @_;
2119        # Declare the return variable.
2120        my $retVal;
2121        # Find the synonym group.
2122        my @groups = $self->GetFlat(['IsSynonymGroupFor'], "IsSynonymGroupFor(to-link) = ?",
2123                                       [$fid], 'IsSynonymGroupFor(from-link)');
2124        # Check to see if we found anything.
2125        if (@groups) {
2126            $retVal = $groups[0];
2127        } else {
2128            $retVal = $fid;
2129        }
2130        # Return the result.
2131        return $retVal;
2132    }
2133    
2134    =head3 GetBoundaries
2135    
2136        my ($contig, $beg, $end) = $sprout->GetBoundaries(@locList);
2137    
2138    Determine the begin and end boundaries for the locations in a list. All of the
2139    locations must belong to the same contig and have mostly the same direction in
2140    order for this method to produce a meaningful result. The resulting
2141    begin/end pair will contain all of the bases in any of the locations.
2142    
2143    =over 4
2144    
2145    =item locList
2146    
2147    List of locations to process.
2148    
2149    =item RETURN
2150    
2151    Returns a 3-tuple consisting of the contig ID, the beginning boundary,
2152    and the ending boundary. The beginning boundary will be left of the
2153    end for mostly-forward locations and right of the end for mostly-backward
2154    locations.
2155    
2156    =back
2157    
2158    =cut
2159    
2160    sub GetBoundaries {
2161        # Get the parameters.
2162        my ($self, @locList) = @_;
2163        # Set up the counters used to determine the most popular direction.
2164        my %counts = ( '+' => 0, '-' => 0 );
2165        # Get the last location and parse it.
2166        my $locObject = BasicLocation->new(pop @locList);
2167        # Prime the loop with its data.
2168        my ($contig, $beg, $end) = ($locObject->Contig, $locObject->Left, $locObject->Right);
2169        # Count its direction.
2170        $counts{$locObject->Dir}++;
2171        # Loop through the remaining locations. Note that in most situations, this loop
2172        # will not iterate at all, because most of the time we will be dealing with a
2173        # singleton list.
2174        for my $loc (@locList) {
2175            # Create a location object.
2176            my $locObject = BasicLocation->new($loc);
2177            # Count the direction.
2178            $counts{$locObject->Dir}++;
2179            # Get the left end and the right end.
2180            my $left = $locObject->Left;
2181            my $right = $locObject->Right;
2182            # Merge them into the return variables.
2183            if ($left < $beg) {
2184                $beg = $left;
2185            }
2186            if ($right > $end) {
2187                $end = $right;
2188            }
2189        }
2190        # If the most common direction is reverse, flip the begin and end markers.
2191        if ($counts{'-'} > $counts{'+'}) {
2192            ($beg, $end) = ($end, $beg);
2193        }
2194        # Return the result.
2195        return ($contig, $beg, $end);
2196    }
2197    
2198    =head3 ReadFasta
2199    
2200        my %sequenceData = Sprout::ReadFasta($fileName, $prefix);
2201    
2202    Read sequence data from a FASTA-format file. Each sequence in a FASTA file is represented by
2203  one or more lines of data. The first line begins with a > character and contains an ID.  one or more lines of data. The first line begins with a > character and contains an ID.
2204  The remaining lines contain the sequence data in order.  The remaining lines contain the sequence data in order.
2205    
# Line 1394  Line 2239 
2239                  if ($line =~ m/^>\s*(.+?)(\s|\n)/) {                  if ($line =~ m/^>\s*(.+?)(\s|\n)/) {
2240                          # 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.
2241                          if ($id) {                          if ($id) {
2242                                  $retVal{$id} = $sequence;                  $retVal{$id} = lc $sequence;
2243                          }                          }
2244                          # Clear the sequence accumulator and save the new ID.                          # Clear the sequence accumulator and save the new ID.
2245                          ($id, $sequence) = ("$prefix$1", "");                          ($id, $sequence) = ("$prefix$1", "");
2246                  } else {                  } else {
2247                          # 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.
2248                          # First, we get the actual data out.              # First, we get the actual data out. Note that we normalize to lower
2249                # case.
2250                          $line =~ /^\s*(.*?)(\s|\n)/;                          $line =~ /^\s*(.*?)(\s|\n)/;
2251                          $sequence .= $1;                          $sequence .= $1;
2252                  }                  }
2253          }          }
2254          # Flush out the last sequence (if any).          # Flush out the last sequence (if any).
2255          if ($sequence) {          if ($sequence) {
2256                  $retVal {$id} = $sequence;          $retVal{$id} = lc $sequence;
2257          }          }
2258        # Close the file.
2259        close FASTAFILE;
2260          # Return the hash constructed from the file.          # Return the hash constructed from the file.
2261          return %retVal;          return %retVal;
2262  }  }
2263    
2264  =head3 FormatLocations  =head3 FormatLocations
2265    
2266  C<< my @locations = $sprout->FormatLocations($prefix, \@locations, $oldFormat); >>      my @locations = $sprout->FormatLocations($prefix, \@locations, $oldFormat);
2267    
2268  Insure that a list of feature locations is in the Sprout format. The Sprout feature location  Insure that a list of feature locations is in the Sprout format. The Sprout feature location
2269  format is I<contig>_I<beg*len> where I<*> is C<+> for a forward gene and C<-> for a backward  format is I<contig>_I<beg*len> where I<*> is C<+> for a forward gene and C<-> for a backward
2270  gene. The old format is I<contig>_I<beg>_I<end>.  gene. The old format is I<contig>_I<beg>_I<end>. If a feature is in the new format already,
2271    it will not be changed; otherwise, it will be converted. This method can also be used to
2272    perform the reverse task-- insuring that all the locations are in the old format.
2273    
2274  =over 4  =over 4
2275    
# Line 1446  Line 2296 
2296  #: Return Type @;  #: Return Type @;
2297  sub FormatLocations {  sub FormatLocations {
2298          # Get the parameters.          # Get the parameters.
2299          my $self = shift @_;      my ($self, $prefix, $locations, $oldFormat) = @_;
         my ($prefix, $locations, $oldFormat) = @_;  
2300          # Create the return list.          # Create the return list.
2301          my @retVal = ();          my @retVal = ();
2302          # Check to see if any locations were passed in.          # Check to see if any locations were passed in.
2303          if ($locations eq '') {          if ($locations eq '') {
2304              confess "No locations specified.";          Confess("No locations specified.");
2305          } else {          } else {
2306                  # Loop through the locations, converting them to the new format.                  # Loop through the locations, converting them to the new format.
2307                  for my $location (@{$locations}) {                  for my $location (@{$locations}) {
# Line 1479  Line 2328 
2328    
2329  =head3 DumpData  =head3 DumpData
2330    
2331  C<< $sprout->DumpData(); >>      $sprout->DumpData();
2332    
2333  Dump all the tables to tab-delimited DTX files. The files will be stored in the data directory.  Dump all the tables to tab-delimited DTX files. The files will be stored in the data directory.
2334    
# Line 1487  Line 2336 
2336    
2337  sub DumpData {  sub DumpData {
2338          # Get the parameters.          # Get the parameters.
2339          my $self = shift @_;      my ($self) = @_;
2340          # Get the data directory name.          # Get the data directory name.
2341          my $outputDirectory = $self->{_options}->{dataDir};          my $outputDirectory = $self->{_options}->{dataDir};
2342          # Dump the relations.          # Dump the relations.
2343          $self->{_erdb}->DumpRelations($outputDirectory);      $self->DumpRelations($outputDirectory);
2344  }  }
2345    
2346  =head3 XMLFileName  =head3 XMLFileName
2347    
2348  C<< my $fileName = $sprout->XMLFileName(); >>      my $fileName = $sprout->XMLFileName();
2349    
2350  Return the name of this database's XML definition file.  Return the name of this database's XML definition file.
2351    
2352  =cut  =cut
2353  #: Return Type $;  #: Return Type $;
2354  sub XMLFileName {  sub XMLFileName {
2355          my $self = shift @_;      my ($self) = @_;
2356          return $self->{_xmlName};          return $self->{_xmlName};
2357  }  }
2358    
2359    =head3 GetGenomeNameData
2360    
2361        my ($genus, $species, $strain) = $sprout->GenomeNameData($genomeID);
2362    
2363    Return the genus, species, and unique characterization for a genome. This
2364    is similar to L</GenusSpecies>, with the exception that it returns the
2365    values in three seperate fields.
2366    
2367    =over 4
2368    
2369    =item genomeID
2370    
2371    ID of the genome whose name data is desired.
2372    
2373    =item RETURN
2374    
2375    Returns a three-element list, consisting of the genus, species, and strain
2376    of the specified genome. If the genome is not found, an error occurs.
2377    
2378    =back
2379    
2380    =cut
2381    
2382    sub GetGenomeNameData {
2383        # Get the parameters.
2384        my ($self, $genomeID) = @_;
2385        # Get the desired values.
2386        my ($genus, $species, $strain) = $self->GetEntityValues('Genome', $genomeID =>
2387                                                                [qw(Genome(genus) Genome(species) Genome(unique-characterization))]);
2388        # Throw an error if they were not found.
2389        if (! defined $genus) {
2390            Confess("Genome $genomeID not found in database.");
2391        }
2392        # Return the results.
2393        return ($genus, $species, $strain);
2394    }
2395    
2396    =head3 GetGenomeByNameData
2397    
2398        my @genomes = $sprout->GetGenomeByNameData($genus, $species, $strain);
2399    
2400    Return a list of the IDs of the genomes with the specified genus,
2401    species, and strain. In almost every case, there will be either zero or
2402    one IDs returned; however, two or more IDs could be returned if there are
2403    multiple versions of the genome in the database.
2404    
2405    =over 4
2406    
2407    =item genus
2408    
2409    Genus of the desired genome.
2410    
2411    =item species
2412    
2413    Species of the desired genome.
2414    
2415    =item strain
2416    
2417    Strain (unique characterization) of the desired genome. This may be an empty
2418    string, in which case it is presumed that the desired genome has no strain
2419    specified.
2420    
2421    =item RETURN
2422    
2423    Returns a list of the IDs of the genomes having the specified genus, species, and
2424    strain.
2425    
2426    =back
2427    
2428    =cut
2429    
2430    sub GetGenomeByNameData {
2431        # Get the parameters.
2432        my ($self, $genus, $species, $strain) = @_;
2433        # Try to find the genomes.
2434        my @retVal = $self->GetFlat(['Genome'], "Genome(genus) = ? AND Genome(species) = ? AND Genome(unique-characterization) = ?",
2435                                    [$genus, $species, $strain], 'Genome(id)');
2436        # Return the result.
2437        return @retVal;
2438    }
2439    
2440  =head3 Insert  =head3 Insert
2441    
2442  C<< $sprout->Insert($objectType, \%fieldHash); >>      $sprout->Insert($objectType, \%fieldHash);
2443    
2444  Insert an entity or relationship instance into the database. The entity or relationship of interest  Insert an entity or relationship instance into the database. The entity or relationship of interest
2445  is defined by a type name and then a hash of field names to values. Field values in the primary  is defined by a type name and then a hash of field names to values. Field values in the primary
# Line 1518  Line 2448 
2448  list references. For example, the following line inserts an inactive PEG feature named  list references. For example, the following line inserts an inactive PEG feature named
2449  C<fig|188.1.peg.1> with aliases C<ZP_00210270.1> and C<gi|46206278>.  C<fig|188.1.peg.1> with aliases C<ZP_00210270.1> and C<gi|46206278>.
2450    
2451  C<< $sprout->Insert('Feature', { id => 'fig|188.1.peg.1', active => 0, feature-type => 'peg', alias => ['ZP_00210270.1', 'gi|46206278']}); >>      $sprout->Insert('Feature', { id => 'fig|188.1.peg.1', active => 0, feature-type => 'peg', alias => ['ZP_00210270.1', 'gi|46206278']});
2452    
2453  The next statement inserts a C<HasProperty> relationship between feature C<fig|158879.1.peg.1> and  The next statement inserts a C<HasProperty> relationship between feature C<fig|158879.1.peg.1> and
2454  property C<4> with an evidence URL of C<http://seedu.uchicago.edu/query.cgi?article_id=142>.  property C<4> with an evidence URL of C<http://seedu.uchicago.edu/query.cgi?article_id=142>.
2455    
2456  C<< $sprout->InsertObject('HasProperty', { 'from-link' => 'fig|158879.1.peg.1', 'to-link' => 4, evidence = 'http://seedu.uchicago.edu/query.cgi?article_id=142'}); >>      $sprout->InsertObject('HasProperty', { 'from-link' => 'fig|158879.1.peg.1', 'to-link' => 4, evidence => 'http://seedu.uchicago.edu/query.cgi?article_id=142'});
2457    
2458  =over 4  =over 4
2459    
# Line 1541  Line 2471 
2471  #: Return Type ;  #: Return Type ;
2472  sub Insert {  sub Insert {
2473          # Get the parameters.          # Get the parameters.
2474          my $self = shift @_;      my ($self, $objectType, $fieldHash) = @_;
         my ($objectType, $fieldHash) = @_;  
2475          # Call the underlying method.          # Call the underlying method.
2476          $self->{_erdb}->InsertObject($objectType, $fieldHash);      $self->InsertObject($objectType, $fieldHash);
2477  }  }
2478    
2479  =head3 Annotate  =head3 Annotate
2480    
2481  C<< my $ok = $sprout->Annotate($fid, $timestamp, $user, $text); >>      my $ok = $sprout->Annotate($fid, $timestamp, $user, $text);
2482    
2483  Annotate a feature. This inserts an Annotation record into the database and links it to the  Annotate a feature. This inserts an Annotation record into the database and links it to the
2484  specified feature and user.  specified feature and user.
# Line 1583  Line 2512 
2512  #: Return Type $;  #: Return Type $;
2513  sub Annotate {  sub Annotate {
2514          # Get the parameters.          # Get the parameters.
2515          my $self = shift @_;      my ($self, $fid, $timestamp, $user, $text) = @_;
         my ($fid, $timestamp, $user, $text) = @_;  
2516          # Create the annotation ID.          # Create the annotation ID.
2517          my $aid = "$fid:$timestamp";          my $aid = "$fid:$timestamp";
2518          # Insert the Annotation object.          # Insert the Annotation object.
# Line 1604  Line 2532 
2532    
2533  =head3 AssignFunction  =head3 AssignFunction
2534    
2535  C<< my $ok = $sprout->AssignFunction($featureID, $user, $function); >>      my $ok = $sprout->AssignFunction($featureID, $user, $function, $assigningUser);
2536    
2537  This method assigns a function to a feature. Functions are a special type of annotation. The general  This method assigns a function to a feature. Functions are a special type of annotation. The general
2538  format is "XXXX\nset XXXX function to\nYYYYY" where XXXX is the feature type and YYYY is the functional  format is described in L</ParseAssignment>.
 assignment text.  
2539    
2540  =over 4  =over 4
2541    
# Line 1618  Line 2545 
2545    
2546  =item user  =item user
2547    
2548  Name of the user making the assignment. This is frequently a group name, like C<kegg> or C<fig>.  Name of the user group making the assignment, such as C<kegg> or C<fig>.
2549    
2550  =item function  =item function
2551    
2552  Text of the function being assigned.  Text of the function being assigned.
2553    
2554    =item assigningUser (optional)
2555    
2556    Name of the individual user making the assignment. If omitted, defaults to the user group.
2557    
2558  =item RETURN  =item RETURN
2559    
2560  Returns 1 if successful, 0 if an error occurred.  Returns 1 if successful, 0 if an error occurred.
# Line 1634  Line 2565 
2565  #: Return Type $;  #: Return Type $;
2566  sub AssignFunction {  sub AssignFunction {
2567          # Get the parameters.          # Get the parameters.
2568          my $self = shift @_;      my ($self, $featureID, $user, $function, $assigningUser) = @_;
2569          my ($featureID, $user, $function) = @_;      # Default the assigning user.
2570        if (! $assigningUser) {
2571            $assigningUser = $user;
2572        }
2573          # Create an annotation string from the parameters.          # Create an annotation string from the parameters.
2574          my $annotationText = "$user\nset $user function to\n$function";      my $annotationText = "$assigningUser\nset $user function to\n$function";
2575          # Get the current time.          # Get the current time.
2576          my $now = time;          my $now = time;
2577          # Declare the return variable.          # Declare the return variable.
# Line 1658  Line 2592 
2592    
2593  =head3 FeaturesByAlias  =head3 FeaturesByAlias
2594    
2595  C<< my @features = $sprout->FeaturesByAlias($alias); >>      my @features = $sprout->FeaturesByAlias($alias);
2596    
2597  Returns a list of features with the specified alias. The alias is parsed to determine  Returns a list of features with the specified alias. The alias is parsed to determine
2598  the type of the alias. A string of digits is a GenBack ID and a string of exactly 6  the type of the alias. A string of digits is a GenBack ID and a string of exactly 6
# Line 1682  Line 2616 
2616  #: Return Type @;  #: Return Type @;
2617  sub FeaturesByAlias {  sub FeaturesByAlias {
2618          # Get the parameters.          # Get the parameters.
2619          my $self = shift @_;      my ($self, $alias) = @_;
         my ($alias) = @_;  
2620          # Declare the return variable.          # Declare the return variable.
2621          my @retVal = ();          my @retVal = ();
2622          # Parse the alias.          # Parse the alias.
# Line 1693  Line 2626 
2626                  push @retVal, $mappedAlias;                  push @retVal, $mappedAlias;
2627          } else {          } else {
2628                  # Here we have a non-FIG alias. Get the features with the normalized alias.                  # Here we have a non-FIG alias. Get the features with the normalized alias.
2629                  @retVal = $self->GetFlat(['Feature'], 'Feature(alias) = ?', [$mappedAlias], 'Feature(id)');          @retVal = $self->GetFlat(['IsAliasOf'], 'IsAliasOf(from-link) = ?', [$mappedAlias], 'IsAliasOf(to-link)');
2630          }          }
2631          # Return the result.          # Return the result.
2632          return @retVal;          return @retVal;
2633  }  }
2634    
 =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 = shift @_;  
         my ($entityName, $entityID) = @_;  
         # Check for the entity instance.  
         my $testInstance = $self->GetEntity($entityName, $entityID);  
         # Return an existence indicator.  
         my $retVal = ($testInstance ? 1 : 0);  
         return $retVal;  
 }  
   
2635  =head3 FeatureTranslation  =head3 FeatureTranslation
2636    
2637  C<< my $translation = $sprout->FeatureTranslation($featureID); >>      my $translation = $sprout->FeatureTranslation($featureID);
2638    
2639  Return the translation of a feature.  Return the translation of a feature.
2640    
# Line 1756  Line 2654 
2654  #: Return Type $;  #: Return Type $;
2655  sub FeatureTranslation {  sub FeatureTranslation {
2656          # Get the parameters.          # Get the parameters.
2657          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
2658          # Get the specified feature's translation.          # Get the specified feature's translation.
2659          my ($retVal) = $self->GetEntityValues("Feature", $featureID, ['Feature(translation)']);          my ($retVal) = $self->GetEntityValues("Feature", $featureID, ['Feature(translation)']);
2660          return $retVal;          return $retVal;
# Line 1765  Line 2662 
2662    
2663  =head3 Taxonomy  =head3 Taxonomy
2664    
2665  C<< my @taxonomyList = $sprout->Taxonomy($genome); >>      my @taxonomyList = $sprout->Taxonomy($genome);
2666    
2667  Return the taxonomy of the specified genome. This will be in the form of a list  Return the taxonomy of the specified genome. This will be in the form of a list
2668  containing the various classifications in order from domain (eg. C<Bacteria>, C<Archaea>,  containing the various classifications in order from domain (eg. C<Bacteria>, C<Archaea>,
2669  or C<Eukaryote>) to sub-species. For example,  or C<Eukaryote>) to sub-species. For example,
2670    
2671  C<< (Bacteria, Proteobacteria, Gammaproteobacteria, Enterobacteriales, Enterobacteriaceae, Escherichia, Escherichia coli, Escherichia coli K12) >>      (Bacteria, Proteobacteria, Gammaproteobacteria, Enterobacteriales, Enterobacteriaceae, Escherichia, Escherichia coli, Escherichia coli K12)
2672    
2673  =over 4  =over 4
2674    
# Line 1789  Line 2686 
2686  #: Return Type @;  #: Return Type @;
2687  sub Taxonomy {  sub Taxonomy {
2688          # Get the parameters.          # Get the parameters.
2689          my $self = shift @_;      my ($self, $genome) = @_;
         my ($genome) = @_;  
2690          # Find the specified genome's taxonomy string.          # Find the specified genome's taxonomy string.
2691          my ($list) = $self->GetEntityValues('Genome', $genome, ['Genome(taxonomy)']);          my ($list) = $self->GetEntityValues('Genome', $genome, ['Genome(taxonomy)']);
2692          # Declare the return variable.          # Declare the return variable.
# Line 1807  Line 2703 
2703    
2704  =head3 CrudeDistance  =head3 CrudeDistance
2705    
2706  C<< my $distance = $sprout->CrudeDistance($genome1, $genome2); >>      my $distance = $sprout->CrudeDistance($genome1, $genome2);
2707    
2708  Returns a crude estimate of the distance between two genomes. The distance is construed so  Returns a crude estimate of the distance between two genomes. The distance is construed so
2709  that it will be 0 for genomes with identical taxonomies and 1 for genomes from different domains.  that it will be 0 for genomes with identical taxonomies and 1 for genomes from different domains.
# Line 1833  Line 2729 
2729  #: Return Type $;  #: Return Type $;
2730  sub CrudeDistance {  sub CrudeDistance {
2731          # Get the parameters.          # Get the parameters.
2732          my $self = shift @_;      my ($self, $genome1, $genome2) = @_;
         my ($genome1, $genome2) = @_;  
2733          # Insure that the distance is commutative by sorting the genome IDs.          # Insure that the distance is commutative by sorting the genome IDs.
2734          my ($genomeA, $genomeB);          my ($genomeA, $genomeB);
2735          if ($genome2 < $genome2) {          if ($genome2 < $genome2) {
# Line 1860  Line 2755 
2755    
2756  =head3 RoleName  =head3 RoleName
2757    
2758  C<< my $roleName = $sprout->RoleName($roleID); >>      my $roleName = $sprout->RoleName($roleID);
2759    
2760  Return the descriptive name of the role with the specified ID. In general, a role  Return the descriptive name of the role with the specified ID. In general, a role
2761  will only have a descriptive name if it is coded as an EC number.  will only have a descriptive name if it is coded as an EC number.
# Line 1881  Line 2776 
2776  #: Return Type $;  #: Return Type $;
2777  sub RoleName {  sub RoleName {
2778          # Get the parameters.          # Get the parameters.
2779          my $self = shift @_;      my ($self, $roleID) = @_;
         my ($roleID) = @_;  
2780          # Get the specified role's name.          # Get the specified role's name.
2781          my ($retVal) = $self->GetEntityValues('Role', $roleID, ['Role(name)']);          my ($retVal) = $self->GetEntityValues('Role', $roleID, ['Role(name)']);
2782          # Use the ID if the role has no name.          # Use the ID if the role has no name.
# Line 1895  Line 2789 
2789    
2790  =head3 RoleDiagrams  =head3 RoleDiagrams
2791    
2792  C<< my @diagrams = $sprout->RoleDiagrams($roleID); >>      my @diagrams = $sprout->RoleDiagrams($roleID);
2793    
2794  Return a list of the diagrams containing a specified functional role.  Return a list of the diagrams containing a specified functional role.
2795    
# Line 1915  Line 2809 
2809  #: Return Type @;  #: Return Type @;
2810  sub RoleDiagrams {  sub RoleDiagrams {
2811          # Get the parameters.          # Get the parameters.
2812          my $self = shift @_;      my ($self, $roleID) = @_;
         my ($roleID) = @_;  
2813          # Query for the diagrams.          # Query for the diagrams.
2814          my @retVal = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],          my @retVal = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],
2815                                                                  'RoleOccursIn(to-link)');                                                                  'RoleOccursIn(to-link)');
# Line 1926  Line 2819 
2819    
2820  =head3 FeatureProperties  =head3 FeatureProperties
2821    
2822  C<< my @properties = $sprout->FeatureProperties($featureID); >>      my @properties = $sprout->FeatureProperties($featureID);
2823    
2824  Return a list of the properties for the specified feature. Properties are key-value pairs  Return a list of the properties for the specified feature. Properties are key-value pairs
2825  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
2826  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
2827  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
2828  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.  
2829    
2830  =over 4  =over 4
2831    
# Line 1944  Line 2835 
2835    
2836  =item RETURN  =item RETURN
2837    
2838  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.  
2839    
2840  =back  =back
2841    
# Line 1953  Line 2843 
2843  #: Return Type @@;  #: Return Type @@;
2844  sub FeatureProperties {  sub FeatureProperties {
2845          # Get the parameters.          # Get the parameters.
2846          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
2847          # Get the properties.          # Get the properties.
2848          my @retVal = $self->GetAll(['HasProperty', 'Property'], "HasProperty(from-link) = ?", [$featureID],      my @attributes = $self->{_ca}->GetAttributes($featureID);
2849                                                          ['Property(property-name)', 'Property(property-value)',      # Strip the feature ID off each tuple.
2850                                                           'HasProperty(evidence)']);      my @retVal = ();
2851        for my $attributeRow (@attributes) {
2852            shift @{$attributeRow};
2853            push @retVal, $attributeRow;
2854        }
2855          # Return the resulting list.          # Return the resulting list.
2856          return @retVal;          return @retVal;
2857  }  }
2858    
2859  =head3 DiagramName  =head3 DiagramName
2860    
2861  C<< my $diagramName = $sprout->DiagramName($diagramID); >>      my $diagramName = $sprout->DiagramName($diagramID);
2862    
2863  Return the descriptive name of a diagram.  Return the descriptive name of a diagram.
2864    
# Line 1985  Line 2878 
2878  #: Return Type $;  #: Return Type $;
2879  sub DiagramName {  sub DiagramName {
2880          # Get the parameters.          # Get the parameters.
2881          my $self = shift @_;      my ($self, $diagramID) = @_;
         my ($diagramID) = @_;  
2882          # Get the specified diagram's name and return it.          # Get the specified diagram's name and return it.
2883          my ($retVal) = $self->GetEntityValues('Diagram', $diagramID, ['Diagram(name)']);          my ($retVal) = $self->GetEntityValues('Diagram', $diagramID, ['Diagram(name)']);
2884          return $retVal;          return $retVal;
2885  }  }
2886    
2887    =head3 PropertyID
2888    
2889        my $id = $sprout->PropertyID($propName, $propValue);
2890    
2891    Return the ID of the specified property name and value pair, if the
2892    pair exists. Only a small subset of the FIG attributes are stored as
2893    Sprout properties, mostly for use in search optimization.
2894    
2895    =over 4
2896    
2897    =item propName
2898    
2899    Name of the desired property.
2900    
2901    =item propValue
2902    
2903    Value expected for the desired property.
2904    
2905    =item RETURN
2906    
2907    Returns the ID of the name/value pair, or C<undef> if the pair does not exist.
2908    
2909    =back
2910    
2911    =cut
2912    
2913    sub PropertyID {
2914        # Get the parameters.
2915        my ($self, $propName, $propValue) = @_;
2916        # Try to find the ID.
2917        my ($retVal) = $self->GetFlat(['Property'],
2918                                      "Property(property-name) = ? AND Property(property-value) = ?",
2919                                      [$propName, $propValue], 'Property(id)');
2920        # Return the result.
2921        return $retVal;
2922    }
2923    
2924  =head3 MergedAnnotations  =head3 MergedAnnotations
2925    
2926  C<< my @annotationList = $sprout->MergedAnnotations(\@list); >>      my @annotationList = $sprout->MergedAnnotations(\@list);
2927    
2928  Returns a merged list of the annotations for the features in a list. Each annotation is  Returns a merged list of the annotations for the features in a list. Each annotation is
2929  represented by a 4-tuple of the form C<($fid, $timestamp, $userID, $annotation)>, where  represented by a 4-tuple of the form C<($fid, $timestamp, $userID, $annotation)>, where
# Line 2018  Line 2947 
2947  #: Return Type @;  #: Return Type @;
2948  sub MergedAnnotations {  sub MergedAnnotations {
2949          # Get the parameters.          # Get the parameters.
2950          my $self = shift @_;      my ($self, $list) = @_;
         my ($list) = @_;  
2951          # Create a list to hold the annotation tuples found.          # Create a list to hold the annotation tuples found.
2952          my @tuples = ();          my @tuples = ();
2953          # Loop through the features in the input list.          # Loop through the features in the input list.
# Line 2044  Line 2972 
2972    
2973  =head3 RoleNeighbors  =head3 RoleNeighbors
2974    
2975  C<< my @roleList = $sprout->RoleNeighbors($roleID); >>      my @roleList = $sprout->RoleNeighbors($roleID);
2976    
2977  Returns a list of the roles that occur in the same diagram as the specified role. Because  Returns a list of the roles that occur in the same diagram as the specified role. Because
2978  diagrams and roles are in a many-to-many relationship with each other, the list is  diagrams and roles are in a many-to-many relationship with each other, the list is
# Line 2067  Line 2995 
2995  #: Return Type @;  #: Return Type @;
2996  sub RoleNeighbors {  sub RoleNeighbors {
2997          # Get the parameters.          # Get the parameters.
2998          my $self = shift @_;      my ($self, $roleID) = @_;
         my ($roleID) = @_;  
2999          # Get all the diagrams containing this role.          # Get all the diagrams containing this role.
3000          my @diagrams = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],          my @diagrams = $self->GetFlat(['RoleOccursIn'], "RoleOccursIn(from-link) = ?", [$roleID],
3001                                                                    'RoleOccursIn(to-link)');                                                                    'RoleOccursIn(to-link)');
# Line 2088  Line 3015 
3015    
3016  =head3 FeatureLinks  =head3 FeatureLinks
3017    
3018  C<< my @links = $sprout->FeatureLinks($featureID); >>      my @links = $sprout->FeatureLinks($featureID);
3019    
3020  Return a list of the web hyperlinks associated with a feature. The web hyperlinks are  Return a list of the web hyperlinks associated with a feature. The web hyperlinks are
3021  to external websites describing either the feature itself or the organism containing it  to external websites describing either the feature itself or the organism containing it
# Line 2110  Line 3037 
3037  #: Return Type @;  #: Return Type @;
3038  sub FeatureLinks {  sub FeatureLinks {
3039          # Get the parameters.          # Get the parameters.
3040          my $self = shift @_;      my ($self, $featureID) = @_;
         my ($featureID) = @_;  
3041          # Get the feature's links.          # Get the feature's links.
3042          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(link)']);          my @retVal = $self->GetEntityValues('Feature', $featureID, ['Feature(link)']);
3043          # Return the feature's links.          # Return the feature's links.
# Line 2120  Line 3046 
3046    
3047  =head3 SubsystemsOf  =head3 SubsystemsOf
3048    
3049  C<< my %subsystems = $sprout->SubsystemsOf($featureID); >>      my %subsystems = $sprout->SubsystemsOf($featureID);
3050    
3051  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
3052  to the role the feature performs.  to the roles the feature performs.
3053    
3054  =over 4  =over 4
3055    
# Line 2133  Line 3059 
3059    
3060  =item RETURN  =item RETURN
3061    
3062  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.
3063    
3064  =back  =back
3065    
3066  =cut  =cut
3067  #: Return Type %;  #: Return Type %@;
3068  sub SubsystemsOf {  sub SubsystemsOf {
3069          # Get the parameters.          # Get the parameters.
3070          my $self = shift @_;      my ($self, $featureID) = @_;
3071          my ($featureID) = @_;      # Get the subsystem list.
         # Use the SSCell to connect features to subsystems.  
3072          my @subsystems = $self->GetAll(['ContainsFeature', 'HasSSCell', 'IsRoleOf'],          my @subsystems = $self->GetAll(['ContainsFeature', 'HasSSCell', 'IsRoleOf'],
3073                                                                          "ContainsFeature(to-link) = ?", [$featureID],                                                                          "ContainsFeature(to-link) = ?", [$featureID],
3074                                                                          ['HasSSCell(from-link)', 'IsRoleOf(from-link)']);                                                                          ['HasSSCell(from-link)', 'IsRoleOf(from-link)']);
3075          # Create the return value.          # Create the return value.
3076          my %retVal = ();          my %retVal = ();
3077        # Build a hash to weed out duplicates. Sometimes the same PEG and role appears
3078        # in two spreadsheet cells.
3079        my %dupHash = ();
3080          # Loop through the results, adding them to the hash.          # Loop through the results, adding them to the hash.
3081          for my $record (@subsystems) {          for my $record (@subsystems) {
3082                  $retVal{$record->[0]} = $record->[1];          # Get this subsystem and role.
3083            my ($subsys, $role) = @{$record};
3084            # Insure it's the first time for both.
3085            my $dupKey = "$subsys\n$role";
3086            if (! exists $dupHash{"$subsys\n$role"}) {
3087                $dupHash{$dupKey} = 1;
3088                push @{$retVal{$subsys}}, $role;
3089            }
3090          }          }
3091          # Return the hash.          # Return the hash.
3092          return %retVal;          return %retVal;
3093  }  }
3094    
3095    =head3 SubsystemList
3096    
3097        my @subsystems = $sprout->SubsystemList($featureID);
3098    
3099    Return a list containing the names of the subsystems in which the specified
3100    feature participates. Unlike L</SubsystemsOf>, this method only returns the
3101    subsystem names, not the roles.
3102    
3103    =over 4
3104    
3105    =item featureID
3106    
3107    ID of the feature whose subsystem names are desired.
3108    
3109    =item RETURN
3110    
3111    Returns a list of the names of the subsystems in which the feature participates.
3112    
3113    =back
3114    
3115    =cut
3116    #: Return Type @;
3117    sub SubsystemList {
3118        # Get the parameters.
3119        my ($self, $featureID) = @_;
3120        # Get the list of names.
3121        my @retVal = $self->GetFlat(['HasRoleInSubsystem'], "HasRoleInSubsystem(from-link) = ?",
3122                                    [$featureID], 'HasRoleInSubsystem(to-link)');
3123        # Return the result, sorted.
3124        return sort @retVal;
3125    }
3126    
3127    =head3 GenomeSubsystemData
3128    
3129        my %featureData = $sprout->GenomeSubsystemData($genomeID);
3130    
3131    Return a hash mapping genome features to their subsystem roles.
3132    
3133    =over 4
3134    
3135    =item genomeID
3136    
3137    ID of the genome whose subsystem feature map is desired.
3138    
3139    =item RETURN
3140    
3141    Returns a hash mapping each feature of the genome to a list of 2-tuples. Eacb
3142    2-tuple contains a subsystem name followed by a role ID.
3143    
3144    =back
3145    
3146    =cut
3147    
3148    sub GenomeSubsystemData {
3149        # Get the parameters.
3150        my ($self, $genomeID) = @_;
3151        # Declare the return variable.
3152        my %retVal = ();
3153        # Get a list of the genome features that participate in subsystems. For each
3154        # feature we get its spreadsheet cells and the corresponding roles.
3155        my @roleData = $self->GetAll(['HasFeature', 'ContainsFeature', 'IsRoleOf'],
3156                                 "HasFeature(from-link) = ?", [$genomeID],
3157                                 ['HasFeature(to-link)', 'IsRoleOf(to-link)', 'IsRoleOf(from-link)']);
3158        # Now we get a list of the spreadsheet cells and their associated subsystems. Subsystems
3159        # with an unknown variant code (-1) are skipped. Note the genome ID is at both ends of the
3160        # list. We use it at the beginning to get all the spreadsheet cells for the genome and
3161        # again at the end to filter out participation in subsystems with a negative variant code.
3162        my @cellData = $self->GetAll(['IsGenomeOf', 'HasSSCell', 'ParticipatesIn'],
3163                                     "IsGenomeOf(from-link) = ? AND ParticipatesIn(variant-code) >= 0 AND ParticipatesIn(from-link) = ?",
3164                                     [$genomeID, $genomeID], ['HasSSCell(to-link)', 'HasSSCell(from-link)']);
3165        # Now "@roleData" lists the spreadsheet cell and role for each of the genome's features.
3166        # "@cellData" lists the subsystem name for each of the genome's spreadsheet cells. We
3167        # link these two lists together to create the result. First, we want a hash mapping
3168        # spreadsheet cells to subsystem names.
3169        my %subHash = map { $_->[0] => $_->[1] } @cellData;
3170        # We loop through @cellData to build the hash.
3171        for my $roleEntry (@roleData) {
3172            # Get the data for this feature and cell.
3173            my ($fid, $cellID, $role) = @{$roleEntry};
3174            # Check for a subsystem name.
3175            my $subsys = $subHash{$cellID};
3176            if ($subsys) {
3177                # Insure this feature has an entry in the return hash.
3178                if (! exists $retVal{$fid}) { $retVal{$fid} = []; }
3179                # Merge in this new data.
3180                push @{$retVal{$fid}}, [$subsys, $role];
3181            }
3182        }
3183        # Return the result.
3184        return %retVal;
3185    }
3186    
3187  =head3 RelatedFeatures  =head3 RelatedFeatures
3188    
3189  C<< my @relatedList = $sprout->RelatedFeatures($featureID, $function, $userID); >>      my @relatedList = $sprout->RelatedFeatures($featureID, $function, $userID);
3190    
3191  Return a list of the features which are bi-directional best hits of the specified feature and  Return a list of the features which are bi-directional best hits of the specified feature and
3192  have been assigned the specified function by the specified user. If no such features exists,  have been assigned the specified function by the specified user. If no such features exists,
# Line 2190  Line 3217 
3217  #: Return Type @;  #: Return Type @;
3218  sub RelatedFeatures {  sub RelatedFeatures {
3219          # Get the parameters.          # Get the parameters.
3220          my $self = shift @_;      my ($self, $featureID, $function, $userID) = @_;
         my ($featureID, $function, $userID) = @_;  
3221          # 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.
3222          my @bbhFeatures = $self->GetFlat(['IsBidirectionalBestHitOf'],      my @bbhFeatures = map { $_->[0] } FIGRules::BBHData($featureID);
                                                                          "IsBidirectionalBestHitOf(from-link) = ?", [$featureID],  
                                                                          'IsBidirectionalBestHitOf(to-link)');  
3223          # 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
3224          # functional assignment.          # functional assignment.
3225          my @retVal = ();          my @retVal = ();
# Line 2213  Line 3237 
3237    
3238  =head3 TaxonomySort  =head3 TaxonomySort
3239    
3240  C<< my @sortedFeatureIDs = $sprout->TaxonomySort(\@featureIDs); >>      my @sortedFeatureIDs = $sprout->TaxonomySort(\@featureIDs);
3241    
3242  Return a list formed by sorting the specified features by the taxonomy of the containing  Return a list formed by sorting the specified features by the taxonomy of the containing
3243  genome. This will cause genomes from similar organisms to float close to each other.  genome. This will cause genomes from similar organisms to float close to each other.
# Line 2239  Line 3263 
3263  #: Return Type @;  #: Return Type @;
3264  sub TaxonomySort {  sub TaxonomySort {
3265          # Get the parameters.          # Get the parameters.
3266          my $self = shift @_;      my ($self, $featureIDs) = @_;
         my ($featureIDs) = @_;  
3267          # Create the working hash table.          # Create the working hash table.
3268          my %hashBuffer = ();          my %hashBuffer = ();
3269          # Loop through the features.          # Loop through the features.
# Line 2249  Line 3272 
3272                  my ($taxonomy) = $self->GetFlat(['IsLocatedIn', 'HasContig', 'Genome'], "IsLocatedIn(from-link) = ?",                  my ($taxonomy) = $self->GetFlat(['IsLocatedIn', 'HasContig', 'Genome'], "IsLocatedIn(from-link) = ?",
3273                                                                                  [$fid], 'Genome(taxonomy)');                                                                                  [$fid], 'Genome(taxonomy)');
3274                  # Add this feature to the hash buffer.                  # Add this feature to the hash buffer.
                 if (exists $hashBuffer{$taxonomy}) {  
3275                          push @{$hashBuffer{$taxonomy}}, $fid;                          push @{$hashBuffer{$taxonomy}}, $fid;
                 } else {  
                         $hashBuffer{$taxonomy} = [$fid];  
                 }  
3276          }          }
3277          # Sort the keys and get the elements.          # Sort the keys and get the elements.
3278          my @retVal = ();          my @retVal = ();
# Line 2264  Line 3283 
3283          return @retVal;          return @retVal;
3284  }  }
3285    
3286  =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.  
3287    
3288  The list returned will be a list of lists. Each element of the list will contain      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.  
3289    
3290  C<< $query = $sprout->Get(['ContainsFeature', 'Feature'], "ContainsFeature(from-link) = ?", [$ssCellID], ['Feature(id)', 'Feature(alias)']); >>  Translate a DNA sequence into a protein sequence.
3291    
3292  =over 4  =over 4
3293    
3294  =item objectNames  =item sequence
   
 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 fields  
3295    
3296  List of the fields to be returned in each element of the list returned.  DNA sequence to translate.
3297    
3298  =item count  =item table (optional)
3299    
3300  Maximum number of records to return. If omitted or 0, all available records will be returned.  Reference to a Hash that translates DNA triples to proteins. A triple that does not
3301    appear in the hash will be translated automatically to C<X>.
3302    
3303  =item RETURN  =item RETURN
3304    
3305  Returns a list of list references. Each element of the return list contains the values for the  Returns the protein sequence that would be created by the DNA sequence.
 fields specified in the B<fields> parameter.  
   
 =back  
   
 =cut  
 #: Return Type @@;  
 sub GetAll {  
         # Get the parameters.  
         my $self = shift @_;  
         my ($objectNames, $filterClause, $parameterList, $fields, $count) = @_;  
         # Create the query.  
         my $query = $self->Get($objectNames, $filterClause, $parameterList);  
         # Set up a counter of the number of records read.  
         my $fetched = 0;  
         # Insure the counter has a value.  
         if (!defined $count) {  
                 $count = 0;  
         }  
         # Loop through the records returned, extracting the fields. Note that if the  
         # counter is non-zero, we stop when the number of records read hits the count.  
         my @retVal = ();  
         while (($count == 0 || $fetched < $count) && (my $row = $query->Fetch())) {  
                 my @rowData = $row->Values($fields);  
                 push @retVal, \@rowData;  
                 $fetched++;  
         }  
         # 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 = shift @_;  
         my ($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.  
3306    
3307  =back  =back
3308    
# Line 2470  Line 3355 
3355          # Loop through the input triples.          # Loop through the input triples.
3356          my $n = length $sequence;          my $n = length $sequence;
3357          for (my $i = 0; $i < $n; $i += 3) {          for (my $i = 0; $i < $n; $i += 3) {
3358                  # Get the current triple from the sequence.          # Get the current triple from the sequence. Note we convert to
3359                  my $triple = substr($sequence, $i, 3);          # upper case to insure a match.
3360            my $triple = uc substr($sequence, $i, 3);
3361                  # Translate it using the table.                  # Translate it using the table.
3362                  my $protein = "X";                  my $protein = "X";
3363                  if (exists $table->{$triple}) { $protein = $table->{$triple}; }                  if (exists $table->{$triple}) { $protein = $table->{$triple}; }
# Line 2485  Line 3371 
3371    
3372  =head3 LoadInfo  =head3 LoadInfo
3373    
3374  C<< my ($dirName, @relNames) = $sprout->LoadInfo(); >>      my ($dirName, @relNames) = $sprout->LoadInfo();
3375    
3376  Return the name of the directory from which data is to be loaded and a list of the relation  Return the name of the directory from which data is to be loaded and a list of the relation
3377  names. This information is useful when trying to analyze what needs to be put where in order  names. This information is useful when trying to analyze what needs to be put where in order
# Line 2495  Line 3381 
3381  #: Return Type @;  #: Return Type @;
3382  sub LoadInfo {  sub LoadInfo {
3383          # Get the parameters.          # Get the parameters.
3384          my $self = shift @_;      my ($self) = @_;
3385          # 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.
3386          my @retVal = ($self->{_options}->{dataDir});          my @retVal = ($self->{_options}->{dataDir});
3387          # Concatenate the table names.          # Concatenate the table names.
3388          push @retVal, $self->{_erdb}->GetTableNames();      push @retVal, $self->GetTableNames();
3389          # Return the result.          # Return the result.
3390          return @retVal;          return @retVal;
3391  }  }
3392    
3393    =head3 BBHMatrix
3394    
3395        my %bbhMap = $sprout->BBHMatrix($genomeID, $cutoff, @targets);
3396    
3397    Find all the bidirectional best hits for the features of a genome in a
3398    specified list of target genomes. The return value will be a hash mapping
3399    features in the original genome to their bidirectional best hits in the
3400    target genomes.
3401    
3402    =over 4
3403    
3404    =item genomeID
3405    
3406    ID of the genome whose features are to be examined for bidirectional best hits.
3407    
3408    =item cutoff
3409    
3410    A cutoff value. Only hits with a score lower than the cutoff will be returned.
3411    
3412    =item targets
3413    
3414    List of target genomes. Only pairs originating in the original
3415    genome and landing in one of the target genomes will be returned.
3416    
3417    =item RETURN
3418    
3419    Returns a hash mapping each feature in the original genome to a hash mapping its
3420    BBH pegs in the target genomes to their scores.
3421    
3422    =back
3423    
3424    =cut
3425    
3426    sub BBHMatrix {
3427        # Get the parameters.
3428        my ($self, $genomeID, $cutoff, @targets) = @_;
3429        # Declare the return variable.
3430        my %retVal = ();
3431        # Ask for the BBHs.
3432        my @bbhList = FIGRules::BatchBBHs("fig|$genomeID.%", $cutoff, @targets);
3433        # We now have a set of 4-tuples that we need to convert into a hash of hashes.
3434        for my $bbhData (@bbhList) {
3435            my ($peg1, $peg2, $score) = @{$bbhData};
3436            if (! exists $retVal{$peg1}) {
3437                $retVal{$peg1} = { $peg2 => $score };
3438            } else {
3439                $retVal{$peg1}->{$peg2} = $score;
3440            }
3441        }
3442        # Return the result.
3443        return %retVal;
3444    }
3445    
3446    
3447    =head3 SimMatrix
3448    
3449        my %simMap = $sprout->SimMatrix($genomeID, $cutoff, @targets);
3450    
3451    Find all the similarities for the features of a genome in a
3452    specified list of target genomes. The return value will be a hash mapping
3453    features in the original genome to their similarites in the
3454    target genomes.
3455    
3456    =over 4
3457    
3458    =item genomeID
3459    
3460    ID of the genome whose features are to be examined for similarities.
3461    
3462    =item cutoff
3463    
3464    A cutoff value. Only hits with a score lower than the cutoff will be returned.
3465    
3466    =item targets
3467    
3468    List of target genomes. Only pairs originating in the original
3469    genome and landing in one of the target genomes will be returned.
3470    
3471    =item RETURN
3472    
3473    Returns a hash mapping each feature in the original genome to a hash mapping its
3474    similar pegs in the target genomes to their scores.
3475    
3476    =back
3477    
3478    =cut
3479    
3480    sub SimMatrix {
3481        # Get the parameters.
3482        my ($self, $genomeID, $cutoff, @targets) = @_;
3483        # Declare the return variable.
3484        my %retVal = ();
3485        # Get the list of features in the source organism.
3486        my @fids = $self->FeaturesOf($genomeID);
3487        # Ask for the sims. We only want similarities to fig features.
3488        my $simList = FIGRules::GetNetworkSims($self, \@fids, {}, 1000, $cutoff, "fig");
3489        if (! defined $simList) {
3490            Confess("Unable to retrieve similarities from server.");
3491        } else {
3492            Trace("Processing sims.") if T(3);
3493            # We now have a set of sims that we need to convert into a hash of hashes. First, we
3494            # Create a hash for the target genomes.
3495            my %targetHash = map { $_ => 1 } @targets;
3496            for my $simData (@{$simList}) {
3497                # Get the PEGs and the score.
3498                my ($peg1, $peg2, $score) = ($simData->id1, $simData->id2, $simData->psc);
3499                # Insure the second ID is in the target list.
3500                my ($genome2) = FIGRules::ParseFeatureID($peg2);
3501                if (exists $targetHash{$genome2}) {
3502                    # Here it is. Now we need to add it to the return hash. How we do that depends
3503                    # on whether or not $peg1 is new to us.
3504                    if (! exists $retVal{$peg1}) {
3505                        $retVal{$peg1} = { $peg2 => $score };
3506                    } else {
3507                        $retVal{$peg1}->{$peg2} = $score;
3508                    }
3509                }
3510            }
3511        }
3512        # Return the result.
3513        return %retVal;
3514    }
3515    
3516    
3517  =head3 LowBBHs  =head3 LowBBHs
3518    
3519  C<< my %bbhMap = $sprout->GoodBBHs($featureID, $cutoff); >>      my %bbhMap = $sprout->LowBBHs($featureID, $cutoff);
3520    
3521  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
3522  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 2532  Line 3542 
3542  #: Return Type %;  #: Return Type %;
3543  sub LowBBHs {  sub LowBBHs {
3544          # Get the parsameters.          # Get the parsameters.
3545          my $self = shift @_;      my ($self, $featureID, $cutoff) = @_;
         my ($featureID, $cutoff) = @_;  
3546          # Create the return hash.          # Create the return hash.
3547          my %retVal = ();          my %retVal = ();
3548          # Create a query to get the desired BBHs.      # Query for the desired BBHs.
3549          my @bbhList = $self->GetAll(['IsBidirectionalBestHitOf'],      my @bbhList = FIGRules::BBHData($featureID, $cutoff);
                                                                 'IsBidirectionalBestHitOf(sc) <= ? AND IsBidirectionalBestHitOf(from-link) = ?',  
                                                                 [$cutoff, $featureID],  
                                                                 ['IsBidirectionalBestHitOf(to-link)', 'IsBidirectionalBestHitOf(sc)']);  
3550          # Form the results into the return hash.          # Form the results into the return hash.
3551          for my $pair (@bbhList) {          for my $pair (@bbhList) {
3552                  $retVal{$pair->[0]} = $pair->[1];          my $fid = $pair->[0];
3553            if ($self->Exists('Feature', $fid)) {
3554                $retVal{$fid} = $pair->[1];
3555            }
3556        }
3557        # Return the result.
3558        return %retVal;
3559    }
3560    
3561    =head3 Sims
3562    
3563        my $simList = $sprout->Sims($fid, $maxN, $maxP, $select, $max_expand, $filters);
3564    
3565    Get a list of similarities for a specified feature. Similarity information is not kept in the
3566    Sprout database; rather, they are retrieved from a network server. The similarities are
3567    returned as B<Sim> objects. A Sim object is actually a list reference that has been blessed
3568    so that its elements can be accessed by name.
3569    
3570    Similarities can be either raw or expanded. The raw similarities are basic
3571    hits between features with similar DNA. Expanding a raw similarity drags in any
3572    features considered substantially identical. So, for example, if features B<A1>,
3573    B<A2>, and B<A3> are all substantially identical to B<A>, then a raw similarity
3574    B<[C,A]> would be expanded to B<[C,A] [C,A1] [C,A2] [C,A3]>.
3575    
3576    =over 4
3577    
3578    =item fid
3579    
3580    ID of the feature whose similarities are desired, or reference to a list of IDs
3581    of features whose similarities are desired.
3582    
3583    =item maxN
3584    
3585    Maximum number of similarities to return.
3586    
3587    =item maxP
3588    
3589    Minumum allowable similarity score.
3590    
3591    =item select
3592    
3593    Selection criterion: C<raw> means only raw similarities are returned; C<fig>
3594    means only similarities to FIG features are returned; C<all> means all expanded
3595    similarities are returned; and C<figx> means similarities are expanded until the
3596    number of FIG features equals the maximum.
3597    
3598    =item max_expand
3599    
3600    The maximum number of features to expand.
3601    
3602    =item filters
3603    
3604    Reference to a hash containing filter information, or a subroutine that can be
3605    used to filter the sims.
3606    
3607    =item RETURN
3608    
3609    Returns a reference to a list of similarity objects, or C<undef> if an error
3610    occurred.
3611    
3612    =back
3613    
3614    =cut
3615    
3616    sub Sims {
3617        # Get the parameters.
3618        my ($self, $fid, $maxN, $maxP, $select, $max_expand, $filters) = @_;
3619        # Create the shim object to test for deleted FIDs.
3620        my $shim = FidCheck->new($self);
3621        # Ask the network for sims.
3622        my $retVal = FIGRules::GetNetworkSims($shim, $fid, {}, $maxN, $maxP, $select, $max_expand, $filters);
3623        # Return the result.
3624        return $retVal;
3625    }
3626    
3627    =head3 IsAllGenomes
3628    
3629        my $flag = $sprout->IsAllGenomes(\@list, \@checkList);
3630    
3631    Return TRUE if all genomes in the second list are represented in the first list at
3632    least one. Otherwise, return FALSE. If the second list is omitted, the first list is
3633    compared to a list of all the genomes.
3634    
3635    =over 4
3636    
3637    =item list
3638    
3639    Reference to the list to be compared to the second list.
3640    
3641    =item checkList (optional)
3642    
3643    Reference to the comparison target list. Every genome ID in this list must occur at
3644    least once in the first list. If this parameter is omitted, a list of all the genomes
3645    is used.
3646    
3647    =item RETURN
3648    
3649    Returns TRUE if every item in the second list appears at least once in the
3650    first list, else FALSE.
3651    
3652    =back
3653    
3654    =cut
3655    
3656    sub IsAllGenomes {
3657        # Get the parameters.
3658        my ($self, $list, $checkList) = @_;
3659        # Supply the checklist if it was omitted.
3660        $checkList = [$self->Genomes()] if ! defined($checkList);
3661        # Create a hash of the original list.
3662        my %testList = map { $_ => 1 } @{$list};
3663        # Declare the return variable. We assume that the representation
3664        # is complete and stop at the first failure.
3665        my $retVal = 1;
3666        my $n = scalar @{$checkList};
3667        for (my $i = 0; $retVal && $i < $n; $i++) {
3668            if (! $testList{$checkList->[$i]}) {
3669                $retVal = 0;
3670            }
3671        }
3672        # Return the result.
3673        return $retVal;
3674    }
3675    
3676    =head3 GetGroups
3677    
3678        my %groups = $sprout->GetGroups(\@groupList);
3679    
3680    Return a hash mapping each group to the IDs of the genomes in the group.
3681    A list of groups may be specified, in which case only those groups will be
3682    shown. Alternatively, if no parameter is supplied, all groups will be
3683    included. Genomes that are not in any group are omitted.
3684    
3685    =cut
3686    #: Return Type %@;
3687    sub GetGroups {
3688        # Get the parameters.
3689        my ($self, $groupList) = @_;
3690        # Declare the return value.
3691        my %retVal = ();
3692        # Determine whether we are getting all the groups or just some.
3693        if (defined $groupList) {
3694            # Here we have a group list. Loop through them individually,
3695            # getting a list of the relevant genomes.
3696            for my $group (@{$groupList}) {
3697                my @genomeIDs = $self->GetFlat(['Genome'], "Genome(primary-group) = ?",
3698                    [$group], "Genome(id)");
3699                $retVal{$group} = \@genomeIDs;
3700            }
3701        } else {
3702            # Here we need all of the groups. In this case, we run through all
3703            # of the genome records, putting each one found into the appropriate
3704            # group. Note that we use a filter clause to insure that only genomes
3705            # in real NMPDR groups are included in the return set.
3706            my @genomes = $self->GetAll(['Genome'], "Genome(primary-group) <> ?",
3707                                        [$FIG_Config::otherGroup], ['Genome(id)', 'Genome(primary-group)']);
3708            # Loop through the genomes found.
3709            for my $genome (@genomes) {
3710                # Get the genome ID and group, and add this genome to the group's list.
3711                my ($genomeID, $group) = @{$genome};
3712                push @{$retVal{$group}}, $genomeID;
3713            }
3714        }
3715        # Return the hash we just built.
3716        return %retVal;
3717    }
3718    
3719    =head3 MyGenomes
3720    
3721        my @genomes = Sprout::MyGenomes($dataDir);
3722    
3723    Return a list of the genomes to be included in the Sprout.
3724    
3725    This method is provided for use during the Sprout load. It presumes the Genome load file has
3726    already been created. (It will be in the Sprout data directory and called either C<Genome>
3727    or C<Genome.dtx>.) Essentially, it reads in the Genome load file and strips out the genome
3728    IDs.
3729    
3730    =over 4
3731    
3732    =item dataDir
3733    
3734    Directory containing the Sprout load files.
3735    
3736    =back
3737    
3738    =cut
3739    #: Return Type @;
3740    sub MyGenomes {
3741        # Get the parameters.
3742        my ($dataDir) = @_;
3743        # Compute the genome file name.
3744        my $genomeFileName = LoadFileName($dataDir, "Genome");
3745        # Extract the genome IDs from the files.
3746        my @retVal = map { $_ =~ /^(\S+)/; $1 } Tracer::GetFile($genomeFileName);
3747        # Return the result.
3748        return @retVal;
3749    }
3750    
3751    =head3 LoadFileName
3752    
3753        my $fileName = Sprout::LoadFileName($dataDir, $tableName);
3754    
3755    Return the name of the load file for the specified table in the specified data
3756    directory.
3757    
3758    =over 4
3759    
3760    =item dataDir
3761    
3762    Directory containing the Sprout load files.
3763    
3764    =item tableName
3765    
3766    Name of the table whose load file is desired.
3767    
3768    =item RETURN
3769    
3770    Returns the name of the file containing the load data for the specified table, or
3771    C<undef> if no load file is present.
3772    
3773    =back
3774    
3775    =cut
3776    #: Return Type $;
3777    sub LoadFileName {
3778        # Get the parameters.
3779        my ($dataDir, $tableName) = @_;
3780        # Declare the return variable.
3781        my $retVal;
3782        # Check for the various file names.
3783        if (-e "$dataDir/$tableName") {
3784            $retVal = "$dataDir/$tableName";
3785        } elsif (-e "$dataDir/$tableName.dtx") {
3786            $retVal = "$dataDir/$tableName.dtx";
3787          }          }
3788          # Return the result.          # Return the result.
3789        return $retVal;
3790    }
3791    
3792    =head3 DeleteGenome
3793    
3794        my $stats = $sprout->DeleteGenome($genomeID, $testFlag);
3795    
3796    Delete a genome from the database.
3797    
3798    =over 4
3799    
3800    =item genomeID
3801    
3802    ID of the genome to delete
3803    
3804    =item testFlag
3805    
3806    If TRUE, then the DELETE statements will be traced, but no deletions will occur.
3807    
3808    =item RETURN
3809    
3810    Returns a statistics object describing the rows deleted.
3811    
3812    =back
3813    
3814    =cut
3815    #: Return Type $%;
3816    sub DeleteGenome {
3817        # Get the parameters.
3818        my ($self, $genomeID, $testFlag) = @_;
3819        # Perform the delete for the genome's features.
3820        my $retVal = $self->Delete('Feature', "fig|$genomeID.%", testMode => $testFlag);
3821        # Perform the delete for the primary genome data.
3822        my $stats = $self->Delete('Genome', $genomeID, testMode => $testFlag);
3823        $retVal->Accumulate($stats);
3824        # Return the result.
3825        return $retVal;
3826    }
3827    
3828    =head3 Fix
3829    
3830        my %fixedHash = $sprout->Fix(%groupHash);
3831    
3832    Prepare a genome group hash (like that returned by L</GetGroups>) for processing.
3833    The groups will be combined into the appropriate super-groups.
3834    
3835    =over 4
3836    
3837    =item groupHash
3838    
3839    Hash to be fixed up.
3840    
3841    =item RETURN
3842    
3843    Returns a fixed-up version of the hash.
3844    
3845    =back
3846    
3847    =cut
3848    
3849    sub Fix {
3850        # Get the parameters.
3851        my ($self, %groupHash) = @_;
3852        # Create the result hash.
3853        my %retVal = ();
3854        # Copy over the genomes.
3855        for my $groupID (keys %groupHash) {
3856            # Get the super-group name.
3857            my $realGroupID = $self->SuperGroup($groupID);
3858            # Append this group's genomes into the result hash
3859            # using the super-group name.
3860            push @{$retVal{$realGroupID}}, @{$groupHash{$groupID}};
3861        }
3862        # Return the result hash.
3863          return %retVal;          return %retVal;
3864  }  }
3865    
3866    =head3 GroupPageName
3867    
3868        my $name = $sprout->GroupPageName($group);
3869    
3870    Return the name of the page for the specified NMPDR group.
3871    
3872    =over 4
3873    
3874    =item group
3875    
3876    Name of the relevant group.
3877    
3878    =item RETURN
3879    
3880    Returns the relative page name (e.g. C<../content/campy.php>). If the group file is not in
3881    memory it will be read in.
3882    
3883    =back
3884    
3885    =cut
3886    
3887    sub GroupPageName {
3888        # Get the parameters.
3889        my ($self, $group) = @_;
3890        # Check for the group file data.
3891        my %superTable = $self->CheckGroupFile();
3892        # Compute the real group name.
3893        my $realGroup = $self->SuperGroup($group);
3894        # Get the associated page name.
3895        my $retVal = "../content/$superTable{$realGroup}->{page}";
3896        # Return the result.
3897        return $retVal;
3898    }
3899    
3900    
3901    =head3 AddProperty
3902    
3903        $sprout->AddProperty($featureID, $key, @values);
3904    
3905    Add a new attribute value (Property) to a feature.
3906    
3907    =over 4
3908    
3909    =item peg
3910    
3911    ID of the feature to which the attribute is to be added.
3912    
3913    =item key
3914    
3915    Name of the attribute (key).
3916    
3917    =item values
3918    
3919    Values of the attribute.
3920    
3921    =back
3922    
3923    =cut
3924    #: Return Type ;
3925    sub AddProperty {
3926        # Get the parameters.
3927        my ($self, $featureID, $key, @values) = @_;
3928        # Add the property using the attached attributes object.
3929        $self->{_ca}->AddAttribute($featureID, $key, @values);
3930    }
3931    
3932    =head3 CheckGroupFile
3933    
3934        my %groupData = $sprout->CheckGroupFile();
3935    
3936    Get the group file hash. The group file hash describes the relationship
3937    between a group and the super-group to which it belongs for purposes of
3938    display. The super-group name is computed from the first capitalized word
3939    in the actual group name. For each super-group, the group file contains
3940    the page name and a list of the species expected to be in the group.
3941    Each species is specified by a genus and a species name. A species name
3942    of C<0> implies an entire genus.
3943    
3944    This method returns a hash from super-group names to a hash reference. Each
3945    resulting hash reference contains the following fields.
3946    
3947    =over 4
3948    
3949    =item page
3950    
3951    The super-group's web page in the NMPDR.
3952    
3953    =item contents
3954    
3955    A list of 2-tuples, each containing a genus name followed by a species name
3956    (or 0, indicating all species). This list indicates which organisms belong
3957    in the super-group.
3958    
3959    =back
3960    
3961    =cut
3962    
3963    sub CheckGroupFile {
3964        # Get the parameters.
3965        my ($self) = @_;
3966        # Check to see if we already have this hash.
3967        if (! defined $self->{groupHash}) {
3968            # We don't, so we need to read it in.
3969            my %groupHash;
3970            # Read the group file.
3971            my @groupLines = Tracer::GetFile("$FIG_Config::sproutData/groups.tbl");
3972            # Loop through the list of sort-of groups.
3973            for my $groupLine (@groupLines) {
3974                my ($name, $page, @contents) = split /\t/, $groupLine;
3975                $groupHash{$name} = { page => $page,
3976                                      contents => [ map { [ split /\s*,\s*/, $_ ] } @contents ]
3977                                    };
3978            }
3979            # Save the hash.
3980            $self->{groupHash} = \%groupHash;
3981        }
3982        # Return the result.
3983        return %{$self->{groupHash}};
3984    }
3985    
3986    =head2 Virtual Methods
3987    
3988    =head3 CleanKeywords
3989    
3990        my $cleanedString = $sprout->CleanKeywords($searchExpression);
3991    
3992    Clean up a search expression or keyword list. This involves converting the periods
3993    in EC numbers to underscores, converting non-leading minus signs to underscores,
3994    a vertical bar or colon to an apostrophe, and forcing lower case for all alphabetic
3995    characters. In addition, any extra spaces are removed.
3996    
3997    =over 4
3998    
3999    =item searchExpression
4000    
4001    Search expression or keyword list to clean. Note that a search expression may
4002    contain boolean operators which need to be preserved. This includes leading
4003    minus signs.
4004    
4005    =item RETURN
4006    
4007    Cleaned expression or keyword list.
4008    
4009    =back
4010    
4011    =cut
4012    
4013    sub CleanKeywords {
4014        # Get the parameters.
4015        my ($self, $searchExpression) = @_;
4016        # Perform the standard cleanup.
4017        my $words = $self->ERDB::CleanKeywords($searchExpression);
4018        # Fix the periods in EC and TC numbers.
4019        $words =~ s/(\d+|\-)\.(\d+|-)\.(\d+|-)\.(\d+|-)/$1_$2_$3_$4/g;
4020        # Fix non-trailing periods.
4021        $words =~ s/\.(\w)/_$1/g;
4022        # Fix non-leading minus signs.
4023        $words =~ s/(\w)[\-]/$1_/g;
4024        # Fix the vertical bars and colons
4025        $words =~ s/(\w)[|:](\w)/$1'$2/g;
4026        # Now split up the list so that each keyword is in its own string. We keep the delimiters
4027        # because they may contain boolean expression data.
4028        my @words = split /([^A-Za-z'0-9_]+)/, $words;
4029        # We'll convert the stemmable words into stems and re-assemble the result.
4030        my $retVal = "";
4031        for my $word (@words) {
4032            my $stem = $self->Stem($word);
4033            if (defined $stem) {
4034                $retVal .= $stem;
4035            } else {
4036                $retVal .= $word;
4037            }
4038        }
4039        Trace("Cleaned keyword list for \"$searchExpression\" is \"$retVal\".") if T(3);
4040        # Return the result.
4041        return $retVal;
4042    }
4043    
4044  =head2 Internal Utility Methods  =head2 Internal Utility Methods
4045    
4046  =head3 ParseAssignment  =head3 ParseAssignment
4047    
4048  Parse annotation text to determine whether or not it is a functional assignment. If it is,  Parse annotation text to determine whether or not it is a functional assignment. If it is,
4049  the user and function text will be returned as a 2-element list. If it isn't, an empty list  the user, function text, and assigning user will be returned as a 3-element list. If it
4050  will be returned.  isn't, an empty list will be returned.
4051    
4052    A functional assignment is always of the form
4053    
4054        set YYYY function to
4055        ZZZZ
4056    
4057    where I<YYYY> is the B<user>, and I<ZZZZ> is the actual functional role. In most cases,
4058    the user and the assigning user (from MadeAnnotation) will be the same, but that is
4059    not always the case.
4060    
4061    In addition, the functional role may contain extra data that is stripped, such as
4062    terminating spaces or a comment separated from the rest of the text by a tab.
4063    
4064  This is a static method.  This is a static method.
4065    
4066  =over 4  =over 4
4067    
4068    =item user
4069    
4070    Name of the assigning user.
4071    
4072  =item text  =item text
4073    
4074  Text of the annotation.  Text of the annotation.
# Line 2574  Line 4082 
4082    
4083  =cut  =cut
4084    
4085  sub ParseAssignment {  sub _ParseAssignment {
4086          # Get the parameters.          # Get the parameters.
4087          my ($text) = @_;      my ($user, $text) = @_;
4088          # Declare the return value.          # Declare the return value.
4089          my @retVal = ();          my @retVal = ();
4090          # Check to see if this is a functional assignment.          # Check to see if this is a functional assignment.
4091          my ($user, $type, $function) = split(/\n/, $text);      my ($type, $function) = split(/\n/, $text);
4092          if ($type =~ m/^set $user function to$/i) {      if ($type =~ m/^set function to$/i) {
4093                  # Here it is, so we return the user name and function text.          # Here we have an assignment without a user, so we use the incoming user ID.
4094                  @retVal = ($user, $function);                  @retVal = ($user, $function);
4095        } elsif ($type =~ m/^set (\S+) function to$/i) {
4096            # Here we have an assignment with a user that is passed back to the caller.
4097            @retVal = ($1, $function);
4098        }
4099        # If we have an assignment, we need to clean the function text. There may be
4100        # extra junk at the end added as a note from the user.
4101        if (defined( $retVal[1] )) {
4102            $retVal[1] =~ s/(\t\S)?\s*$//;
4103          }          }
4104          # Return the result list.          # Return the result list.
4105          return @retVal;          return @retVal;
4106  }  }
4107    
4108    =head3 _CheckFeature
4109    
4110        my $flag = $sprout->_CheckFeature($fid);
4111    
4112    Return TRUE if the specified FID is probably an NMPDR feature ID, else FALSE.
4113    
4114    =over 4
4115    
4116    =item fid
4117    
4118    Feature ID to check.
4119    
4120    =item RETURN
4121    
4122    Returns TRUE if the FID is for one of the NMPDR genomes, else FALSE.
4123    
4124    =back
4125    
4126    =cut
4127    
4128    sub _CheckFeature {
4129        # Get the parameters.
4130        my ($self, $fid) = @_;
4131        # Insure we have a genome hash.
4132        if (! defined $self->{genomeHash}) {
4133            my %genomeHash = map { $_ => 1 } $self->GetFlat(['Genome'], "", [], 'Genome(id)');
4134            $self->{genomeHash} = \%genomeHash;
4135        }
4136        # Get the feature's genome ID.
4137        my ($genomeID) = FIGRules::ParseFeatureID($fid);
4138        # Return an indicator of whether or not the genome ID is in the hash.
4139        return ($self->{genomeHash}->{$genomeID} ? 1 : 0);
4140    }
4141    
4142  =head3 FriendlyTimestamp  =head3 FriendlyTimestamp
4143    
4144  Convert a time number to a user-friendly time stamp for display.  Convert a time number to a user-friendly time stamp for display.
# Line 2611  Line 4161 
4161    
4162  sub FriendlyTimestamp {  sub FriendlyTimestamp {
4163      my ($timeValue) = @_;      my ($timeValue) = @_;
4164      my $retVal = strftime("%a %b %e %H:%M:%S %Y", localtime($timeValue));      my $retVal = localtime($timeValue);
4165        return $retVal;
4166    }
4167    
4168    
4169    =head3 Hint
4170    
4171        my $htmlText = SearchHelper::Hint($wikiPage, $hintText);
4172    
4173    Return the HTML for a small question mark that displays the specified hint text when it is clicked.
4174    This HTML can be put in forms to provide a useful hinting mechanism.
4175