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

Diff of /Sprout/ERDB.pm

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

revision 1.69, Fri Sep 29 15:06:17 2006 UTC revision 1.84, Wed Jan 24 10:22:22 2007 UTC
# Line 11  Line 11 
11      use Time::HiRes qw(gettimeofday);      use Time::HiRes qw(gettimeofday);
12      use Digest::MD5 qw(md5_base64);      use Digest::MD5 qw(md5_base64);
13      use FIG;      use FIG;
14        use CGI;
15    
16  =head1 Entity-Relationship Database Package  =head1 Entity-Relationship Database Package
17    
# Line 59  Line 60 
60  B<start-position>, which indicates where in the contig that the sequence begins. This attribute  B<start-position>, which indicates where in the contig that the sequence begins. This attribute
61  is implemented as the C<start_position> field in the C<IsMadeUpOf> relation.  is implemented as the C<start_position> field in the C<IsMadeUpOf> relation.
62    
63  The database itself is described by an XML file using the F<ERDatabase.xsd> schema. In addition to  The database itself is described by an XML file. In addition to all the data required to define
64  all the data required to define the entities, relationships, and attributes, the schema provides  the entities, relationships, and attributes, the schema provides space for notes describing
65  space for notes describing the data and what it means. These notes are used by L</ShowMetaData>  the data and what it means. These notes are used by L</ShowMetaData> to generate documentation
66  to generate documentation for the database.  for the database.
67    
68    Special support is provided for text searching. An entity field can be marked as <em>searchable</em>,
69    in which case it will be used to generate a text search index in which the user searches for words
70    in the field instead of a particular field value.
71    
72  Finally, every entity and relationship object has a flag indicating if it is new or old. The object  Finally, every entity and relationship object has a flag indicating if it is new or old. The object
73  is considered I<old> if it was loaded by the L</LoadTables> method. It is considered I<new> if it  is considered I<old> if it was loaded by the L</LoadTables> method. It is considered I<new> if it
74  was inserted by the L</InsertObject> method.  was inserted by the L</InsertObject> method.
75    
 To facilitate testing, the ERDB module supports automatic generation of test data. This process  
 is described in the L</GenerateEntity> and L</GenerateConnection> methods, though it is not yet  
 fully implemented.  
   
76  =head2 XML Database Description  =head2 XML Database Description
77    
78  =head3 Data Types  =head3 Data Types
# Line 190  Line 191 
191    
192  Name of the field. The field name should contain only letters, digits, and hyphens (C<->),  Name of the field. The field name should contain only letters, digits, and hyphens (C<->),
193  and the first character should be a letter. Most underlying databases are case-insensitive  and the first character should be a letter. Most underlying databases are case-insensitive
194  with the respect to field names, so a best practice is to use lower-case letters only.  with the respect to field names, so a best practice is to use lower-case letters only. Finally,
195    the name C<search-relevance> has special meaning for full-text searches and should not be
196    used as a field name.
197    
198  =item type  =item type
199    
# Line 209  Line 212 
212  entity, the fields without a relation attribute are said to belong to the  entity, the fields without a relation attribute are said to belong to the
213  I<primary relation>. This relation has the same name as the entity itself.  I<primary relation>. This relation has the same name as the entity itself.
214    
215    =item searchable
216    
217    If specified, then the field is a candidate for full-text searching. A single full-text
218    index will be created for each relation with at least one searchable field in it.
219    For best results, this option should only be used for string or text fields.
220    
221    =item special
222    
223    This attribute allows the subclass to assign special meaning for certain fields.
224    The interpretation is up to the subclass itself. Currently, only entity fields
225    can have this attribute.
226    
227  =back  =back
228    
229  =head3 Indexes  =head3 Indexes
230    
231  An entity can have multiple alternate indexes associated with it. The fields must  An entity can have multiple alternate indexes associated with it. The fields must
232  be from the primary relation. The alternate indexes assist in ordering results  all be from the same relation. The alternate indexes assist in ordering results
233  from a query. A relationship can have up to two indexes-- a I<to-index> and a  from a query. A relationship can have up to two indexes-- a I<to-index> and a
234  I<from-index>. These order the results when crossing the relationship. For  I<from-index>. These order the results when crossing the relationship. For
235  example, in the relationship C<HasContig> from C<Genome> to C<Contig>, the  example, in the relationship C<HasContig> from C<Genome> to C<Contig>, the
# Line 242  Line 257 
257    
258  =back  =back
259    
260  The B<Index>, B<FromIndex>, and B<ToIndex> tags themselves have no attributes.  The B<FromIndex>, and B<ToIndex> tags have no attributes. The B<Index> tag can
261    have a B<Unique> attribute. If specified, the index will be generated as a unique
262    index.
263    
264  =head3 Object and Field Names  =head3 Object and Field Names
265    
# Line 320  Line 337 
337    
338  # Table of information about our datatypes. "sqlType" is the corresponding SQL datatype string.  # Table of information about our datatypes. "sqlType" is the corresponding SQL datatype string.
339  # "maxLen" is the maximum permissible length of the incoming string data used to populate a field  # "maxLen" is the maximum permissible length of the incoming string data used to populate a field
340  # of the specified type. "dataGen" is PERL string that will be evaluated if no test data generation  # of the specified type. "avgLen" is the average byte length for estimating
341  # string is specified in the field definition. "avgLen" is the average byte length for estimating  # record sizes. "sort" is the key modifier for the sort command, "notes" is a type description,
342  # record sizes. "sort" is the key modifier for the sort command.  # and "indexMod", if non-zero, is the number of characters to use when the field is specified in an
343  my %TypeTable = ( char =>    { sqlType => 'CHAR(1)',            maxLen => 1,            avgLen =>   1, sort => "",  dataGen => "StringGen('A')" },  # index
344                    int =>     { sqlType => 'INTEGER',            maxLen => 20,           avgLen =>   4, sort => "n", dataGen => "IntGen(0, 99999999)" },  my %TypeTable = ( char =>    { sqlType => 'CHAR(1)',            maxLen => 1,            avgLen =>   1, sort => "",
345                    counter => { sqlType => 'INTEGER UNSIGNED',   maxLen => 20,           avgLen =>   4, sort => "n", dataGen => "IntGen(0, 99999999)" },                                 indexMod =>   0, notes => "single ASCII character"},
346                    string =>  { sqlType => 'VARCHAR(255)',       maxLen => 255,          avgLen => 100, sort => "",  dataGen => "StringGen(IntGen(10,250))" },                    int =>     { sqlType => 'INTEGER',            maxLen => 20,           avgLen =>   4, sort => "n",
347                    text =>    { sqlType => 'TEXT',               maxLen => 1000000000,   avgLen => 500, sort => "",  dataGen => "StringGen(IntGen(80,1000))" },                                 indexMod =>   0, notes => "signed 32-bit integer"},
348                    date =>    { sqlType => 'BIGINT',             maxLen => 80,           avgLen =>   8, sort => "n", dataGen => "DateGen(-7, 7, IntGen(0,1400))" },                    counter => { sqlType => 'INTEGER UNSIGNED',   maxLen => 20,           avgLen =>   4, sort => "n",
349                    float =>   { sqlType => 'DOUBLE PRECISION',   maxLen => 40,           avgLen =>   8, sort => "g", dataGen => "FloatGen(0.0, 100.0)" },                                 indexMod =>   0, notes => "unsigned 32-bit integer"},
350                    boolean => { sqlType => 'SMALLINT',           maxLen => 1,            avgLen =>   1, sort => "n", dataGen => "IntGen(0, 1)" },                    string =>  { sqlType => 'VARCHAR(255)',       maxLen => 255,          avgLen => 100, sort => "",
351                                   indexMod =>   0, notes => "character string, 0 to 255 characters"},
352                      text =>    { sqlType => 'TEXT',               maxLen => 1000000000,   avgLen => 500, sort => "",
353                                   indexMod => 255, notes => "character string, nearly unlimited length, only first 255 characters are indexed"},
354                      date =>    { sqlType => 'BIGINT',             maxLen => 80,           avgLen =>   8, sort => "n",
355                                   indexMod =>   0, notes => "signed, 64-bit integer"},
356                      float =>   { sqlType => 'DOUBLE PRECISION',   maxLen => 40,           avgLen =>   8, sort => "g",
357                                   indexMod =>   0, notes => "64-bit double precision floating-point number"},
358                      boolean => { sqlType => 'SMALLINT',           maxLen => 1,            avgLen =>   1, sort => "n",
359                                   indexMod =>   0, notes => "boolean value: 0 if false, 1 if true"},
360                   'hash-string' =>                   'hash-string' =>
361                               { sqlType => 'VARCHAR(22)',        maxLen => 22,           avgLen =>  22, sort => "",  dataGen => "SringGen(22)" },                               { sqlType => 'VARCHAR(22)',        maxLen => 22,           avgLen =>  22, sort => "",
362                                   indexMod =>   0, notes => "string stored in digested form, used for certain types of key fields"},
363                   'id-string' =>                   'id-string' =>
364                               { sqlType => 'VARCHAR(25)',        maxLen => 25,           avgLen =>  25, sort => "",  dataGen => "SringGen(22)" },                               { sqlType => 'VARCHAR(25)',        maxLen => 25,           avgLen =>  25, sort => "",
365                                   indexMod =>   0, notes => "character string, 0 to 25 characters"},
366                   'key-string' =>                   'key-string' =>
367                               { sqlType => 'VARCHAR(40)',        maxLen => 40,           avgLen =>  10, sort => "",  dataGen => "StringGen(IntGen(10,40))" },                               { sqlType => 'VARCHAR(40)',        maxLen => 40,           avgLen =>  10, sort => "",
368                                   indexMod =>   0, notes => "character string, 0 to 40 characters"},
369                   'name-string' =>                   'name-string' =>
370                               { sqlType => 'VARCHAR(80)',        maxLen => 80,           avgLen =>  40, sort => "",  dataGen => "StringGen(IntGen(10,80))" },                               { sqlType => 'VARCHAR(80)',        maxLen => 80,           avgLen =>  40, sort => "",
371                                   indexMod =>   0, notes => "character string, 0 to 80 characters"},
372                   'medium-string' =>                   'medium-string' =>
373                               { sqlType => 'VARCHAR(160)',       maxLen => 160,          avgLen =>  40, sort => "",  dataGen => "StringGen(IntGen(10,160))" },                               { sqlType => 'VARCHAR(160)',       maxLen => 160,          avgLen =>  40, sort => "",
374                                   indexMod =>   0, notes => "character string, 0 to 160 characters"},
375                  );                  );
376    
377  # Table translating arities into natural language.  # Table translating arities into natural language.
# Line 349  Line 380 
380                     'MM' => 'many-to-many'                     'MM' => 'many-to-many'
381                   );                   );
382    
383  # Table for interpreting string patterns.  # Options for XML input and output.
384    
385    my %XmlOptions = (GroupTags =>  { Relationships => 'Relationship',
386                                      Entities => 'Entity',
387                                      Fields => 'Field',
388                                      Indexes => 'Index',
389                                      IndexFields => 'IndexField'
390                                    },
391                      KeyAttr =>    { Relationship => 'name',
392                                      Entity => 'name',
393                                      Field => 'name'
394                                    },
395                      SuppressEmpty => 1,
396                     );
397    
398  my %PictureTable = ( 'A' => "abcdefghijklmnopqrstuvwxyz",  my %XmlInOpts  = (
399                       '9' => "0123456789",                    ForceArray => ['Field', 'Index', 'IndexField', 'Relationship', 'Entity'],
400                       'X' => "abcdefghijklmnopqrstuvwxyz0123456789",                    ForceContent => 1,
401                       'V' => "aeiou",                    NormalizeSpace => 2,
402                       'K' => "bcdfghjklmnoprstvwxyz"                   );
403    my %XmlOutOpts = (
404                      RootName => 'Database',
405                      XMLDecl => 1,
406                     );                     );
407    
408    
409  =head2 Public Methods  =head2 Public Methods
410    
411  =head3 new  =head3 new
# Line 498  Line 546 
546          my $entityData = $entityList->{$key};          my $entityData = $entityList->{$key};
547          # If there's descriptive text, display it.          # If there's descriptive text, display it.
548          if (my $notes = $entityData->{Notes}) {          if (my $notes = $entityData->{Notes}) {
549              $retVal .= "<p>" . _HTMLNote($notes->{content}) . "</p>\n";              $retVal .= "<p>" . HTMLNote($notes->{content}) . "</p>\n";
550          }          }
551          # Now we want a list of the entity's relationships. First, we set up the relationship subsection.          # See if we need a list of the entity's relationships.
552            my $relCount = keys %{$relationshipList};
553            if ($relCount > 0) {
554                # First, we set up the relationship subsection.
555          $retVal .= "<h4>Relationships for <b>$key</b></h4>\n<ul>\n";          $retVal .= "<h4>Relationships for <b>$key</b></h4>\n<ul>\n";
556          # Loop through the relationships.          # Loop through the relationships.
557          for my $relationship (sort keys %{$relationshipList}) {          for my $relationship (sort keys %{$relationshipList}) {
# Line 516  Line 567 
567          }          }
568          # Close off the relationship list.          # Close off the relationship list.
569          $retVal .= "</ul>\n";          $retVal .= "</ul>\n";
570            }
571          # Get the entity's relations.          # Get the entity's relations.
572          my $relationList = $entityData->{Relations};          my $relationList = $entityData->{Relations};
573          # Create a header for the relation subsection.          # Create a header for the relation subsection.
# Line 555  Line 607 
607          $retVal .= "</p>\n";          $retVal .= "</p>\n";
608          # If there are notes on this relationship, display them.          # If there are notes on this relationship, display them.
609          if (my $notes = $relationshipStructure->{Notes}) {          if (my $notes = $relationshipStructure->{Notes}) {
610              $retVal .= "<p>" . _HTMLNote($notes->{content}) . "</p>\n";              $retVal .= "<p>" . HTMLNote($notes->{content}) . "</p>\n";
611          }          }
612          # Generate the relationship's relation table.          # Generate the relationship's relation table.
613          my $htmlString = _ShowRelationTable($key, $relationshipStructure->{Relations}->{$key});          my $htmlString = _ShowRelationTable($key, $relationshipStructure->{Relations}->{$key});
# Line 602  Line 654 
654      return Data::Dumper::Dumper($self->{_metaData});      return Data::Dumper::Dumper($self->{_metaData});
655  }  }
656    
657    =head3 FindIndexForEntity
658    
659    C<< my $indexFound = ERDB::FindIndexForEntity($xml, $entityName, $attributeName); >>
660    
661    This method locates the entry in an entity's index list that begins with the
662    specified attribute name. If the entity has no index list, one will be
663    created. This method works on raw XML, not a live ERDB object.
664    
665    =over 4
666    
667    =item xml
668    
669    The raw XML structure defining the database.
670    
671    =item entityName
672    
673    The name of the relevant entity.
674    
675    =item attributeName
676    
677    The name of the attribute relevant to the search.
678    
679    =item RETURN
680    
681    The numerical index in the index list of the index entry for the specified entity and
682    attribute, or C<undef> if no such index exists.
683    
684    =back
685    
686    =cut
687    
688    sub FindIndexForEntity {
689        # Get the parameters.
690        my ($xml, $entityName, $attributeName) = @_;
691        # Declare the return variable.
692        my $retVal;
693        # Get the named entity.
694        my $entityData = $xml->{Entities}->{$entityName};
695        if (! $entityData) {
696            Confess("Entity $entityName not found in DBD structure.");
697        } else {
698            # Insure it has an index list.
699            if (! exists $entityData->{Indexes}) {
700                $entityData->{Indexes} = [];
701            } else {
702                # Search for the desired index.
703                my $indexList = $entityData->{Indexes};
704                my $n = scalar @{$indexList};
705                Trace("Searching $n indexes in index list for $entityName.") if T(2);
706                # We use an indexed FOR here because we're returning an
707                # index number instead of an object. We do THAT so we can
708                # delete the index from the list if needed.
709                for (my $i = 0; $i < $n && !defined($retVal); $i++) {
710                    my $index = $indexList->[$i];
711                    my $fields = $index->{IndexFields};
712                    # Technically this IF should be safe (that is, we are guaranteed
713                    # the existence of a "$fields->[0]"), because when we load the XML
714                    # we have SuppressEmpty specified.
715                    if ($fields->[0]->{name} eq $attributeName) {
716                        $retVal = $i;
717                    }
718                }
719            }
720        }
721        Trace("Index for $attributeName of $entityName found at position $retVal.") if defined($retVal) && T(3);
722        Trace("Index for $attributeName not found in $entityName.") if !defined($retVal) && T(3);
723        # Return the result.
724        return $retVal;
725    }
726    
727  =head3 CreateTables  =head3 CreateTables
728    
729  C<< $erdb->CreateTables(); >>  C<< $erdb->CreateTables(); >>
# Line 689  Line 811 
811      Trace("Creating table $relationName: $fieldThing") if T(2);      Trace("Creating table $relationName: $fieldThing") if T(2);
812      $dbh->create_table(tbl => $relationName, flds => $fieldThing, estimates => $estimation);      $dbh->create_table(tbl => $relationName, flds => $fieldThing, estimates => $estimation);
813      Trace("Relation $relationName created in database.") if T(2);      Trace("Relation $relationName created in database.") if T(2);
814      # If we want to build the indexes, we do it here.      # If we want to build the indexes, we do it here. Note that the full-text search
815        # index will not be built until the table has been loaded.
816      if ($indexFlag) {      if ($indexFlag) {
817          $self->CreateIndex($relationName);          $self->CreateIndex($relationName);
818      }      }
# Line 846  Line 969 
969      for my $indexName (keys %{$indexHash}) {      for my $indexName (keys %{$indexHash}) {
970          my $indexData = $indexHash->{$indexName};          my $indexData = $indexHash->{$indexName};
971          # Get the index's field list.          # Get the index's field list.
972          my @fieldList = _FixNames(@{$indexData->{IndexFields}});          my @rawFields = @{$indexData->{IndexFields}};
973            # Get a hash of the relation's field types.
974            my %types = map { $_->{name} => $_->{type} } @{$relationData->{Fields}};
975            # We need to check for text fields so we can append a length limitation for them. To do
976            # that, we need the relation's field list.
977            my $relFields = $relationData->{Fields};
978            for (my $i = 0; $i <= $#rawFields; $i++) {
979                # Get the field type.
980                my $field = $rawFields[$i];
981                my $type = $types{$field};
982                # Ask if it requires using prefix notation for the index.
983                my $mod = $TypeTable{$type}->{indexMod};
984                Trace("Field $field ($i) in $relationName has type $type and indexMod $mod.") if T(3);
985                if ($mod) {
986                    # Append the prefix length to the field name,
987                    $rawFields[$i] .= "($mod)";
988                }
989            }
990            my @fieldList = _FixNames(@rawFields);
991          my $flds = join(', ', @fieldList);          my $flds = join(', ', @fieldList);
992          # Get the index's uniqueness flag.          # Get the index's uniqueness flag.
993          my $unique = (exists $indexData->{Unique} ? $indexData->{Unique} : 'false');          my $unique = (exists $indexData->{Unique} ? 'unique' : undef);
994          # Create the index.          # Create the index.
995          my $rv = $dbh->create_index(idx => $indexName, tbl => $relationName,          my $rv = $dbh->create_index(idx => $indexName, tbl => $relationName,
996                                      flds => $flds, unique => $unique);                                      flds => $flds, kind => $unique);
997          if ($rv) {          if ($rv) {
998              Trace("Index created: $indexName for $relationName ($flds)") if T(1);              Trace("Index created: $indexName for $relationName ($flds)") if T(1);
999          } else {          } else {
# Line 861  Line 1002 
1002      }      }
1003  }  }
1004    
1005    =head3 GetSecondaryFields
1006    
1007    C<< my %fieldTuples = $erdb->GetSecondaryFields($entityName); >>
1008    
1009    This method will return a list of the name and type of each of the secondary
1010    fields for a specified entity. Secondary fields are stored in two-column tables
1011    in addition to the primary entity table. This enables the field to have no value
1012    or to have multiple values.
1013    
1014    =over 4
1015    
1016    =item entityName
1017    
1018    Name of the entity whose secondary fields are desired.
1019    
1020    =item RETURN
1021    
1022    Returns a hash mapping the field names to their field types.
1023    
1024    =back
1025    
1026    =cut
1027    
1028    sub GetSecondaryFields {
1029        # Get the parameters.
1030        my ($self, $entityName) = @_;
1031        # Declare the return variable.
1032        my %retVal = ();
1033        # Look for the entity.
1034        my $table = $self->GetFieldTable($entityName);
1035        # Loop through the fields, pulling out the secondaries.
1036        for my $field (sort keys %{$table}) {
1037            if ($table->{$field}->{relation} ne $entityName) {
1038                # Here we have a secondary field.
1039                $retVal{$field} = $table->{$field}->{type};
1040            }
1041        }
1042        # Return the result.
1043        return %retVal;
1044    }
1045    
1046    =head3 GetFieldRelationName
1047    
1048    C<< my $name = $erdb->GetFieldRelationName($objectName, $fieldName); >>
1049    
1050    Return the name of the relation containing a specified field.
1051    
1052    =over 4
1053    
1054    =item objectName
1055    
1056    Name of the entity or relationship containing the field.
1057    
1058    =item fieldName
1059    
1060    Name of the relevant field in that entity or relationship.
1061    
1062    =item RETURN
1063    
1064    Returns the name of the database relation containing the field, or C<undef> if
1065    the field does not exist.
1066    
1067    =back
1068    
1069    =cut
1070    
1071    sub GetFieldRelationName {
1072        # Get the parameters.
1073        my ($self, $objectName, $fieldName) = @_;
1074        # Declare the return variable.
1075        my $retVal;
1076        # Get the object field table.
1077        my $table = $self->GetFieldTable($objectName);
1078        # Only proceed if the field exists.
1079        if (exists $table->{$fieldName}) {
1080            # Determine the name of the relation that contains this field.
1081            $retVal = $table->{$fieldName}->{relation};
1082        }
1083        # Return the result.
1084        return $retVal;
1085    }
1086    
1087    =head3 DeleteValue
1088    
1089    C<< my $numDeleted = $erdb->DeleteValue($entityName, $id, $fieldName, $fieldValue); >>
1090    
1091    Delete secondary field values from the database. This method can be used to delete all
1092    values of a specified field for a particular entity instance, or only a single value.
1093    
1094    Secondary fields are stored in two-column relations separate from an entity's primary
1095    table, and as a result a secondary field can legitimately have no value or multiple
1096    values. Therefore, it makes sense to talk about deleting secondary fields where it
1097    would not make sense for primary fields.
1098    
1099    =over 4
1100    
1101    =item entityName
1102    
1103    Name of the entity from which the fields are to be deleted.
1104    
1105    =item id
1106    
1107    ID of the entity instance to be processed. If the instance is not found, this
1108    method will have no effect. If C<undef> is specified, all values for all of
1109    the entity instances will be deleted.
1110    
1111    =item fieldName
1112    
1113    Name of the field whose values are to be deleted.
1114    
1115    =item fieldValue (optional)
1116    
1117    Value to be deleted. If not specified, then all values of the specified field
1118    will be deleted for the entity instance. If specified, then only the values which
1119    match this parameter will be deleted.
1120    
1121    =item RETURN
1122    
1123    Returns the number of rows deleted.
1124    
1125    =back
1126    
1127    =cut
1128    
1129    sub DeleteValue {
1130        # Get the parameters.
1131        my ($self, $entityName, $id, $fieldName, $fieldValue) = @_;
1132        # Declare the return value.
1133        my $retVal = 0;
1134        # We need to set up an SQL command to do the deletion. First, we
1135        # find the name of the field's relation.
1136        my $table = $self->GetFieldTable($entityName);
1137        my $field = $table->{$fieldName};
1138        my $relation = $field->{relation};
1139        # Make sure this is a secondary field.
1140        if ($relation eq $entityName) {
1141            Confess("Cannot delete values of $fieldName for $entityName.");
1142        } else {
1143            # Set up the SQL command to delete all values.
1144            my $sql = "DELETE FROM $relation";
1145            # Build the filter.
1146            my @filters = ();
1147            my @parms = ();
1148            # Check for a filter by ID.
1149            if (defined $id) {
1150                push @filters, "id = ?";
1151                push @parms, $id;
1152            }
1153            # Check for a filter by value.
1154            if (defined $fieldValue) {
1155                push @filters, "$fieldName = ?";
1156                push @parms, $fieldValue;
1157            }
1158            # Append the filters to the command.
1159            if (@filters) {
1160                $sql .= " WHERE " . join(" AND ", @filters);
1161            }
1162            # Execute the command.
1163            my $dbh = $self->{_dbh};
1164            $retVal = $dbh->SQL($sql, 0, @parms);
1165        }
1166        # Return the result.
1167        return $retVal;
1168    }
1169    
1170  =head3 LoadTables  =head3 LoadTables
1171    
1172  C<< my $stats = $erdb->LoadTables($directoryName, $rebuild); >>  C<< my $stats = $erdb->LoadTables($directoryName, $rebuild); >>
# Line 955  Line 1261 
1261      return sort keys %{$entityList};      return sort keys %{$entityList};
1262  }  }
1263    
1264    =head3 GetDataTypes
1265    
1266    C<< my %types = ERDB::GetDataTypes(); >>
1267    
1268    Return a table of ERDB data types. The table returned is a hash of hashes.
1269    The keys of the big hash are the datatypes. Each smaller hash has several
1270    values used to manage the data. The most interesting is the SQL type (key
1271    C<sqlType>) and the descriptive node (key C<notes>).
1272    
1273    Note that changing the values in the smaller hashes will seriously break
1274    things, so this data should be treated as read-only.
1275    
1276    =cut
1277    
1278    sub GetDataTypes {
1279        return %TypeTable;
1280    }
1281    
1282    
1283  =head3 IsEntity  =head3 IsEntity
1284    
1285  C<< my $flag = $erdb->IsEntity($entityName); >>  C<< my $flag = $erdb->IsEntity($entityName); >>
# Line 1099  Line 1424 
1424      return $retVal;      return $retVal;
1425  }  }
1426    
1427    
1428    
1429    =head3 Search
1430    
1431    C<< my $query = $erdb->Search($searchExpression, $idx, \@objectNames, $filterClause, \@params); >>
1432    
1433    Perform a full text search with filtering. The search will be against a specified object
1434    in the object name list. That object will get an extra field containing the search
1435    relevance. Note that except for the search expression, the parameters of this method are
1436    the same as those for L</Get> and follow the same rules.
1437    
1438    =over 4
1439    
1440    =item searchExpression
1441    
1442    Boolean search expression for the text fields of the target object. The default mode for
1443    a Boolean search expression is OR, but we want the default to be AND, so we will
1444    add a C<+> operator to each word with no other operator before it.
1445    
1446    =item idx
1447    
1448    Index in the I<$objectNames> list of the table to be searched in full-text mode.
1449    
1450    =item objectNames
1451    
1452    List containing the names of the entity and relationship objects to be retrieved.
1453    
1454    =item filterClause
1455    
1456    WHERE clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can
1457    be parameterized with parameter markers (C<?>). Each field used in the WHERE clause must be
1458    specified in the standard form B<I<objectName>(I<fieldName>)>. Any parameters specified
1459    in the filter clause should be added to the parameter list as additional parameters. The
1460    fields in a filter clause can come from primary entity relations, relationship relations,
1461    or secondary entity relations; however, all of the entities and relationships involved must
1462    be included in the list of object names.
1463    
1464    =item params
1465    
1466    Reference to a list of parameter values to be substituted into the filter clause.
1467    
1468    =item RETURN
1469    
1470    Returns a query object for the specified search.
1471    
1472    =back
1473    
1474    =cut
1475    
1476    sub Search {
1477        # Get the parameters.
1478        my ($self, $searchExpression, $idx, $objectNames, $filterClause, $params) = @_;
1479        # Declare the return variable.
1480        my $retVal;
1481        # Create a safety copy of the parameter list. Note we have to be careful to insure
1482        # a parameter list exists before we copy it.
1483        my @myParams = ();
1484        if (defined $params) {
1485            @myParams = @{$params};
1486        }
1487        # Get the first object's structure so we have access to the searchable fields.
1488        my $object1Name = $objectNames->[$idx];
1489        my $object1Structure = $self->_GetStructure($object1Name);
1490        # Get the field list.
1491        if (! exists $object1Structure->{searchFields}) {
1492            Confess("No searchable index for $object1Name.");
1493        } else {
1494            # Get the field list.
1495            my @fields = @{$object1Structure->{searchFields}};
1496            # Clean the search expression.
1497            my $actualKeywords = $self->CleanKeywords($searchExpression);
1498            # Prefix a "+" to each uncontrolled word. This converts the default
1499            # search mode from OR to AND.
1500            $actualKeywords =~ s/(^|\s)(\w|")/$1\+$2/g;
1501            Trace("Actual keywords for search are\n$actualKeywords") if T(3);
1502            # We need two match expressions, one for the filter clause and one in the
1503            # query itself. Both will use a parameter mark, so we need to push the
1504            # search expression onto the front of the parameter list twice.
1505            unshift @myParams, $actualKeywords, $actualKeywords;
1506            # Build the match expression.
1507            my @matchFilterFields = map { "$object1Name." . _FixName($_) } @fields;
1508            my $matchClause = "MATCH (" . join(", ", @matchFilterFields) . ") AGAINST (? IN BOOLEAN MODE)";
1509            # Process the SQL stuff.
1510            my ($suffix, $mappedNameListRef, $mappedNameHashRef) =
1511                $self->_SetupSQL($objectNames, $filterClause, $matchClause);
1512            # Create the query. Note that the match clause is inserted at the front of
1513            # the select fields.
1514            my $command = "SELECT DISTINCT $matchClause, " . join(".*, ", @{$mappedNameListRef}) .
1515                ".* $suffix";
1516            my $sth = $self->_GetStatementHandle($command, \@myParams);
1517            # Now we create the relation map, which enables DBQuery to determine the order, name
1518            # and mapped name for each object in the query.
1519            my @relationMap = _RelationMap($mappedNameHashRef, $mappedNameListRef);
1520            # Return the statement object.
1521            $retVal = DBQuery::_new($self, $sth, \@relationMap, $object1Name);
1522        }
1523        return $retVal;
1524    }
1525    
1526  =head3 GetFlat  =head3 GetFlat
1527    
1528  C<< my @list = $erdb->GetFlat(\@objectNames, $filterClause, \@parameterList, $field); >>  C<< my @list = $erdb->GetFlat(\@objectNames, $filterClause, \@parameterList, $field); >>
# Line 1152  Line 1576 
1576      return @retVal;      return @retVal;
1577  }  }
1578    
1579    =head3 SpecialFields
1580    
1581    C<< my %specials = $erdb->SpecialFields($entityName); >>
1582    
1583    Return a hash mapping special fields in the specified entity to the value of their
1584    C<special> attribute. This enables the subclass to get access to the special field
1585    attributes without needed to plumb the internal ERDB data structures.
1586    
1587    =over 4
1588    
1589    =item entityName
1590    
1591    Name of the entity whose special fields are desired.
1592    
1593    =item RETURN
1594    
1595    Returns a hash. The keys of the hash are the special field names, and the values
1596    are the values from each special field's C<special> attribute.
1597    
1598    =back
1599    
1600    =cut
1601    
1602    sub SpecialFields {
1603        # Get the parameters.
1604        my ($self, $entityName) = @_;
1605        # Declare the return variable.
1606        my %retVal = ();
1607        # Find the entity's data structure.
1608        my $entityData = $self->{_metaData}->{Entities}->{$entityName};
1609        # Loop through its fields, adding each special field to the return hash.
1610        my $fieldHash = $entityData->{Fields};
1611        for my $fieldName (keys %{$fieldHash}) {
1612            my $fieldData = $fieldHash->{$fieldName};
1613            if (exists $fieldData->{special}) {
1614                $retVal{$fieldName} = $fieldData->{special};
1615            }
1616        }
1617        # Return the result.
1618        return %retVal;
1619    }
1620    
1621  =head3 Delete  =head3 Delete
1622    
1623  C<< my $stats = $erdb->Delete($entityName, $objectID); >>  C<< my $stats = $erdb->Delete($entityName, $objectID, %options); >>
1624    
1625  Delete an entity instance from the database. The instance is deleted along with all entity and  Delete an entity instance from the database. The instance is deleted along with all entity and
1626  relationship instances dependent on it. The idea of dependence here is recursive. An object is  relationship instances dependent on it. The definition of I<dependence> is recursive.
1627  always dependent on itself. An object is dependent if it is a 1-to-many or many-to-many  
1628  relationship connected to a dependent entity or the "to" entity connected to a 1-to-many  An object is always dependent on itself. An object is dependent if it is a 1-to-many or many-to-many
1629    relationship connected to a dependent entity or if it is the "to" entity connected to a 1-to-many
1630  dependent relationship.  dependent relationship.
1631    
1632  =over 4  =over 4
# Line 1173  Line 1640 
1640  ID of the entity instance to be deleted. If the ID contains a wild card character (C<%>),  ID of the entity instance to be deleted. If the ID contains a wild card character (C<%>),
1641  then it is presumed to by a LIKE pattern.  then it is presumed to by a LIKE pattern.
1642    
1643  =item testFlag  =item options
1644    
1645  If TRUE, the delete statements will be traced without being executed.  A hash detailing the options for this delete operation.
1646    
1647  =item RETURN  =item RETURN
1648    
# Line 1184  Line 1651 
1651    
1652  =back  =back
1653    
1654    The permissible options for this method are as follows.
1655    
1656    =over 4
1657    
1658    =item testMode
1659    
1660    If TRUE, then the delete statements will be traced, but no changes will be made to the database.
1661    
1662    =item keepRoot
1663    
1664    If TRUE, then the entity instances will not be deleted, only the dependent records.
1665    
1666    =back
1667    
1668  =cut  =cut
1669  #: Return Type $%;  #: Return Type $%;
1670  sub Delete {  sub Delete {
1671      # Get the parameters.      # Get the parameters.
1672      my ($self, $entityName, $objectID, $testFlag) = @_;      my ($self, $entityName, $objectID, %options) = @_;
1673      # Declare the return variable.      # Declare the return variable.
1674      my $retVal = Stats->new();      my $retVal = Stats->new();
1675      # Get the DBKernel object.      # Get the DBKernel object.
# Line 1205  Line 1686 
1686      # FROM-relationships and entities.      # FROM-relationships and entities.
1687      my @fromPathList = ();      my @fromPathList = ();
1688      my @toPathList = ();      my @toPathList = ();
1689      # This final hash is used to remember what work still needs to be done. We push paths      # This final list is used to remember what work still needs to be done. We push paths
1690      # onto the list, then pop them off to extend the paths. We prime it with the starting      # onto the list, then pop them off to extend the paths. We prime it with the starting
1691      # point. Note that we will work hard to insure that the last item on a path in the      # point. Note that we will work hard to insure that the last item on a path in the
1692      # TODO list is always an entity.      # to-do list is always an entity.
1693      my @todoList = ([$entityName]);      my @todoList = ([$entityName]);
1694      while (@todoList) {      while (@todoList) {
1695          # Get the current path.          # Get the current path.
# Line 1216  Line 1697 
1697          # Copy it into a list.          # Copy it into a list.
1698          my @stackedPath = @{$current};          my @stackedPath = @{$current};
1699          # Pull off the last item on the path. It will always be an entity.          # Pull off the last item on the path. It will always be an entity.
1700          my $entityName = pop @stackedPath;          my $myEntityName = pop @stackedPath;
1701          # Add it to the alreadyFound list.          # Add it to the alreadyFound list.
1702          $alreadyFound{$entityName} = 1;          $alreadyFound{$myEntityName} = 1;
1703            # Figure out if we need to delete this entity.
1704            if ($myEntityName ne $entityName || ! $options{keepRoot}) {
1705          # Get the entity data.          # Get the entity data.
1706          my $entityData = $self->_GetStructure($entityName);              my $entityData = $self->_GetStructure($myEntityName);
1707          # The first task is to loop through the entity's relation. A DELETE command will              # Loop through the entity's relations. A DELETE command will be needed for each of them.
         # be needed for each of them.  
1708          my $relations = $entityData->{Relations};          my $relations = $entityData->{Relations};
1709          for my $relation (keys %{$relations}) {          for my $relation (keys %{$relations}) {
1710              my @augmentedList = (@stackedPath, $relation);              my @augmentedList = (@stackedPath, $relation);
1711              push @fromPathList, \@augmentedList;              push @fromPathList, \@augmentedList;
1712          }          }
1713            }
1714          # Now we need to look for relationships connected to this entity.          # Now we need to look for relationships connected to this entity.
1715          my $relationshipList = $self->{_metaData}->{Relationships};          my $relationshipList = $self->{_metaData}->{Relationships};
1716          for my $relationshipName (keys %{$relationshipList}) {          for my $relationshipName (keys %{$relationshipList}) {
1717              my $relationship = $relationshipList->{$relationshipName};              my $relationship = $relationshipList->{$relationshipName};
1718              # Check the FROM field. We're only interested if it's us.              # Check the FROM field. We're only interested if it's us.
1719              if ($relationship->{from} eq $entityName) {              if ($relationship->{from} eq $myEntityName) {
1720                  # Add the path to this relationship.                  # Add the path to this relationship.
1721                  my @augmentedList = (@stackedPath, $entityName, $relationshipName);                  my @augmentedList = (@stackedPath, $myEntityName, $relationshipName);
1722                  push @fromPathList, \@augmentedList;                  push @fromPathList, \@augmentedList;
1723                  # Check the arity. If it's MM we're done. If it's 1M                  # Check the arity. If it's MM we're done. If it's 1M
1724                  # and the target hasn't been seen yet, we want to                  # and the target hasn't been seen yet, we want to
# Line 1254  Line 1737 
1737              }              }
1738              # Now check the TO field. In this case only the relationship needs              # Now check the TO field. In this case only the relationship needs
1739              # deletion.              # deletion.
1740              if ($relationship->{to} eq $entityName) {              if ($relationship->{to} eq $myEntityName) {
1741                  my @augmentedList = (@stackedPath, $entityName, $relationshipName);                  my @augmentedList = (@stackedPath, $myEntityName, $relationshipName);
1742                  push @toPathList, \@augmentedList;                  push @toPathList, \@augmentedList;
1743              }              }
1744          }          }
1745      }      }
1746      # Create the first qualifier for the WHERE clause. This selects the      # Create the first qualifier for the WHERE clause. This selects the
1747      # keys of the primary entity records to be deleted. When we're deleting      # keys of the primary entity records to be deleted. When we're deleting
1748      # from a dependent table, we construct a join page from the first qualifier      # from a dependent table, we construct a join path from the first qualifier
1749      # to the table containing the dependent records to delete.      # to the table containing the dependent records to delete.
1750      my $qualifier = ($objectID =~ /%/ ? "LIKE ?" : "= ?");      my $qualifier = ($objectID =~ /%/ ? "LIKE ?" : "= ?");
1751      # We need to make two passes. The first is through the to-list, and      # We need to make two passes. The first is through the to-list, and
# Line 1301  Line 1784 
1784                  }                  }
1785              }              }
1786              # Now we have our desired DELETE statement.              # Now we have our desired DELETE statement.
1787              if ($testFlag) {              if ($options{testMode}) {
1788                  # Here the user wants to trace without executing.                  # Here the user wants to trace without executing.
1789                  Trace($stmt) if T(0);                  Trace($stmt) if T(0);
1790              } else {              } else {
1791                  # Here we can delete. Note that the SQL method dies with a confessing                  # Here we can delete. Note that the SQL method dies with a confession
1792                  # if an error occurs, so we just go ahead and do it.                  # if an error occurs, so we just go ahead and do it.
1793                  Trace("Executing delete from $target using '$objectID'.") if T(3);                  Trace("Executing delete from $target using '$objectID'.") if T(3);
1794                  my $rv = $db->SQL($stmt, 0, $objectID);                  my $rv = $db->SQL($stmt, 0, $objectID);
# Line 1320  Line 1803 
1803      return $retVal;      return $retVal;
1804  }  }
1805    
1806  =head3 GetList  =head3 Disconnect
   
 C<< my @dbObjects = $erdb->GetList(\@objectNames, $filterClause, \@params); >>  
1807    
1808  Return a list of object descriptors for the specified objects as determined by the  C<< $erdb->Disconnect($relationshipName, $originEntityName, $originEntityID); >>
 specified filter clause.  
1809    
1810  This method is essentially the same as L</Get> except it returns a list of objects rather  Disconnect an entity instance from all the objects to which it is related. This
1811  than a query object that can be used to get the results one record at a time.  will delete each relationship instance that connects to the specified entity.
1812    
1813  =over 4  =over 4
1814    
1815  =item objectNames  =item relationshipName
1816    
1817  List containing the names of the entity and relationship objects to be retrieved.  Name of the relationship whose instances are to be deleted.
1818    
1819  =item filterClause  =item originEntityName
1820    
1821  WHERE clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can  Name of the entity that is to be disconnected.
 be parameterized with parameter markers (C<?>). Each field used in the WHERE clause 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.  
1822    
1823  The filter clause can also specify a sort order. To do this, simply follow the filter string  =item originEntityID
 with an ORDER BY clause. For example, the following filter string gets all genomes for a  
 particular genus and sorts them by species name.  
1824    
1825  C<< "Genome(genus) = ? ORDER BY Genome(species)" >>  ID of the entity that is to be disconnected.
1826    
1827  The rules for field references in a sort order are the same as those for field references in the  =back
1828    
1829    =cut
1830    
1831    sub Disconnect {
1832        # Get the parameters.
1833        my ($self, $relationshipName, $originEntityName, $originEntityID) = @_;
1834        # Get the relationship descriptor.
1835        my $structure = $self->_GetStructure($relationshipName);
1836        # Insure we have a relationship.
1837        if (! exists $structure->{from}) {
1838            Confess("$relationshipName is not a relationship in the database.");
1839        } else {
1840            # Get the database handle.
1841            my $dbh = $self->{_dbh};
1842            # We'll set this value to 1 if we find our entity.
1843            my $found = 0;
1844            # Loop through the ends of the relationship.
1845            for my $dir ('from', 'to') {
1846                if ($structure->{$dir} eq $originEntityName) {
1847                    # Delete all relationship instances on this side of the entity instance.
1848                    Trace("Disconnecting in $dir direction with ID \"$originEntityID\".");
1849                    $dbh->SQL("DELETE FROM $relationshipName WHERE ${dir}_link = ?", 0, $originEntityID);
1850                    $found = 1;
1851                }
1852            }
1853            # Insure we found the entity on at least one end.
1854            if (! $found) {
1855                Confess("Entity \"$originEntityName\" does not use $relationshipName.");
1856            }
1857        }
1858    }
1859    
1860    =head3 DeleteRow
1861    
1862    C<< $erdb->DeleteRow($relationshipName, $fromLink, $toLink, \%values); >>
1863    
1864    Delete a row from a relationship. In most cases, only the from-link and to-link are
1865    needed; however, for relationships with intersection data values can be specified
1866    for the other fields using a hash.
1867    
1868    =over 4
1869    
1870    =item relationshipName
1871    
1872    Name of the relationship from which the row is to be deleted.
1873    
1874    =item fromLink
1875    
1876    ID of the entity instance in the From direction.
1877    
1878    =item toLink
1879    
1880    ID of the entity instance in the To direction.
1881    
1882    =item values
1883    
1884    Reference to a hash of other values to be used for filtering the delete.
1885    
1886    =back
1887    
1888    =cut
1889    
1890    sub DeleteRow {
1891        # Get the parameters.
1892        my ($self, $relationshipName, $fromLink, $toLink, $values) = @_;
1893        # Create a hash of all the filter information.
1894        my %filter = ('from-link' => $fromLink, 'to-link' => $toLink);
1895        if (defined $values) {
1896            for my $key (keys %{$values}) {
1897                $filter{$key} = $values->{$key};
1898            }
1899        }
1900        # Build an SQL statement out of the hash.
1901        my @filters = ();
1902        my @parms = ();
1903        for my $key (keys %filter) {
1904            push @filters, _FixName($key) . " = ?";
1905            push @parms, $filter{$key};
1906        }
1907        Trace("Parms for delete row are " . join(", ", map { "\"$_\"" } @parms) . ".") if T(SQL => 4);
1908        my $command = "DELETE FROM $relationshipName WHERE " .
1909                      join(" AND ", @filters);
1910        # Execute it.
1911        my $dbh = $self->{_dbh};
1912        $dbh->SQL($command, undef, @parms);
1913    }
1914    
1915    =head3 SortNeeded
1916    
1917    C<< my $parms = $erdb->SortNeeded($relationName); >>
1918    
1919    Return the pipe command for the sort that should be applied to the specified
1920    relation when creating the load file.
1921    
1922    For example, if the load file should be sorted ascending by the first
1923    field, this method would return
1924    
1925        sort -k1 -t"\t"
1926    
1927    If the first field is numeric, the method would return
1928    
1929        sort -k1n -t"\t"
1930    
1931    Unfortunately, due to a bug in the C<sort> command, we cannot eliminate duplicate
1932    keys using a sort.
1933    
1934    =over 4
1935    
1936    =item relationName
1937    
1938    Name of the relation to be examined.
1939    
1940    =item
1941    
1942    Returns the sort command to use for sorting the relation, suitable for piping.
1943    
1944    =back
1945    
1946    =cut
1947    #: Return Type $;
1948    sub SortNeeded {
1949        # Get the parameters.
1950        my ($self, $relationName) = @_;
1951        # Declare a descriptor to hold the names of the key fields.
1952        my @keyNames = ();
1953        # Get the relation structure.
1954        my $relationData = $self->_FindRelation($relationName);
1955        # Find out if the relation is a primary entity relation,
1956        # a relationship relation, or a secondary entity relation.
1957        my $entityTable = $self->{_metaData}->{Entities};
1958        my $relationshipTable = $self->{_metaData}->{Relationships};
1959        if (exists $entityTable->{$relationName}) {
1960            # Here we have a primary entity relation.
1961            push @keyNames, "id";
1962        } elsif (exists $relationshipTable->{$relationName}) {
1963            # Here we have a relationship. We sort using the FROM index.
1964            my $relationshipData = $relationshipTable->{$relationName};
1965            my $index = $relationData->{Indexes}->{idxFrom};
1966            push @keyNames, @{$index->{IndexFields}};
1967        } else {
1968            # Here we have a secondary entity relation, so we have a sort on the ID field.
1969            push @keyNames, "id";
1970        }
1971        # Now we parse the key names into sort parameters. First, we prime the return
1972        # string.
1973        my $retVal = "sort -t\"\t\" ";
1974        # Get the relation's field list.
1975        my @fields = @{$relationData->{Fields}};
1976        # Loop through the keys.
1977        for my $keyData (@keyNames) {
1978            # Get the key and the ordering.
1979            my ($keyName, $ordering);
1980            if ($keyData =~ /^([^ ]+) DESC/) {
1981                ($keyName, $ordering) = ($1, "descending");
1982            } else {
1983                ($keyName, $ordering) = ($keyData, "ascending");
1984            }
1985            # Find the key's position and type.
1986            my $fieldSpec;
1987            for (my $i = 0; $i <= $#fields && ! $fieldSpec; $i++) {
1988                my $thisField = $fields[$i];
1989                if ($thisField->{name} eq $keyName) {
1990                    # Get the sort modifier for this field type. The modifier
1991                    # decides whether we're using a character, numeric, or
1992                    # floating-point sort.
1993                    my $modifier = $TypeTable{$thisField->{type}}->{sort};
1994                    # If the index is descending for this field, denote we want
1995                    # to reverse the sort order on this field.
1996                    if ($ordering eq 'descending') {
1997                        $modifier .= "r";
1998                    }
1999                    # Store the position and modifier into the field spec, which
2000                    # will stop the inner loop. Note that the field number is
2001                    # 1-based in the sort command, so we have to increment the
2002                    # index.
2003                    $fieldSpec = ($i + 1) . $modifier;
2004                }
2005            }
2006            # Add this field to the sort command.
2007            $retVal .= " -k$fieldSpec";
2008        }
2009        # Return the result.
2010        return $retVal;
2011    }
2012    
2013    =head3 GetList
2014    
2015    C<< my @dbObjects = $erdb->GetList(\@objectNames, $filterClause, \@params); >>
2016    
2017    Return a list of object descriptors for the specified objects as determined by the
2018    specified filter clause.
2019    
2020    This method is essentially the same as L</Get> except it returns a list of objects rather
2021    than a query object that can be used to get the results one record at a time.
2022    
2023    =over 4
2024    
2025    =item objectNames
2026    
2027    List containing the names of the entity and relationship objects to be retrieved.
2028    
2029    =item filterClause
2030    
2031    WHERE clause (without the WHERE) to be used to filter and sort the query. The WHERE clause can
2032    be parameterized with parameter markers (C<?>). Each field used in the WHERE clause must be
2033    specified in the standard form B<I<objectName>(I<fieldName>)>. Any parameters specified
2034    in the filter clause should be added to the parameter list as additional parameters. The
2035    fields in a filter clause can come from primary entity relations, relationship relations,
2036    or secondary entity relations; however, all of the entities and relationships involved must
2037    be included in the list of object names.
2038    
2039    The filter clause can also specify a sort order. To do this, simply follow the filter string
2040    with an ORDER BY clause. For example, the following filter string gets all genomes for a
2041    particular genus and sorts them by species name.
2042    
2043    C<< "Genome(genus) = ? ORDER BY Genome(species)" >>
2044    
2045    The rules for field references in a sort order are the same as those for field references in the
2046  filter clause in general; however, odd things may happen if a sort field is from a secondary  filter clause in general; however, odd things may happen if a sort field is from a secondary
2047  relation.  relation.
2048    
# Line 1618  Line 2308 
2308    
2309  =head3 InsertObject  =head3 InsertObject
2310    
2311  C<< my $ok = $erdb->InsertObject($objectType, \%fieldHash); >>  C<< $erdb->InsertObject($objectType, \%fieldHash); >>
2312    
2313  Insert an object into the database. The object is defined by a type name and then a hash  Insert an object into the database. The object is defined by a type name and then a hash
2314  of field names to values. Field values in the primary relation are represented by scalars.  of field names to values. Field values in the primary relation are represented by scalars.
# Line 1644  Line 2334 
2334    
2335  Hash of field names to values.  Hash of field names to values.
2336    
 =item RETURN  
   
 Returns 1 if successful, 0 if an error occurred.  
   
2337  =back  =back
2338    
2339  =cut  =cut
# Line 1746  Line 2432 
2432                  $retVal = $sth->execute(@parameterList);                  $retVal = $sth->execute(@parameterList);
2433                  if (!$retVal) {                  if (!$retVal) {
2434                      my $errorString = $sth->errstr();                      my $errorString = $sth->errstr();
2435                      Trace("Insert error: $errorString.") if T(0);                      Confess("Error inserting into $relationName: $errorString");
2436                  }                  }
2437              }              }
2438          }          }
2439      }      }
2440      # Return the success indicator.      # Return a 1 for backward compatability.
2441      return $retVal;      return 1;
2442    }
2443    
2444    =head3 UpdateEntity
2445    
2446    C<< $erdb->UpdateEntity($entityName, $id, \%fields); >>
2447    
2448    Update the values of an entity. This is an unprotected update, so it should only be
2449    done if the database resides on a database server.
2450    
2451    =over 4
2452    
2453    =item entityName
2454    
2455    Name of the entity to update. (This is the entity type.)
2456    
2457    =item id
2458    
2459    ID of the entity to update. If no entity exists with this ID, an error will be thrown.
2460    
2461    =item fields
2462    
2463    Reference to a hash mapping field names to their new values. All of the fields named
2464    must be in the entity's primary relation, and they cannot any of them be the ID field.
2465    
2466    =back
2467    
2468    =cut
2469    
2470    sub UpdateEntity {
2471        # Get the parameters.
2472        my ($self, $entityName, $id, $fields) = @_;
2473        # Get a list of the field names being updated.
2474        my @fieldList = keys %{$fields};
2475        # Verify that the fields exist.
2476        my $checker = $self->GetFieldTable($entityName);
2477        for my $field (@fieldList) {
2478            if ($field eq 'id') {
2479                Confess("Cannot update the ID field for entity $entityName.");
2480            } elsif ($checker->{$field}->{relation} ne $entityName) {
2481                Confess("Cannot find $field in primary relation of $entityName.");
2482            }
2483        }
2484        # Build the SQL statement.
2485        my @sets = ();
2486        my @valueList = ();
2487        for my $field (@fieldList) {
2488            push @sets, _FixName($field) . " = ?";
2489            push @valueList, $fields->{$field};
2490        }
2491        my $command = "UPDATE $entityName SET " . join(", ", @sets) . " WHERE id = ?";
2492        # Add the ID to the list of binding values.
2493        push @valueList, $id;
2494        # Call SQL to do the work.
2495        my $rows = $self->{_dbh}->SQL($command, 0, @valueList);
2496        # Check for errors.
2497        if ($rows == 0) {
2498            Confess("Entity $id of type $entityName not found.");
2499        }
2500  }  }
2501    
2502  =head3 LoadTable  =head3 LoadTable
2503    
2504  C<< my %results = $erdb->LoadTable($fileName, $relationName, $truncateFlag); >>  C<< my $results = $erdb->LoadTable($fileName, $relationName, $truncateFlag); >>
2505    
2506  Load data from a tab-delimited file into a specified table, optionally re-creating the table  Load data from a tab-delimited file into a specified table, optionally re-creating the table
2507  first.  first.
# Line 1824  Line 2568 
2568      };      };
2569      if (!defined $rv) {      if (!defined $rv) {
2570          $retVal->AddMessage($@) if ($@);          $retVal->AddMessage($@) if ($@);
2571          $retVal->AddMessage("Table load failed for $relationName using $fileName.");          $retVal->AddMessage("Table load failed for $relationName using $fileName: " . $dbh->error_message);
2572          Trace("Table load failed for $relationName.") if T(1);          Trace("Table load failed for $relationName.") if T(1);
2573      } else {      } else {
2574          # Here we successfully loaded the table.          # Here we successfully loaded the table.
# Line 1832  Line 2576 
2576          my $size = -s $fileName;          my $size = -s $fileName;
2577          Trace("$size bytes loaded into $relationName.") if T(2);          Trace("$size bytes loaded into $relationName.") if T(2);
2578          # If we're rebuilding, we need to create the table indexes.          # If we're rebuilding, we need to create the table indexes.
2579          if ($truncateFlag && ! $dbh->{_preIndex}) {          if ($truncateFlag) {
2580                # Indexes are created here for PostGres. For PostGres, indexes are
2581                # best built at the end. For MySQL, the reverse is true.
2582                if (! $dbh->{_preIndex}) {
2583              eval {              eval {
2584                  $self->CreateIndex($relationName);                  $self->CreateIndex($relationName);
2585              };              };
# Line 1840  Line 2587 
2587                  $retVal->AddMessage($@);                  $retVal->AddMessage($@);
2588              }              }
2589          }          }
2590                # The full-text index (if any) is always built last, even for MySQL.
2591                # First we need to see if this table has a full-text index. Only
2592                # primary relations are allowed that privilege.
2593                Trace("Checking for full-text index on $relationName.") if T(2);
2594                if ($self->_IsPrimary($relationName)) {
2595                    $self->CreateSearchIndex($relationName);
2596                }
2597            }
2598      }      }
2599      # Analyze the table to improve performance.      # Analyze the table to improve performance.
2600      Trace("Analyzing and compacting $relationName.") if T(3);      Trace("Analyzing and compacting $relationName.") if T(3);
# Line 1849  Line 2604 
2604      return $retVal;      return $retVal;
2605  }  }
2606    
2607  =head3 GenerateEntity  =head3 CreateSearchIndex
2608    
2609  C<< my $fieldHash = $erdb->GenerateEntity($id, $type, \%values); >>  C<< $erdb->CreateSearchIndex($objectName); >>
2610    
2611  Generate the data for a new entity instance. This method creates a field hash suitable for  Check for a full-text search index on the specified entity or relationship object, and
2612  passing as a parameter to L</InsertObject>. The ID is specified by the callr, but the rest  if one is required, rebuild it.
 of the fields are generated using information in the database schema.  
   
 Each data type has a default algorithm for generating random test data. This can be overridden  
 by including a B<DataGen> element in the field. If this happens, the content of the element is  
 executed as a PERL program in the context of this module. The element may make use of a C<$this>  
 variable which contains the field hash as it has been built up to the current point. If any  
 fields are dependent on other fields, the C<pass> attribute can be used to control the order  
 in which the fields are generated. A field with a high data pass number will be generated after  
 a field with a lower one. If any external values are needed, they should be passed in via the  
 optional third parameter, which will be available to the data generation script under the name  
 C<$value>. Several useful utility methods are provided for generating random values, including  
 L</IntGen>, L</StringGen>, L</FloatGen>, and L</DateGen>. Note that dates are stored and generated  
 in the form of a timestamp number rather than a string.  
2613    
2614  =over 4  =over 4
2615    
2616  =item id  =item objectName
2617    
2618  ID to assign to the new entity.  Name of the entity or relationship to be indexed.
2619    
2620  =item type  =back
2621    
2622  Type name for the new entity.  =cut
2623    
2624  =item values  sub CreateSearchIndex {
2625        # Get the parameters.
2626        my ($self, $objectName) = @_;
2627        # Get the relation's entity/relationship structure.
2628        my $structure = $self->_GetStructure($objectName);
2629        # Get the database handle.
2630        my $dbh = $self->{_dbh};
2631        Trace("Checking for search fields in $objectName.") if T(3);
2632        # Check for a searchable fields list.
2633        if (exists $structure->{searchFields}) {
2634            # Here we know that we need to create a full-text search index.
2635            # Get an SQL-formatted field name list.
2636            my $fields = join(", ", _FixNames(@{$structure->{searchFields}}));
2637            # Create the index. If it already exists, it will be dropped.
2638            $dbh->create_index(tbl => $objectName, idx => "search_idx",
2639                               flds => $fields, kind => 'fulltext');
2640            Trace("Index created for $fields in $objectName.") if T(2);
2641        }
2642    }
2643    
2644    =head3 DropRelation
2645    
2646    C<< $erdb->DropRelation($relationName); >>
2647    
2648    Physically drop a relation from the database.
2649    
2650    =over 4
2651    
2652    =item relationName
2653    
2654  Hash containing additional values that might be needed by the data generation methods (optional).  Name of the relation to drop. If it does not exist, this method will have
2655    no effect.
2656    
2657  =back  =back
2658    
2659  =cut  =cut
2660    
2661  sub GenerateEntity {  sub DropRelation {
2662      # Get the parameters.      # Get the parameters.
2663      my ($self, $id, $type, $values) = @_;      my ($self, $relationName) = @_;
2664      # Create the return hash.      # Get the database handle.
2665      my $this = { id => $id };      my $dbh = $self->{_dbh};
2666      # Get the metadata structure.      # Drop the relation. The method used here has no effect if the relation
2667      my $metadata = $self->{_metaData};      # does not exist.
2668      # Get this entity's list of fields.      Trace("Invoking DB Kernel to drop $relationName.") if T(3);
2669      if (!exists $metadata->{Entities}->{$type}) {      $dbh->drop_table(tbl => $relationName);
2670          Confess("Unrecognized entity type $type in GenerateEntity.");  }
2671    
2672    =head3 MatchSqlPattern
2673    
2674    C<< my $matched = ERDB::MatchSqlPattern($value, $pattern); >>
2675    
2676    Determine whether or not a specified value matches an SQL pattern. An SQL
2677    pattern has two wild card characters: C<%> that matches multiple characters,
2678    and C<_> that matches a single character. These can be escaped using a
2679    backslash (C<\>). We pull this off by converting the SQL pattern to a
2680    PERL regular expression. As per SQL rules, the match is case-insensitive.
2681    
2682    =over 4
2683    
2684    =item value
2685    
2686    Value to be matched against the pattern. Note that an undefined or empty
2687    value will not match anything.
2688    
2689    =item pattern
2690    
2691    SQL pattern against which to match the value. An undefined or empty pattern will
2692    match everything.
2693    
2694    =item RETURN
2695    
2696    Returns TRUE if the value and pattern match, else FALSE.
2697    
2698    =back
2699    
2700    =cut
2701    
2702    sub MatchSqlPattern {
2703        # Get the parameters.
2704        my ($value, $pattern) = @_;
2705        # Declare the return variable.
2706        my $retVal;
2707        # Insure we have a pattern.
2708        if (! defined($pattern) || $pattern eq "") {
2709            $retVal = 1;
2710      } else {      } else {
2711          my $entity = $metadata->{Entities}->{$type};          # Break the pattern into pieces around the wildcard characters. Because we
2712          my $fields = $entity->{Fields};          # use parentheses in the split function's delimiter expression, we'll get
2713          # Generate data from the fields.          # list elements for the delimiters as well as the rest of the string.
2714          _GenerateFields($this, $fields, $type, $values);          my @pieces = split /([_%]|\\[_%])/, $pattern;
2715            # Check some fast special cases.
2716            if ($pattern eq '%') {
2717                # A null pattern matches everything.
2718                $retVal = 1;
2719            } elsif (@pieces == 1) {
2720                # No wildcards, so we have a literal comparison. Note we're case-insensitive.
2721                $retVal = (lc($value) eq lc($pattern));
2722            } elsif (@pieces == 2 && $pieces[1] eq '%') {
2723                # A wildcard at the end, so we have a substring match. This is also case-insensitive.
2724                $retVal = (lc(substr($value, 0, length($pieces[0]))) eq lc($pieces[0]));
2725            } else {
2726                # Okay, we have to do it the hard way. Convert each piece to a PERL pattern.
2727                my $realPattern = "";
2728                for my $piece (@pieces) {
2729                    # Determine the type of piece.
2730                    if ($piece eq "") {
2731                        # Empty pieces are ignored.
2732                    } elsif ($piece eq "%") {
2733                        # Here we have a multi-character wildcard. Note that it can match
2734                        # zero or more characters.
2735                        $realPattern .= ".*"
2736                    } elsif ($piece eq "_") {
2737                        # Here we have a single-character wildcard.
2738                        $realPattern .= ".";
2739                    } elsif ($piece eq "\\%" || $piece eq "\\_") {
2740                        # This is an escape sequence (which is a rare thing, actually).
2741                        $realPattern .= substr($piece, 1, 1);
2742                    } else {
2743                        # Here we have raw text.
2744                        $realPattern .= quotemeta($piece);
2745                    }
2746      }      }
2747      # Return the hash created.              # Do the match.
2748      return $this;              $retVal = ($value =~ /^$realPattern$/i ? 1 : 0);
2749            }
2750        }
2751        # Return the result.
2752        return $retVal;
2753  }  }
2754    
2755  =head3 GetEntity  =head3 GetEntity
# Line 2060  Line 2905 
2905  spreadsheet cell, and each feature will be represented by a list containing the  spreadsheet cell, and each feature will be represented by a list containing the
2906  feature ID followed by all of its aliases.  feature ID followed by all of its aliases.
2907    
2908  C<< $query = $erdb->Get(['ContainsFeature', 'Feature'], "ContainsFeature(from-link) = ?", [$ssCellID], ['Feature(id)', 'Feature(alias)']); >>  C<< @query = $erdb->Get(['ContainsFeature', 'Feature'], "ContainsFeature(from-link) = ?", [$ssCellID], ['Feature(id)', 'Feature(alias)']); >>
2909    
2910  =over 4  =over 4
2911    
# Line 2209  Line 3054 
3054      return $retVal;      return $retVal;
3055  }  }
3056    
3057  =head3 GetFieldTable  =head3 GetFieldTable
3058    
3059    C<< my $fieldHash = $self->GetFieldTable($objectnName); >>
3060    
3061    Get the field structure for a specified entity or relationship.
3062    
3063    =over 4
3064    
3065    =item objectName
3066    
3067    Name of the desired entity or relationship.
3068    
3069    =item RETURN
3070    
3071    The table containing the field descriptors for the specified object.
3072    
3073    =back
3074    
3075    =cut
3076    
3077    sub GetFieldTable {
3078        # Get the parameters.
3079        my ($self, $objectName) = @_;
3080        # Get the descriptor from the metadata.
3081        my $objectData = $self->_GetStructure($objectName);
3082        # Return the object's field table.
3083        return $objectData->{Fields};
3084    }
3085    
3086    =head3 SplitKeywords
3087    
3088    C<< my @keywords = ERDB::SplitKeywords($keywordString); >>
3089    
3090    This method returns a list of the positive keywords in the specified
3091    keyword string. All of the operators will have been stripped off,
3092    and if the keyword is preceded by a minus operator (C<->), it will
3093    not be in the list returned. The idea here is to get a list of the
3094    keywords the user wants to see. The list will be processed to remove
3095    duplicates.
3096    
3097    It is possible to create a string that confuses this method. For example
3098    
3099        frog toad -frog
3100    
3101    would return both C<frog> and C<toad>. If this is a problem we can deal
3102    with it later.
3103    
3104    =over 4
3105    
3106    =item keywordString
3107    
3108    The keyword string to be parsed.
3109    
3110    =item RETURN
3111    
3112    Returns a list of the words in the keyword string the user wants to
3113    see.
3114    
3115    =back
3116    
3117    =cut
3118    
3119    sub SplitKeywords {
3120        # Get the parameters.
3121        my ($keywordString) = @_;
3122        # Make a safety copy of the string. (This helps during debugging.)
3123        my $workString = $keywordString;
3124        # Convert operators we don't care about to spaces.
3125        $workString =~ tr/+"()<>/ /;
3126        # Split the rest of the string along space boundaries. Note that we
3127        # eliminate any words that are zero length or begin with a minus sign.
3128        my @wordList = grep { $_ && substr($_, 0, 1) ne "-" } split /\s+/, $workString;
3129        # Use a hash to remove duplicates.
3130        my %words = map { $_ => 1 } @wordList;
3131        # Return the result.
3132        return sort keys %words;
3133    }
3134    
3135    =head3 ValidateFieldName
3136    
3137    C<< my $okFlag = ERDB::ValidateFieldName($fieldName); >>
3138    
3139    Return TRUE if the specified field name is valid, else FALSE. Valid field names must
3140    be hyphenated words subject to certain restrictions.
3141    
3142    =over 4
3143    
3144    =item fieldName
3145    
3146    Field name to be validated.
3147    
3148    =item RETURN
3149    
3150    Returns TRUE if the field name is valid, else FALSE.
3151    
3152    =back
3153    
3154    =cut
3155    
3156    sub ValidateFieldName {
3157        # Get the parameters.
3158        my ($fieldName) = @_;
3159        # Declare the return variable. The field name is valid until we hear
3160        # differently.
3161        my $retVal = 1;
3162        # Compute the maximum name length.
3163        my $maxLen = $TypeTable{'name-string'}->{maxLen};
3164        # Look for bad stuff in the name.
3165        if ($fieldName =~ /--/) {
3166            # Here we have a doubled minus sign.
3167            Trace("Field name $fieldName has a doubled hyphen.") if T(1);
3168            $retVal = 0;
3169        } elsif ($fieldName !~ /^[A-Za-z]/) {
3170            # Here the field name is missing the initial letter.
3171            Trace("Field name $fieldName does not begin with a letter.") if T(1);
3172            $retVal = 0;
3173        } elsif (length($fieldName) > $maxLen) {
3174            # Here the field name is too long.
3175            Trace("Maximum field name length is $maxLen. Field name must be truncated to " . substr($fieldName,0, $maxLen) . ".");
3176        } else {
3177            # Strip out the minus signs. Everything remaining must be a letter,
3178            # underscore, or digit.
3179            my $strippedName = $fieldName;
3180            $strippedName =~ s/-//g;
3181            if ($strippedName !~ /^(\w|\d)+$/) {
3182                Trace("Field name $fieldName contains illegal characters.") if T(1);
3183                $retVal = 0;
3184            }
3185        }
3186        # Return the result.
3187        return $retVal;
3188    }
3189    
3190    =head3 ReadMetaXML
3191    
3192    C<< my $rawMetaData = ERDB::ReadDBD($fileName); >>
3193    
3194    This method reads a raw database definition XML file and returns it.
3195    Normally, the metadata used by the ERDB system has been processed and
3196    modified to make it easier to load and retrieve the data; however,
3197    this method can be used to get the data in its raw form.
3198    
3199    =over 4
3200    
3201    =item fileName
3202    
3203    Name of the XML file to read.
3204    
3205    =item RETURN
3206    
3207    Returns a hash reference containing the raw XML data from the specified file.
3208    
3209    =back
3210    
3211    =cut
3212    
3213    sub ReadMetaXML {
3214        # Get the parameters.
3215        my ($fileName) = @_;
3216        # Read the XML.
3217        my $retVal = XML::Simple::XMLin($fileName, %XmlOptions, %XmlInOpts);
3218        Trace("XML metadata loaded from file $fileName.") if T(1);
3219        # Return the result.
3220        return $retVal;
3221    }
3222    
3223    =head3 GetEntityFieldHash
3224    
3225    C<< my $fieldHashRef = ERDB::GetEntityFieldHash($structure, $entityName); >>
3226    
3227    Get the field hash of the named entity in the specified raw XML structure.
3228    The field hash may not exist, in which case we need to create it.
3229    
3230    =over 4
3231    
3232    =item structure
3233    
3234    Raw XML structure defininng the database. This is not the run-time XML used by
3235    an ERDB object, since that has all sorts of optimizations built-in.
3236    
3237    =item entityName
3238    
3239    Name of the entity whose field structure is desired.
3240    
3241    =item RETURN
3242    
3243    Returns the field hash used to define the entity's fields.
3244    
3245    =back
3246    
3247    =cut
3248    
3249    sub GetEntityFieldHash {
3250        # Get the parameters.
3251        my ($structure, $entityName) = @_;
3252        # Get the entity structure.
3253        my $entityData = $structure->{Entities}->{$entityName};
3254        # Look for a field structure.
3255        my $retVal = $entityData->{Fields};
3256        # If it doesn't exist, create it.
3257        if (! defined($retVal)) {
3258            $entityData->{Fields} = {};
3259            $retVal = $entityData->{Fields};
3260        }
3261        # Return the result.
3262        return $retVal;
3263    }
3264    
3265    =head3 WriteMetaXML
3266    
3267    C<< ERDB::WriteMetaXML($structure, $fileName); >>
3268    
3269    Write the metadata XML to a file. This method is the reverse of L</ReadMetaXML>, and is
3270    used to update the database definition. It must be used with care, however, since it
3271    will only work on a raw structure, not on the processed structure created by an ERDB
3272    constructor.
3273    
3274    =over 4
3275    
3276    =item structure
3277    
3278    XML structure to be written to the file.
3279    
3280    =item fileName
3281    
3282    Name of the output file to which the updated XML should be stored.
3283    
3284    =back
3285    
3286    =cut
3287    
3288    sub WriteMetaXML {
3289        # Get the parameters.
3290        my ($structure, $fileName) = @_;
3291        # Compute the output.
3292        my $fileString = XML::Simple::XMLout($structure, %XmlOptions, %XmlOutOpts);
3293        # Write it to the file.
3294        my $xmlOut = Open(undef, ">$fileName");
3295        print $xmlOut $fileString;
3296    }
3297    
3298    
3299  C<< my $fieldHash = $self->GetFieldTable($objectnName); >>  =head3 HTMLNote
3300    
3301  Get the field structure for a specified entity or relationship.  Convert a note or comment to HTML by replacing some bulletin-board codes with HTML. The codes
3302    supported are C<[b]> for B<bold>, C<[i]> for I<italics>, and C<[p]> for a new paragraph.
3303    Except for C<[p]>, all the codes are closed by slash-codes. So, for
3304    example, C<[b]Feature[/b]> displays the string C<Feature> in boldface.
3305    
3306    C<< my $realHtml = ERDB::HTMLNote($dataString); >>
3307    
3308  =over 4  =over 4
3309    
3310  =item objectName  =item dataString
3311    
3312  Name of the desired entity or relationship.  String to convert to HTML.
3313    
3314  =item RETURN  =item RETURN
3315    
3316  The table containing the field descriptors for the specified object.  An HTML string derived from the input string.
3317    
3318  =back  =back
3319    
3320  =cut  =cut
3321    
3322  sub GetFieldTable {  sub HTMLNote {
3323      # Get the parameters.      # Get the parameter.
3324      my ($self, $objectName) = @_;      my ($dataString) = @_;
3325      # Get the descriptor from the metadata.      # HTML-escape the text.
3326      my $objectData = $self->_GetStructure($objectName);      my $retVal = CGI::escapeHTML($dataString);
3327      # Return the object's field table.      # Substitute the bulletin board codes.
3328      return $objectData->{Fields};      $retVal =~ s!\[(/?[bi])\]!<$1>!g;
3329        $retVal =~ s!\[p\]!</p><p>!g;
3330        $retVal =~ s!\[link\s+([^\]]+)\]!<a href="$1">!g;
3331        $retVal =~ s!\[/link\]!</a>!g;
3332        # Return the result.
3333        return $retVal;
3334  }  }
3335    
3336    
3337  =head2 Data Mining Methods  =head2 Data Mining Methods
3338    
3339  =head3 GetUsefulCrossValues  =head3 GetUsefulCrossValues
# Line 2391  Line 3487 
3487      return @retVal;      return @retVal;
3488  }  }
3489    
3490    =head2 Virtual Methods
3491    
3492    =head3 CleanKeywords
3493    
3494    C<< my $cleanedString = $erdb->CleanKeywords($searchExpression); >>
3495    
3496    Clean up a search expression or keyword list. This is a virtual method that may
3497    be overridden by the subclass. The base-class method removes extra spaces
3498    and converts everything to lower case.
3499    
3500    =over 4
3501    
3502    =item searchExpression
3503    
3504    Search expression or keyword list to clean. Note that a search expression may
3505    contain boolean operators which need to be preserved. This includes leading
3506    minus signs.
3507    
3508    =item RETURN
3509    
3510    Cleaned expression or keyword list.
3511    
3512    =back
3513    
3514    =cut
3515    
3516    sub CleanKeywords {
3517        # Get the parameters.
3518        my ($self, $searchExpression) = @_;
3519        # Lower-case the expression and copy it into the return variable. Note that we insure we
3520        # don't accidentally end up with an undefined value.
3521        my $retVal = lc($searchExpression || "");
3522        # Remove extra spaces.
3523        $retVal =~ s/\s+/ /g;
3524        $retVal =~ s/(^\s+)|(\s+$)//g;
3525        # Return the result.
3526        return $retVal;
3527    }
3528    
3529    =head3 GetSourceObject
3530    
3531    C<< my $source = $erdb->GetSourceObject($entityName); >>
3532    
3533    Return the object to be used in loading special attributes of the specified entity. The
3534    algorithm for loading special attributes is stored in the C<DataGen> elements of the
3535    XML
3536    
3537  =head2 Internal Utility Methods  =head2 Internal Utility Methods
3538    
3539  =head3 SetupSQL  =head3 _RelationMap
3540    
3541    C<< my @relationMap = _RelationMap($mappedNameHashRef, $mappedNameListRef); >>
3542    
3543    Create the relation map for an SQL query. The relation map is used by B<DBObject>
3544    to determine how to interpret the results of the query.
3545    
3546    =over 4
3547    
3548    =item mappedNameHashRef
3549    
3550    Reference to a hash that maps modified object names to real object names.
3551    
3552    =item mappedNameListRef
3553    
3554    Reference to a list of modified object names in the order they appear in the
3555    SELECT list.
3556    
3557    =item RETURN
3558    
3559    Returns a list of 2-tuples. Each tuple consists of an object name as used in the
3560    query followed by the actual name of that object. This enables the B<DBObject> to
3561    determine the order of the tables in the query and which object name belongs to each
3562    mapped object name. Most of the time these two values are the same; however, if a
3563    relation occurs twice in the query, the relation name in the field list and WHERE
3564    clause will use a mapped name (generally the actual relation name with a numeric
3565    suffix) that does not match the actual relation name.
3566    
3567    =back
3568    
3569    =cut
3570    
3571    sub _RelationMap {
3572        # Get the parameters.
3573        my ($mappedNameHashRef, $mappedNameListRef) = @_;
3574        # Declare the return variable.
3575        my @retVal = ();
3576        # Build the map.
3577        for my $mappedName (@{$mappedNameListRef}) {
3578            push @retVal, [$mappedName, $mappedNameHashRef->{$mappedName}];
3579        }
3580        # Return it.
3581        return @retVal;
3582    }
3583    
3584    
3585    =head3 _SetupSQL
3586    
3587  Process a list of object names and a filter clause so that they can be used to  Process a list of object names and a filter clause so that they can be used to
3588  build an SQL statement. This method takes in a reference to a list of object names  build an SQL statement. This method takes in a reference to a list of object names
# Line 2413  Line 3602 
3602  A string containing the WHERE clause for the query (without the C<WHERE>) and also  A string containing the WHERE clause for the query (without the C<WHERE>) and also
3603  optionally the C<ORDER BY> and C<LIMIT> clauses.  optionally the C<ORDER BY> and C<LIMIT> clauses.
3604    
3605    =item matchClause
3606    
3607    An optional full-text search clause. If specified, it will be inserted at the
3608    front of the WHERE clause. It should already be SQL-formatted; that is, the
3609    field names should be in the form I<table>C<.>I<fieldName>.
3610    
3611  =item RETURN  =item RETURN
3612    
3613  Returns a three-element list. The first element is the SQL statement suffix, beginning  Returns a three-element list. The first element is the SQL statement suffix, beginning
# Line 2425  Line 3620 
3620  =cut  =cut
3621    
3622  sub _SetupSQL {  sub _SetupSQL {
3623      my ($self, $objectNames, $filterClause) = @_;      my ($self, $objectNames, $filterClause, $matchClause) = @_;
3624      # Adjust the list of object names to account for multiple occurrences of the      # Adjust the list of object names to account for multiple occurrences of the
3625      # same object. We start with a hash table keyed on object name that will      # same object. We start with a hash table keyed on object name that will
3626      # return the object suffix. The first time an object is encountered it will      # return the object suffix. The first time an object is encountered it will
# Line 2474  Line 3669 
3669      # FROM name1, name2, ... nameN      # FROM name1, name2, ... nameN
3670      #      #
3671      my $suffix = "FROM " . join(', ', @fromList);      my $suffix = "FROM " . join(', ', @fromList);
3672        # Now for the WHERE. First, we need a place for the filter string.
3673        my $filterString = "";
3674        # We will also keep a list of conditions to add to the WHERE clause in order to link
3675        # entities and relationships as well as primary relations to secondary ones.
3676        my @joinWhere = ();
3677      # Check for a filter clause.      # Check for a filter clause.
3678      if ($filterClause) {      if ($filterClause) {
3679          # Here we have one, so we convert its field names and add it to the query. First,          # Here we have one, so we convert its field names and add it to the query. First,
3680          # We create a copy of the filter string we can work with.          # We create a copy of the filter string we can work with.
3681          my $filterString = $filterClause;          $filterString = $filterClause;
3682          # Next, we sort the object names by length. This helps protect us from finding          # Next, we sort the object names by length. This helps protect us from finding
3683          # object names inside other object names when we're doing our search and replace.          # object names inside other object names when we're doing our search and replace.
3684          my @sortedNames = sort { length($b) - length($a) } @mappedNameList;          my @sortedNames = sort { length($b) - length($a) } @mappedNameList;
         # We will also keep a list of conditions to add to the WHERE clause in order to link  
         # entities and relationships as well as primary relations to secondary ones.  
         my @joinWhere = ();  
3685          # The final preparatory step is to create a hash table of relation names. The          # The final preparatory step is to create a hash table of relation names. The
3686          # table begins with the relation names already in the SELECT command. We may          # table begins with the relation names already in the SELECT command. We may
3687          # need to add relations later if there is filtering on a field in a secondary          # need to add relations later if there is filtering on a field in a secondary
# Line 2552  Line 3749 
3749                  }                  }
3750              }              }
3751          }          }
3752        }
3753          # The next step is to join the objects together. We only need to do this if there          # The next step is to join the objects together. We only need to do this if there
3754          # is more than one object in the object list. We start with the first object and          # is more than one object in the object list. We start with the first object and
3755          # run through the objects after it. Note also that we make a safety copy of the          # run through the objects after it. Note also that we make a safety copy of the
3756          # list before running through it.      # list before running through it, because we shift off the first object before
3757        # processing the rest.
3758          my @mappedObjectList = @mappedNameList;          my @mappedObjectList = @mappedNameList;
3759          my $lastMappedObject = shift @mappedObjectList;          my $lastMappedObject = shift @mappedObjectList;
3760          # Get the join table.          # Get the join table.
# Line 2584  Line 3783 
3783          # here is we want the filter clause to be empty if there's no WHERE filter.          # here is we want the filter clause to be empty if there's no WHERE filter.
3784          # We'll put the ORDER BY / LIMIT clauses in the following variable.          # We'll put the ORDER BY / LIMIT clauses in the following variable.
3785          my $orderClause = "";          my $orderClause = "";
3786        # This is only necessary if we have a filter string in which the ORDER BY
3787        # and LIMIT clauses can live.
3788        if ($filterString) {
3789          # Locate the ORDER BY or LIMIT verbs (if any). We use a non-greedy          # Locate the ORDER BY or LIMIT verbs (if any). We use a non-greedy
3790          # operator so that we find the first occurrence of either verb.          # operator so that we find the first occurrence of either verb.
3791          if ($filterString =~ m/^(.*?)\s*(ORDER BY|LIMIT)/g) {          if ($filterString =~ m/^(.*?)\s*(ORDER BY|LIMIT)/g) {
# Line 2592  Line 3794 
3794              $orderClause = $2 . substr($filterString, $pos);              $orderClause = $2 . substr($filterString, $pos);
3795              $filterString = $1;              $filterString = $1;
3796          }          }
3797          # Add the filter and the join clauses (if any) to the SELECT command.      }
3798        # All the things that are supposed to be in the WHERE clause of the
3799        # SELECT command need to be put into @joinWhere so we can string them
3800        # together. We begin with the match clause. This is important,
3801        # because the match clause's parameter mark must precede any parameter
3802        # marks in the filter string.
3803        if ($matchClause) {
3804            push @joinWhere, $matchClause;
3805        }
3806        # Add the filter string. We put it in parentheses to avoid operator
3807        # precedence problems with the match clause or the joins.
3808          if ($filterString) {          if ($filterString) {
3809              Trace("Filter string is \"$filterString\".") if T(4);              Trace("Filter string is \"$filterString\".") if T(4);
3810              push @joinWhere, "($filterString)";              push @joinWhere, "($filterString)";
3811          }          }
3812        # String it all together into a big filter clause.
3813          if (@joinWhere) {          if (@joinWhere) {
3814              $suffix .= " WHERE " . join(' AND ', @joinWhere);              $suffix .= " WHERE " . join(' AND ', @joinWhere);
3815          }          }
3816          # Add the sort or limit clause (if any) to the SELECT command.      # Add the sort or limit clause (if any).
3817          if ($orderClause) {          if ($orderClause) {
3818              $suffix .= " $orderClause";              $suffix .= " $orderClause";
3819          }          }
     }  
3820      # Return the suffix, the mapped name list, and the mapped name hash.      # Return the suffix, the mapped name list, and the mapped name hash.
3821      return ($suffix, \@mappedNameList, \%mappedNameHash);      return ($suffix, \@mappedNameList, \%mappedNameHash);
3822  }  }
3823    
3824  =head3 GetStatementHandle  =head3 _GetStatementHandle
3825    
3826  This method will prepare and execute an SQL query, returning the statement handle.  This method will prepare and execute an SQL query, returning the statement handle.
3827  The main reason for doing this here is so that everybody who does SQL queries gets  The main reason for doing this here is so that everybody who does SQL queries gets
# Line 2647  Line 3859 
3859      # Prepare the command.      # Prepare the command.
3860      my $sth = $dbh->prepare_command($command);      my $sth = $dbh->prepare_command($command);
3861      # Execute it with the parameters bound in.      # Execute it with the parameters bound in.
3862      $sth->execute(@{$params}) || Confess("SELECT error" . $sth->errstr());      $sth->execute(@{$params}) || Confess("SELECT error:  " . $sth->errstr());
3863      # Return the statement handle.      # Return the statement handle.
3864      return $sth;      return $sth;
3865  }  }
3866    
3867  =head3 GetLoadStats  =head3 _GetLoadStats
3868    
3869  Return a blank statistics object for use by the load methods.  Return a blank statistics object for use by the load methods.
3870    
# Line 2664  Line 3876 
3876      return Stats->new();      return Stats->new();
3877  }  }
3878    
3879  =head3 GenerateFields  =head3 _DumpRelation
   
 Generate field values from a field structure and store in a specified table. The field names  
 are first sorted by pass count, certain pre-defined fields are removed from the list, and  
 then we rip through them evaluation the data generation string. Fields in the primary relation  
 are stored as scalars; fields in secondary relations are stored as value lists.  
   
 This is a static method.  
   
 =over 4  
   
 =item this  
   
 Hash table into which the field values should be placed.  
   
 =item fields  
   
 Field structure from which the field descriptors should be taken.  
   
 =item type  
   
 Type name of the object whose fields are being generated.  
   
 =item values (optional)  
   
 Reference to a value structure from which additional values can be taken.  
   
 =item from (optiona)  
   
 Reference to the source entity instance if relationship data is being generated.  
   
 =item to (optional)  
   
 Reference to the target entity instance if relationship data is being generated.  
   
 =back  
   
 =cut  
   
 sub _GenerateFields {  
     # Get the parameters.  
     my ($this, $fields, $type, $values, $from, $to) = @_;  
     # Sort the field names by pass number.  
     my @fieldNames = sort { $fields->{$a}->{DataGen}->{pass} <=> $fields->{$b}->{DataGen}->{pass} } keys %{$fields};  
     # Loop through the field names, generating data.  
     for my $name (@fieldNames) {  
         # Only proceed if this field needs to be generated.  
         if (!exists $this->{$name}) {  
             # Get this field's data generation descriptor.  
             my $fieldDescriptor = $fields->{$name};  
             my $data = $fieldDescriptor->{DataGen};  
             # Get the code to generate the field value.  
             my $codeString = $data->{content};  
             # Determine whether or not this field is in the primary relation.  
             if ($fieldDescriptor->{relation} eq $type) {  
                 # Here we have a primary relation field. Store the field value as  
                 # a scalar.  
                 $this->{$name} = eval($codeString);  
             } else {  
                 # Here we have a secondary relation field. Create a null list  
                 # and push the desired number of field values onto it.  
                 my @fieldValues = ();  
                 my $count = IntGen(0,$data->{testCount});  
                 for (my $i = 0; $i < $count; $i++) {  
                     my $newValue = eval($codeString);  
                     push @fieldValues, $newValue;  
                 }  
                 # Store the value list in the main hash.  
                 $this->{$name} = \@fieldValues;  
             }  
         }  
     }  
 }  
   
 =head3 DumpRelation  
3880    
3881  Dump the specified relation's to the specified output file in tab-delimited format.  Dump the specified relation to the specified output file in tab-delimited format.
3882    
3883  This is an instance method.  This is an instance method.
3884    
# Line 2788  Line 3926 
3926      close DTXOUT;      close DTXOUT;
3927  }  }
3928    
3929  =head3 GetStructure  =head3 _GetStructure
3930    
3931  Get the data structure for a specified entity or relationship.  Get the data structure for a specified entity or relationship.
3932    
# Line 2827  Line 3965 
3965      return $retVal;      return $retVal;
3966  }  }
3967    
3968  =head3 GetRelationTable  
3969    
3970    =head3 _GetRelationTable
3971    
3972  Get the list of relations for a specified entity or relationship.  Get the list of relations for a specified entity or relationship.
3973    
# Line 2856  Line 3996 
3996      return $objectData->{Relations};      return $objectData->{Relations};
3997  }  }
3998    
3999  =head3 ValidateFieldNames  =head3 _ValidateFieldNames
4000    
4001  Determine whether or not the field names are valid. A description of the problems with the names  Determine whether or not the field names are valid. A description of the problems with the names
4002  will be written to the standard error output. If there is an error, this method will abort. This is  will be written to the standard error output. If there is an error, this method will abort. This is
# Line 2883  Line 4023 
4023          for my $object (values %{$metadata->{$section}}) {          for my $object (values %{$metadata->{$section}}) {
4024              # Loop through the object's fields.              # Loop through the object's fields.
4025              for my $fieldName (keys %{$object->{Fields}}) {              for my $fieldName (keys %{$object->{Fields}}) {
4026                  # Now we make some initial validations.                  # If this field name is invalid, set the return value to zero
4027                  if ($fieldName =~ /--/) {                  # so we know we encountered an error.
4028                      # Here we have a doubled minus sign.                  if (! ValidateFieldName($fieldName)) {
                     print STDERR "Field name $fieldName has a doubled hyphen.\n";  
4029                      $retVal = 0;                      $retVal = 0;
                 } elsif ($fieldName !~ /^[A-Za-z]/) {  
                     # Here the field name is missing the initial letter.  
                     print STDERR "Field name $fieldName does not begin with a letter.\n";  
                     $retVal = 0;  
                 } else {  
                     # Strip out the minus signs. Everything remaining must be a letter  
                     # or digit.  
                     my $strippedName = $fieldName;  
                     $strippedName =~ s/-//g;  
                     if ($strippedName !~ /^[A-Za-z0-9]+$/) {  
                         print STDERR "Field name $fieldName contains illegal characters.\n";  
                         $retVal = 0;  
                     }  
4030                  }                  }
4031              }              }
4032          }          }
# Line 2911  Line 4037 
4037      }      }
4038  }  }
4039    
4040  =head3 LoadRelation  =head3 _LoadRelation
4041    
4042  Load a relation from the data in a tab-delimited disk file. The load will only take place if a disk  Load a relation from the data in a tab-delimited disk file. The load will only take place if a disk
4043  file with the same name as the relation exists in the specified directory.  file with the same name as the relation exists in the specified directory.
# Line 2971  Line 4097 
4097      return $retVal;      return $retVal;
4098  }  }
4099    
4100  =head3 LoadMetaData  
4101    =head3 _LoadMetaData
4102    
4103  This method loads the data describing this database from an XML file into a metadata structure.  This method loads the data describing this database from an XML file into a metadata structure.
4104  The resulting structure is a set of nested hash tables containing all the information needed to  The resulting structure is a set of nested hash tables containing all the information needed to
# Line 2996  Line 4123 
4123  sub _LoadMetaData {  sub _LoadMetaData {
4124      # Get the parameters.      # Get the parameters.
4125      my ($filename) = @_;      my ($filename) = @_;
4126      Trace("Reading Sprout DBD from $filename.") if T(2);      Trace("Reading DBD from $filename.") if T(2);
4127      # Slurp the XML file into a variable. Extensive use of options is used to insure we      # Slurp the XML file into a variable. Extensive use of options is used to insure we
4128      # get the exact structure we want.      # get the exact structure we want.
4129      my $metadata = XML::Simple::XMLin($filename,      my $metadata = ReadMetaXML($filename);
                                       GroupTags => { Relationships => 'Relationship',  
                                                      Entities => 'Entity',  
                                                      Fields => 'Field',  
                                                      Indexes => 'Index',  
                                                      IndexFields => 'IndexField'},  
                                       KeyAttr => { Relationship => 'name',  
                                                    Entity => 'name',  
                                                    Field => 'name'},  
                                       ForceArray => ['Field', 'Index', 'IndexField'],  
                                       ForceContent => 1,  
                                       NormalizeSpace => 2  
                                       );  
     Trace("XML metadata loaded from file $filename.") if T(1);  
4130      # Before we go any farther, we need to validate the field and object names. If an error is found,      # Before we go any farther, we need to validate the field and object names. If an error is found,
4131      # the method below will fail.      # the method below will fail.
4132      _ValidateFieldNames($metadata);      _ValidateFieldNames($metadata);
# Line 3142  Line 4256 
4256              my $count = 0;              my $count = 0;
4257              for my $index (@{$indexList}) {              for my $index (@{$indexList}) {
4258                  # Add this index to the index table.                  # Add this index to the index table.
4259                  _AddIndex("idx$relationName$count", $relation, $index);                  _AddIndex("idx$count", $relation, $index);
4260                  # Increment the counter so that the next index has a different name.                  # Increment the counter so that the next index has a different name.
4261                  $count++;                  $count++;
4262              }              }
# Line 3159  Line 4273 
4273          _FixupFields($relationshipStructure, $relationshipName, 2, 3);          _FixupFields($relationshipStructure, $relationshipName, 2, 3);
4274          # Format a description for the FROM field.          # Format a description for the FROM field.
4275          my $fromEntity = $relationshipStructure->{from};          my $fromEntity = $relationshipStructure->{from};
4276          my $fromComment = "<b>id</b> of the source <b><a href=\"#$fromEntity\">$fromEntity</a></b>.";          my $fromComment = "[b]id[/b] of the source [b][link #$fromEntity]$fromEntity\[/link][/b].";
4277          # Get the FROM entity's key type.          # Get the FROM entity's key type.
4278          my $fromType = $entityList->{$fromEntity}->{keyType};          my $fromType = $entityList->{$fromEntity}->{keyType};
4279          # Add the FROM field.          # Add the FROM field.
# Line 3169  Line 4283 
4283                                                      PrettySort => 1});                                                      PrettySort => 1});
4284          # Format a description for the TO field.          # Format a description for the TO field.
4285          my $toEntity = $relationshipStructure->{to};          my $toEntity = $relationshipStructure->{to};
4286          my $toComment = "<b>id</b> of the target <b><a href=\"#$toEntity\">$toEntity</a></b>.";          my $toComment = "[b]id[/b] of the target [b][link #$toEntity]$toEntity\[/link][/b].";
4287          # Get the TO entity's key type.          # Get the TO entity's key type.
4288          my $toType = $entityList->{$toEntity}->{keyType};          my $toType = $entityList->{$toEntity}->{keyType};
4289          # Add the TO field.          # Add the TO field.
# Line 3264  Line 4378 
4378                          }                          }
4379                      }                      }
4380                  }                  }
4381                  # Create joins between this relationship and the recursive relationships.                  # Create joins between this relationship and the recursive relationships.
4382                  # We don't need to check for ambiguous joins here, because a recursive                  # We don't need to check for ambiguous joins here, because a recursive
4383                  # relationship can only be ambiguous with another recursive relationship,                  # relationship can only be ambiguous with another recursive relationship,
4384                  # and the incoming relationship from the outer loop is never recursive.                  # and the incoming relationship from the outer loop is never recursive.
4385                  for my $otherName (@bothList) {                  for my $otherName (@bothList) {
4386                      Trace("Setting up relationship joins to recursive relationship $otherName with $relationshipName.") if T(metadata => 4);                      Trace("Setting up relationship joins to recursive relationship $otherName with $relationshipName.") if T(metadata => 4);
4387                      # Join from the left.                      # Join from the left.
4388                      $joinTable{"$relationshipName/$otherName"} =                      $joinTable{"$relationshipName/$otherName"} =
4389                          "$linkField = $otherName.from_link";                          "$linkField = $otherName.from_link";
4390                      # Join from the right.                      # Join from the right.
4391                      $joinTable{"$otherName/$relationshipName"} =                      $joinTable{"$otherName/$relationshipName"} =
4392                          "$otherName.to_link = $linkField";                          "$otherName.to_link = $linkField";
                 }  
             }  
         }  
         # Create entity joins for the recursive relationships. Unlike the non-recursive  
         # joins, the direction makes a difference with the recursive joins. This can give  
         # rise to situations where we can't create the path we want; however, it is always  
         # possible to get the same effect using multiple queries.  
         for my $relationshipName (@bothList) {  
             Trace("Setting up entity joins to recursive relationship $relationshipName with $entityName.") if T(metadata => 4);  
             # Join to the entity from each direction.  
             $joinTable{"$entityName/$relationshipName"} =  
                 "$entityName.id = $relationshipName.from_link";  
             $joinTable{"$relationshipName/$entityName"} =  
                 "$relationshipName.to_link = $entityName.id";  
         }  
     }  
     # Add the join table to the structure.  
     $metadata->{Joins} = \%joinTable;  
     # Return the slurped and fixed-up structure.  
     return $metadata;  
 }  
   
 =head3 SortNeeded  
   
 C<< my $parms = $erdb->SortNeeded($relationName); >>  
   
 Return the pipe command for the sort that should be applied to the specified  
 relation when creating the load file.  
   
 For example, if the load file should be sorted ascending by the first  
 field, this method would return  
   
     sort -k1 -t"\t"  
   
 If the first field is numeric, the method would return  
   
     sort -k1n -t"\t"  
   
 Unfortunately, due to a bug in the C<sort> command, we cannot eliminate duplicate  
 keys using a sort.  
   
 =over 4  
   
 =item relationName  
   
 Name of the relation to be examined.  
   
 =item  
   
 Returns the sort command to use for sorting the relation, suitable for piping.  
   
 =back  
   
 =cut  
 #: Return Type $;  
 sub SortNeeded {  
     # Get the parameters.  
     my ($self, $relationName) = @_;  
     # Declare a descriptor to hold the names of the key fields.  
     my @keyNames = ();  
     # Get the relation structure.  
     my $relationData = $self->_FindRelation($relationName);  
     # Find out if the relation is a primary entity relation,  
     # a relationship relation, or a secondary entity relation.  
     my $entityTable = $self->{_metaData}->{Entities};  
     my $relationshipTable = $self->{_metaData}->{Relationships};  
     if (exists $entityTable->{$relationName}) {  
         # Here we have a primary entity relation.  
         push @keyNames, "id";  
     } elsif (exists $relationshipTable->{$relationName}) {  
         # Here we have a relationship. We sort using the FROM index.  
         my $relationshipData = $relationshipTable->{$relationName};  
         my $index = $relationData->{Indexes}->{"idx${relationName}From"};  
         push @keyNames, @{$index->{IndexFields}};  
     } else {  
         # Here we have a secondary entity relation, so we have a sort on the ID field.  
         push @keyNames, "id";  
     }  
     # Now we parse the key names into sort parameters. First, we prime the return  
     # string.  
     my $retVal = "sort -t\"\t\" ";  
     # Get the relation's field list.  
     my @fields = @{$relationData->{Fields}};  
     # Loop through the keys.  
     for my $keyData (@keyNames) {  
         # Get the key and the ordering.  
         my ($keyName, $ordering);  
         if ($keyData =~ /^([^ ]+) DESC/) {  
             ($keyName, $ordering) = ($1, "descending");  
         } else {  
             ($keyName, $ordering) = ($keyData, "ascending");  
         }  
         # Find the key's position and type.  
         my $fieldSpec;  
         for (my $i = 0; $i <= $#fields && ! $fieldSpec; $i++) {  
             my $thisField = $fields[$i];  
             if ($thisField->{name} eq $keyName) {  
                 # Get the sort modifier for this field type. The modifier  
                 # decides whether we're using a character, numeric, or  
                 # floating-point sort.  
                 my $modifier = $TypeTable{$thisField->{type}}->{sort};  
                 # If the index is descending for this field, denote we want  
                 # to reverse the sort order on this field.  
                 if ($ordering eq 'descending') {  
                     $modifier .= "r";  
                 }  
                 # Store the position and modifier into the field spec, which  
                 # will stop the inner loop. Note that the field number is  
                 # 1-based in the sort command, so we have to increment the  
                 # index.  
                 $fieldSpec = ($i + 1) . $modifier;  
4393              }              }
4394          }          }
         # Add this field to the sort command.  
         $retVal .= " -k$fieldSpec";  
4395      }      }
4396      # Return the result.          # Create entity joins for the recursive relationships. Unlike the non-recursive
4397      return $retVal;          # joins, the direction makes a difference with the recursive joins. This can give
4398            # rise to situations where we can't create the path we want; however, it is always
4399            # possible to get the same effect using multiple queries.
4400            for my $relationshipName (@bothList) {
4401                Trace("Setting up entity joins to recursive relationship $relationshipName with $entityName.") if T(metadata => 4);
4402                # Join to the entity from each direction.
4403                $joinTable{"$entityName/$relationshipName"} =
4404                    "$entityName.id = $relationshipName.from_link";
4405                $joinTable{"$relationshipName/$entityName"} =
4406                    "$relationshipName.to_link = $entityName.id";
4407            }
4408        }
4409        # Add the join table to the structure.
4410        $metadata->{Joins} = \%joinTable;
4411        # Return the slurped and fixed-up structure.
4412        return $metadata;
4413  }  }
4414    
4415  =head3 CreateRelationshipIndex  =head3 _CreateRelationshipIndex
4416    
4417  Create an index for a relationship's relation.  Create an index for a relationship's relation.
4418    
# Line 3438  Line 4454 
4454          $newIndex->{Unique} = 'true';          $newIndex->{Unique} = 'true';
4455      }      }
4456      # Add the index to the relation.      # Add the index to the relation.
4457      _AddIndex("idx$relationshipName$indexKey", $relationStructure, $newIndex);      _AddIndex("idx$indexKey", $relationStructure, $newIndex);
4458  }  }
4459    
4460  =head3 AddIndex  =head3 _AddIndex
4461    
4462  Add an index to a relation structure.  Add an index to a relation structure.
4463    
# Line 3487  Line 4503 
4503      $relationStructure->{Indexes}->{$indexName} = $newIndex;      $relationStructure->{Indexes}->{$indexName} = $newIndex;
4504  }  }
4505    
4506  =head3 FixupFields  =head3 _FixupFields
4507    
4508  This method fixes the field list for an entity or relationship. It will add the caller-specified  This method fixes the field list for an entity or relationship. It will add the caller-specified
4509  relation name to fields that do not have a name and set the C<PrettySort> value as specified.  relation name to fields that do not have a name and set the C<PrettySort> value as specified.
# Line 3525  Line 4541 
4541          # Here it doesn't, so we create a new one.          # Here it doesn't, so we create a new one.
4542          $structure->{Fields} = { };          $structure->{Fields} = { };
4543      } else {      } else {
4544          # Here we have a field list. Loop through its fields.          # Here we have a field list. We need to track the searchable fields, so we
4545            # create a list for stashing them.
4546            my @textFields = ();
4547            # Loop through the fields.
4548          my $fieldStructures = $structure->{Fields};          my $fieldStructures = $structure->{Fields};
4549          for my $fieldName (keys %{$fieldStructures}) {          for my $fieldName (keys %{$fieldStructures}) {
4550              Trace("Processing field $fieldName of $defaultRelationName.") if T(4);              Trace("Processing field $fieldName of $defaultRelationName.") if T(4);
# Line 3534  Line 4553 
4553              my $type = $fieldData->{type};              my $type = $fieldData->{type};
4554              # Plug in a relation name if it is needed.              # Plug in a relation name if it is needed.
4555              Tracer::MergeOptions($fieldData, { relation => $defaultRelationName });              Tracer::MergeOptions($fieldData, { relation => $defaultRelationName });
4556              # Plug in a data generator if we need one.              # Check for searchability.
4557              if (!exists $fieldData->{DataGen}) {              if ($fieldData->{searchable}) {
4558                  # The data generator will use the default for the field's type.                  # Only allow this for a primary relation.
4559                  $fieldData->{DataGen} = { content => $TypeTable{$type}->{dataGen} };                  if ($fieldData->{relation} ne $defaultRelationName) {
4560                        Confess("Field $fieldName of $defaultRelationName is in secondary relations and cannot be searchable.");
4561                    } else {
4562                        push @textFields, $fieldName;
4563                    }
4564              }              }
             # Plug in the defaults for the optional data generation parameters.  
             Tracer::MergeOptions($fieldData->{DataGen}, { testCount => 1, pass => 0 });  
4565              # Add the PrettySortValue.              # Add the PrettySortValue.
4566              $fieldData->{PrettySort} = (($type eq "text") ? $textPrettySortValue : $prettySortValue);              $fieldData->{PrettySort} = (($type eq "text") ? $textPrettySortValue : $prettySortValue);
4567          }          }
4568            # If there are searchable fields, remember the fact.
4569            if (@textFields) {
4570                $structure->{searchFields} = \@textFields;
4571            }
4572      }      }
4573  }  }
4574    
4575  =head3 FixName  =head3 _FixName
4576    
4577  Fix the incoming field name so that it is a legal SQL column name.  Fix the incoming field name so that it is a legal SQL column name.
4578    
# Line 3576  Line 4601 
4601      return $fieldName;      return $fieldName;
4602  }  }
4603    
4604  =head3 FixNames  =head3 _FixNames
4605    
4606  Fix all the field names in a list.  Fix all the field names in a list.
4607    
# Line 3607  Line 4632 
4632      return @result;      return @result;
4633  }  }
4634    
4635  =head3 AddField  =head3 _AddField
4636    
4637  Add a field to a field list.  Add a field to a field list.
4638    
# Line 3642  Line 4667 
4667      $fieldList->{$fieldName} = $fieldStructure;      $fieldList->{$fieldName} = $fieldStructure;
4668  }  }
4669    
4670  =head3 ReOrderRelationTable  =head3 _ReOrderRelationTable
4671    
4672  This method will take a relation table and re-sort it according to the implicit ordering of the  This method will take a relation table and re-sort it according to the implicit ordering of the
4673  C<PrettySort> property. Instead of a hash based on field names, it will return a list of fields.  C<PrettySort> property. Instead of a hash based on field names, it will return a list of fields.
# Line 3703  Line 4728 
4728    
4729  }  }
4730    
4731  =head3 IsPrimary  =head3 _IsPrimary
4732    
4733  Return TRUE if a specified relation is a primary relation, else FALSE. A relation is primary  Return TRUE if a specified relation is a primary relation, else FALSE. A relation is primary
4734  if it has the same name as an entity or relationship.  if it has the same name as an entity or relationship.
# Line 3739  Line 4764 
4764      return $retVal;      return $retVal;
4765  }  }
4766    
4767  =head3 FindRelation  =head3 _FindRelation
4768    
4769  Return the descriptor for the specified relation.  Return the descriptor for the specified relation.
4770    
# Line 3770  Line 4795 
4795    
4796  =head2 HTML Documentation Utility Methods  =head2 HTML Documentation Utility Methods
4797    
4798  =head3 ComputeRelationshipSentence  =head3 _ComputeRelationshipSentence
4799    
4800  The relationship sentence consists of the relationship name between the names of the  The relationship sentence consists of the relationship name between the names of the
4801  two related entities and an arity indicator.  two related entities and an arity indicator.
# Line 3808  Line 4833 
4833      return $result;      return $result;
4834  }  }
4835    
4836  =head3 ComputeRelationshipHeading  =head3 _ComputeRelationshipHeading
4837    
4838  The relationship heading is the L<relationship sentence|/ComputeRelationshipSentence> with the entity  The relationship heading is the L<relationship sentence|/ComputeRelationshipSentence> with the entity
4839  names hyperlinked to the appropriate entity sections of the document.  names hyperlinked to the appropriate entity sections of the document.
# Line 3845  Line 4870 
4870      return $result;      return $result;
4871  }  }
4872    
4873  =head3 ShowRelationTable  =head3 _ShowRelationTable
4874    
4875  Generate the HTML string for a particular relation. The relation's data will be formatted as an HTML  Generate the HTML string for a particular relation. The relation's data will be formatted as an HTML
4876  table with three columns-- the field name, the field type, and the field description.  table with three columns-- the field name, the field type, and the field description.
# Line 3895  Line 4920 
4920          $htmlString .= "<li><b>Index $fullName</b>\n<ul>\n";          $htmlString .= "<li><b>Index $fullName</b>\n<ul>\n";
4921          # Add any note text.          # Add any note text.
4922          if (my $note = $indexData->{Notes}) {          if (my $note = $indexData->{Notes}) {
4923              $htmlString .= "<li>" . _HTMLNote($note->{content}) . "</li>\n";              $htmlString .= "<li>" . HTMLNote($note->{content}) . "</li>\n";
4924          }          }
4925          # Add the fiield list.          # Add the fiield list.
4926          $htmlString .= "<li><i>" . join(', ', @{$indexData->{IndexFields}}) . "</i></li>\n";          $htmlString .= "<li><i>" . join(', ', @{$indexData->{IndexFields}}) . "</i></li>\n";
# Line 3906  Line 4931 
4931      $htmlString .= "</ul>\n";      $htmlString .= "</ul>\n";
4932  }  }
4933    
4934  =head3 OpenFieldTable  =head3 _OpenFieldTable
4935    
4936  This method creates the header string for the field table generated by L</ShowMetaData>.  This method creates the header string for the field table generated by L</ShowMetaData>.
4937    
# Line 3931  Line 4956 
4956      return _OpenTable($tablename, 'Field', 'Type', 'Description');      return _OpenTable($tablename, 'Field', 'Type', 'Description');
4957  }  }
4958    
4959  =head3 OpenTable  =head3 _OpenTable
4960    
4961  This method creates the header string for an HTML table.  This method creates the header string for an HTML table.
4962    
# Line 3961  Line 4986 
4986      # Compute the number of columns.      # Compute the number of columns.
4987      my $colCount = @colNames;      my $colCount = @colNames;
4988      # Generate the title row.      # Generate the title row.
4989      my $htmlString = "<p><table border=\"2\"><tr><td colspan=\"$colCount\" align=\"center\">$tablename</td></tr>\n";      my $htmlString = "<table border=\"2\"><tr><td colspan=\"$colCount\" align=\"center\">$tablename</td></tr>\n";
4990      # Loop through the columns, adding the column header rows.      # Loop through the columns, adding the column header rows.
4991      $htmlString .= "<tr>";      $htmlString .= "<tr>";
4992      for my $colName (@colNames) {      for my $colName (@colNames) {
# Line 3971  Line 4996 
4996      return $htmlString;      return $htmlString;
4997  }  }
4998    
4999  =head3 CloseTable  =head3 _CloseTable
5000    
5001  This method returns the HTML for closing a table.  This method returns the HTML for closing a table.
5002    
# Line 3980  Line 5005 
5005  =cut  =cut
5006    
5007  sub _CloseTable {  sub _CloseTable {
5008      return "</table></p>\n";      return "</table>\n";
5009  }  }
5010    
5011  =head3 ShowField  =head3 _ShowField
5012    
5013  This method returns the HTML for displaying a row of field information in a field table.  This method returns the HTML for displaying a row of field information in a field table.
5014    
# Line 4010  Line 5035 
5035      my $htmlString = "<tr><th align=\"left\">$fieldData->{name}</th><td>$fieldData->{type}</td>";      my $htmlString = "<tr><th align=\"left\">$fieldData->{name}</th><td>$fieldData->{type}</td>";
5036      # If we have content, add it as a third column.      # If we have content, add it as a third column.
5037      if (exists $fieldData->{Notes}) {      if (exists $fieldData->{Notes}) {
5038          $htmlString .= "<td>" . _HTMLNote($fieldData->{Notes}->{content}) . "</td>";          $htmlString .= "<td>" . HTMLNote($fieldData->{Notes}->{content}) . "</td>";
5039      }      }
5040      # Close off the row.      # Close off the row.
5041      $htmlString .= "</tr>\n";      $htmlString .= "</tr>\n";
# Line 4018  Line 5043 
5043      return $htmlString;      return $htmlString;
5044  }  }
5045    
 =head3 HTMLNote  
   
 Convert a note or comment to HTML by replacing some bulletin-board codes with HTML. The codes  
 supported are C<[b]> for B<bold>, C<[i]> for I<italics>, and C<[p]> for a new paragraph.  
 Except for C<[p]>, all the codes are closed by slash-codes. So, for  
 example, C<[b]Feature[/b]> displays the string C<Feature> in boldface.  
   
 This is a static method.  
   
 =over 4  
   
 =item dataString  
   
 String to convert to HTML.  
   
 =item RETURN  
   
 An HTML string derived from the input string.  
   
 =back  
   
 =cut  
   
 sub _HTMLNote {  
     # Get the parameter.  
     my ($dataString) = @_;  
     # Substitute the codes.  
     $dataString =~ s!\[(/?[bi])\]!<$1>!g;  
     $dataString =~ s!\[p\]!</p><p>!g;  
     # Return the result.  
     return $dataString;  
 }  
   
 =head2 Data Generation Utilities  
   
 =head3 IntGen  
   
 C<< my $integer = IntGen($min, $max); >>  
   
 Returns a random number between the specified minimum and maximum (inclusive).  
   
 =over 4  
   
 =item min  
   
 Minimum permissible return value.  
   
 =item max  
   
 Maximum permissible return value.  
   
 =item RETURN  
   
 Returns a value no lower than the minimum and no greater than the maximum.  
   
 =back  
   
 =cut  
   
 sub IntGen {  
     # Get the parameters.  
     my ($min, $max) = @_;  
     # Determine the range of possible values. Note we put some space well above the  
     # maximum value to give it a fighting chance of apppearing in the list.  
     my $span = $max + 0.99 - $min;  
     # Create an integer in the range.  
     my $retVal = $min + int(rand($span));  
     # Return the result.  
     return $retVal;  
 }  
   
 =head3 RandChar  
   
 C<< my $char = RandChar($sourceString); >>  
   
 Select a random character from a string.  
   
 =over 4  
   
 =item sourceString  
   
 String from which the random character should be selected.  
   
 =item RETURN  
   
 Returns a single character from the incoming string.  
   
 =back  
   
 =cut  
   
 sub RandChar {  
     # Get the parameter.  
     my ($sourceString) = @_;  
     # Select a random character.  
     my $retVal = IntGen(0, (length $sourceString) - 1);  
     # Return it.  
     return substr($sourceString, $retVal, 1);  
 }  
   
 =head3 RandChars  
   
 C<< my $string = RandChars($sourceString, $length); >>  
   
 Create a string from characters taken from a source string.  
   
 =over 4  
   
 =item sourceString  
   
 String from which the random characters should be selected.  
   
 =item length  
   
 Number of characters to put in the output string.  
   
 =item RETURN  
   
 Returns a string of the specified length consisting of characters taken from the  
 source string.  
   
 =back  
   
 =cut  
   
 sub RandChars {  
     # Get the parameters.  
     my ($sourceString, $length) = @_;  
     # Call RandChar repeatedly to generate the string.  
     my $retVal = "";  
     for (my $i = 0; $i < $length; $i++) {  
         $retVal .= RandChar($sourceString);  
     }  
     # Return the result.  
     return $retVal;  
 }  
   
 =head3 RandParam  
   
 C<< my $value = RandParam($parm1, $parm2, ... $parmN); >>  
   
 Return a randomly-selected value from the parameter list.  
   
 =over 4  
   
 =item parm1, parm2, ... parmN  
   
 List of values of which one will be selected.  
   
 =item RETURN  
   
 Returns a randomly-chosen value from the specified list.  
   
 =back  
   
 =cut  
   
 sub RandParam {  
     # Get the parameter.  
     my @parms = @_;  
     # Choose a random parameter from the list.  
     my $chosenIndex = IntGen(0, $#parms);  
     return $parms[$chosenIndex];  
 }  
   
 =head3 StringGen  
   
 C<< my $string = StringGen($pattern1, $pattern2, ... $patternN); >>  
   
 Returns a random string derived from a randomly-chosen format pattern. The pattern  
 can either be a number (indicating the number of characters desired, or the letter  
 C<P> followed by a picture. The picture should contain C<A> when a letter is desired,  
 C<9> when a digit is desired, C<V> when a vowel is desired, C<K> when a consonant is  
 desired, and C<X> when a letter or a digit is desired. Any other character will be  
 translated as a literal.  
   
 =over 4  
   
 =item pattern1, pattern2, ... patternN  
   
 List of patterns to be used to generate string values.  
   
 =item RETURN  
   
 A single string generated from a pattern.  
   
 =back  
   
 =cut  
   
 sub StringGen {  
     # Get the parameters.  
     my @patterns = @_;  
     # Choose the appropriate pattern.  
     my $chosenPattern = RandParam(@patterns);  
     # Declare the return variable.  
     my $retVal = "";  
     # Determine whether this is a count or a picture pattern.  
     if ($chosenPattern =~ m/^\d+/) {  
         # Here we have a count. Get the string of source characters.  
         my $letterString = $PictureTable{'X'};  
         my $stringLen = length $letterString;  
         # Save the number of characters we have to generate.  
         my $charsLeft = $chosenPattern;  
         # Loop until the return variable is full.  
         while ($charsLeft > 0) {  
             # Generate a random position in the soruce string.  
             my $stringIndex = IntGen(0, $stringLen - 1);  
             # Compute the number of characters to pull out of the source string.  
             my $chunkSize = $stringLen - $stringIndex;  
             if ($chunkSize > $charsLeft) { $chunkSize = $charsLeft; }  
             # Stuff this chunk into the return value.  
             $retVal .= substr($letterString, $stringIndex, $chunkSize);  
             # Record the data moved.  
             $charsLeft -= $chunkSize;  
         }  
     } elsif ($chosenPattern =~ m/^P/) {  
         # Here we have a picture string. We will move through the picture one  
         # character at a time generating data.  
         for (my $i = 1; $i < length $chosenPattern; $i++) {  
             # Get this picture character.  
             my $chr = substr($chosenPattern, $i, 1);  
             # Check to see if the picture char is one we recognize.  
             if (exists $PictureTable{$chr}) {  
                 # Choose a random character from the available values for this  
                 # picture character.  
                 $retVal .= RandChar($PictureTable{$chr});  
             } else {  
                 # Copy in the picture character as a literal.  
                 $retVal .= $chr;  
             }  
         }  
     } else {  
         # Here we have neither a picture string or a letter count, so we treat  
         # the string as a literal.  
         $retVal = $chosenPattern;  
     }  
     # Return the string formed.  
     return $retVal;  
 }  
   
 =head3 DateGen  
   
 C<< my $date = DateGen($startDayOffset, $endDayOffset, $minutes); >>  
   
 Return a numeric timestamp within the specified range of days with the specified minute  
 value. The range of days is specified relevant to the current day. Thus, the call  
   
 C<< my $date = DateGen(-1, 5, 720); >>  
   
 will return a timestamp at noon (72 minutes past midnight) sometime during the week that  
 began on the preceding day. If you want a random minute of the day, simply combine with  
 a call to L</IntGen>, as follows.  
   
 C<< my $date = DateGen(-1, 5, IntGen(0, 1439)); >>  
   
 =over 4  
   
 =item startDayOffset  
   
 The earliest day that can be returned, relative to the current day.  
   
 =item endDayOffset  
   
 The latest day that can be returned, related to the current day.  
   
 =item minutes  
   
 Number of minutes into the selected day that should be used.  
   
 =back  
   
 =cut  
   
 sub DateGen {  
     # Get the parameters.  
     my ($startDayOffset, $endDayOffset, $minutes) = @_;  
     # Get midnight of the current day.  
     my $now = time();  
     my ($sec, $min, $hour) = localtime($now);  
     my $today = $now - (($hour * 60 + $min) * 60 + $sec);  
     # Compute the day we want.  
     my $newDay = IntGen($startDayOffset, $endDayOffset) * 86400 + $today;  
     # Add the minutes.  
     my $retVal = $newDay + $minutes * 60;  
     # Return the result.  
     return $retVal;  
 }  
   
 =head3 FloatGen  
   
 C<< my $number = FloatGen($min, $max); >>  
   
 Return a random floating-point number greater than or equal to the specified minimum and  
 less than the specified maximum.  
   
 =over 4  
   
 =item min  
   
 Minimum permissible value for the number returned.  
   
 =item max  
   
 Maximum permissible value for the number returned.  
   
 =item RETURN  
   
 Returns a floating-point number anywhere in the specified range.  
   
 =back  
   
 =cut  
   
 sub FloatGen {  
     # Get the parameters.  
     my ($min, $max) = @_;  
     # Generate the result.  
     my $retVal = rand($max - $min) + $min;  
     return $retVal;  
 }  
   
 =head3 ListGen  
   
 C<< my @list = ListGen($pattern, $count); >>  
   
 Return a list containing a fixed number of randomly-generated strings.  
   
 =over 4  
   
 =item pattern  
   
 A pattern (in the form expected by L</StringGen>) that should be used to generate the  
 strings in the list.  
   
 =item count  
   
 The number of list entries to generate.  
   
 =item RETURN  
   
 Returns a list consisting of the specified number of strings.  
   
 =back  
   
 =cut  
   
 sub ListGen {  
     # Get the parameters.  
     my ($pattern, $count) = @_;  
     # Generate the list.  
     my @retVal = ();  
     for (my $i = 0; $i < $count; $i++) {  
         push @retVal, StringGen($pattern);  
     }  
     # Return it.  
     return @retVal;  
 }  
   
5046  1;  1;

Legend:
Removed from v.1.69  
changed lines
  Added in v.1.84

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3