[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.74, Fri Nov 3 16:49:44 2006 UTC revision 1.87, Sun Feb 18 21:28:19 2007 UTC
# Line 228  Line 228 
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 in an
232  all be from the same relation. The alternate indexes assist in ordering results  index must all be from the same relation. The alternate indexes assist in searching
233  from a query. A relationship can have up to two indexes-- a I<to-index> and a  on fields other than the entity ID. A relationship has at least two indexes-- a I<to-index> and a
234  I<from-index>. These order the results when crossing the relationship. For  I<from-index> that 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
236  from-index would order the contigs of a ganome, and the to-index would order  from-index would order the contigs of a ganome, and the to-index would order
237  the genomes of a contig. A relationship's index must specify only fields in  the genomes of a contig. In addition, it can have zero or more alternate
238    indexes. A relationship's index must specify only fields in
239  the relationship.  the relationship.
240    
241  The indexes for an entity must be listed inside the B<Indexes> tag. The from-index  The alternate indexes for an entity or relationship must be listed inside the B<Indexes> tag.
242  of a relationship is specified using the B<FromIndex> tag; the to-index is specified  The from-index of a relationship is specified using the B<FromIndex> tag; the to-index is
243  using the B<ToIndex> tag.  specified using the B<ToIndex> tag.
244    
245  Each index can contain a B<Notes> tag. In addition, it will have an B<IndexFields>  Each index can contain a B<Notes> tag. In addition, it will have an B<IndexFields>
246  tag containing the B<IndexField> tags. These specify, in order, the fields used in  tag containing the B<IndexField> tags. These specify, in order, the fields used in
# Line 257  Line 258 
258    
259  =back  =back
260    
261  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
262    have a B<Unique> attribute. If specified, the index will be generated as a unique
263    index.
264    
265  =head3 Object and Field Names  =head3 Object and Field Names
266    
# Line 301  Line 304 
304    
305  A relationship is described by the C<Relationship> tag. Within a relationship,  A relationship is described by the C<Relationship> tag. Within a relationship,
306  there can be a C<Notes> tag, a C<Fields> tag containing the intersection data  there can be a C<Notes> tag, a C<Fields> tag containing the intersection data
307  fields, a C<FromIndex> tag containing the from-index, and a C<ToIndex> tag containing  fields, a C<FromIndex> tag containing the from-index, a C<ToIndex> tag containing
308  the to-index.  the to-index, and an C<Indexes> tag containing the alternate indexes.
309    
310  The C<Relationship> tag has the following attributes.  The C<Relationship> tag has the following attributes.
311    
# Line 336  Line 339 
339  # 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.
340  # "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
341  # of the specified type. "avgLen" is the average byte length for estimating  # of the specified type. "avgLen" is the average byte length for estimating
342  # record sizes. "sort" is the key modifier for the sort command, "notes" is a type description.  # record sizes. "sort" is the key modifier for the sort command, "notes" is a type description,
343    # and "indexMod", if non-zero, is the number of characters to use when the field is specified in an
344    # index
345  my %TypeTable = ( char =>    { sqlType => 'CHAR(1)',            maxLen => 1,            avgLen =>   1, sort => "",  my %TypeTable = ( char =>    { sqlType => 'CHAR(1)',            maxLen => 1,            avgLen =>   1, sort => "",
346                                 notes => "single ASCII character"},                                 indexMod =>   0, notes => "single ASCII character"},
347                    int =>     { sqlType => 'INTEGER',            maxLen => 20,           avgLen =>   4, sort => "n",                    int =>     { sqlType => 'INTEGER',            maxLen => 20,           avgLen =>   4, sort => "n",
348                                 notes => "signed 32-bit integer"},                                 indexMod =>   0, notes => "signed 32-bit integer"},
349                    counter => { sqlType => 'INTEGER UNSIGNED',   maxLen => 20,           avgLen =>   4, sort => "n",                    counter => { sqlType => 'INTEGER UNSIGNED',   maxLen => 20,           avgLen =>   4, sort => "n",
350                                 notes => "unsigned 32-bit integer"},                                 indexMod =>   0, notes => "unsigned 32-bit integer"},
351                    string =>  { sqlType => 'VARCHAR(255)',       maxLen => 255,          avgLen => 100, sort => "",                    string =>  { sqlType => 'VARCHAR(255)',       maxLen => 255,          avgLen => 100, sort => "",
352                                 notes => "character string, 0 to 255 characters"},                                 indexMod =>   0, notes => "character string, 0 to 255 characters"},
353                    text =>    { sqlType => 'TEXT',               maxLen => 1000000000,   avgLen => 500, sort => "",                    text =>    { sqlType => 'TEXT',               maxLen => 1000000000,   avgLen => 500, sort => "",
354                                 notes => "character string, nearly unlimited length, cannot be indexed"},                                 indexMod => 255, notes => "character string, nearly unlimited length, only first 255 characters are indexed"},
355                    date =>    { sqlType => 'BIGINT',             maxLen => 80,           avgLen =>   8, sort => "n",                    date =>    { sqlType => 'BIGINT',             maxLen => 80,           avgLen =>   8, sort => "n",
356                                 notes => "signed, 64-bit integer"},                                 indexMod =>   0, notes => "signed, 64-bit integer"},
357                    float =>   { sqlType => 'DOUBLE PRECISION',   maxLen => 40,           avgLen =>   8, sort => "g",                    float =>   { sqlType => 'DOUBLE PRECISION',   maxLen => 40,           avgLen =>   8, sort => "g",
358                                 notes => "64-bit double precision floating-point number"},                                 indexMod =>   0, notes => "64-bit double precision floating-point number"},
359                    boolean => { sqlType => 'SMALLINT',           maxLen => 1,            avgLen =>   1, sort => "n",                    boolean => { sqlType => 'SMALLINT',           maxLen => 1,            avgLen =>   1, sort => "n",
360                                 notes => "boolean value: 0 if false, 1 if true"},                                 indexMod =>   0, notes => "boolean value: 0 if false, 1 if true"},
361                   'hash-string' =>                   'hash-string' =>
362                               { sqlType => 'VARCHAR(22)',        maxLen => 22,           avgLen =>  22, sort => "",                               { sqlType => 'VARCHAR(22)',        maxLen => 22,           avgLen =>  22, sort => "",
363                                 notes => "string stored in digested form, used for certain types of key fields"},                                 indexMod =>   0, notes => "string stored in digested form, used for certain types of key fields"},
364                   'id-string' =>                   'id-string' =>
365                               { sqlType => 'VARCHAR(25)',        maxLen => 25,           avgLen =>  25, sort => "",                               { sqlType => 'VARCHAR(25)',        maxLen => 25,           avgLen =>  25, sort => "",
366                                 notes => "character string, 0 to 25 characters"},                                 indexMod =>   0, notes => "character string, 0 to 25 characters"},
367                   'key-string' =>                   'key-string' =>
368                               { sqlType => 'VARCHAR(40)',        maxLen => 40,           avgLen =>  10, sort => "",                               { sqlType => 'VARCHAR(40)',        maxLen => 40,           avgLen =>  10, sort => "",
369                                 notes => "character string, 0 to 40 characters"},                                 indexMod =>   0, notes => "character string, 0 to 40 characters"},
370                   'name-string' =>                   'name-string' =>
371                               { sqlType => 'VARCHAR(80)',        maxLen => 80,           avgLen =>  40, sort => "",                               { sqlType => 'VARCHAR(80)',        maxLen => 80,           avgLen =>  40, sort => "",
372                                 notes => "character string, 0 to 80 characters"},                                 indexMod =>   0, notes => "character string, 0 to 80 characters"},
373                   'medium-string' =>                   'medium-string' =>
374                               { sqlType => 'VARCHAR(160)',       maxLen => 160,          avgLen =>  40, sort => "",                               { sqlType => 'VARCHAR(160)',       maxLen => 160,          avgLen =>  40, sort => "",
375                                 notes => "character string, 0 to 160 characters"},                                 indexMod =>   0, notes => "character string, 0 to 160 characters"},
376                  );                  );
377    
378  # Table translating arities into natural language.  # Table translating arities into natural language.
# Line 392  Line 397 
397                   );                   );
398    
399  my %XmlInOpts  = (  my %XmlInOpts  = (
400                    ForceArray => ['Field', 'Index', 'IndexField'],                    ForceArray => ['Field', 'Index', 'IndexField', 'Relationship', 'Entity'],
401                    ForceContent => 1,                    ForceContent => 1,
402                    NormalizeSpace => 2,                    NormalizeSpace => 2,
403                   );                   );
# Line 544  Line 549 
549          if (my $notes = $entityData->{Notes}) {          if (my $notes = $entityData->{Notes}) {
550              $retVal .= "<p>" . HTMLNote($notes->{content}) . "</p>\n";              $retVal .= "<p>" . HTMLNote($notes->{content}) . "</p>\n";
551          }          }
552          # 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.
553            my $relCount = keys %{$relationshipList};
554            if ($relCount > 0) {
555                # First, we set up the relationship subsection.
556          $retVal .= "<h4>Relationships for <b>$key</b></h4>\n<ul>\n";          $retVal .= "<h4>Relationships for <b>$key</b></h4>\n<ul>\n";
557          # Loop through the relationships.          # Loop through the relationships.
558          for my $relationship (sort keys %{$relationshipList}) {          for my $relationship (sort keys %{$relationshipList}) {
# Line 560  Line 568 
568          }          }
569          # Close off the relationship list.          # Close off the relationship list.
570          $retVal .= "</ul>\n";          $retVal .= "</ul>\n";
571            }
572          # Get the entity's relations.          # Get the entity's relations.
573          my $relationList = $entityData->{Relations};          my $relationList = $entityData->{Relations};
574          # Create a header for the relation subsection.          # Create a header for the relation subsection.
# Line 735  Line 744 
744      # Loop through the relations.      # Loop through the relations.
745      for my $relationName (@relNames) {      for my $relationName (@relNames) {
746          # Create a table for this relation.          # Create a table for this relation.
747          $self->CreateTable($relationName);          $self->CreateTable($relationName, 1);
748          Trace("Relation $relationName created.") if T(2);          Trace("Relation $relationName created.") if T(2);
749      }      }
750  }  }
# Line 961  Line 970 
970      for my $indexName (keys %{$indexHash}) {      for my $indexName (keys %{$indexHash}) {
971          my $indexData = $indexHash->{$indexName};          my $indexData = $indexHash->{$indexName};
972          # Get the index's field list.          # Get the index's field list.
973          my @fieldList = _FixNames(@{$indexData->{IndexFields}});          my @rawFields = @{$indexData->{IndexFields}};
974            # Get a hash of the relation's field types.
975            my %types = map { $_->{name} => $_->{type} } @{$relationData->{Fields}};
976            # We need to check for text fields so we can append a length limitation for them. To do
977            # that, we need the relation's field list.
978            my $relFields = $relationData->{Fields};
979            for (my $i = 0; $i <= $#rawFields; $i++) {
980                # Get the field type.
981                my $field = $rawFields[$i];
982                my $type = $types{$field};
983                # Ask if it requires using prefix notation for the index.
984                my $mod = $TypeTable{$type}->{indexMod};
985                Trace("Field $field ($i) in $relationName has type $type and indexMod $mod.") if T(3);
986                if ($mod) {
987                    # Append the prefix length to the field name,
988                    $rawFields[$i] .= "($mod)";
989                }
990            }
991            my @fieldList = _FixNames(@rawFields);
992          my $flds = join(', ', @fieldList);          my $flds = join(', ', @fieldList);
993          # Get the index's uniqueness flag.          # Get the index's uniqueness flag.
994          my $unique = (exists $indexData->{Unique} ? 'unique' : undef);          my $unique = (exists $indexData->{Unique} ? 'unique' : undef);
# Line 976  Line 1003 
1003      }      }
1004  }  }
1005    
1006    =head3 GetSecondaryFields
1007    
1008    C<< my %fieldTuples = $erdb->GetSecondaryFields($entityName); >>
1009    
1010    This method will return a list of the name and type of each of the secondary
1011    fields for a specified entity. Secondary fields are stored in two-column tables
1012    in addition to the primary entity table. This enables the field to have no value
1013    or to have multiple values.
1014    
1015    =over 4
1016    
1017    =item entityName
1018    
1019    Name of the entity whose secondary fields are desired.
1020    
1021    =item RETURN
1022    
1023    Returns a hash mapping the field names to their field types.
1024    
1025    =back
1026    
1027    =cut
1028    
1029    sub GetSecondaryFields {
1030        # Get the parameters.
1031        my ($self, $entityName) = @_;
1032        # Declare the return variable.
1033        my %retVal = ();
1034        # Look for the entity.
1035        my $table = $self->GetFieldTable($entityName);
1036        # Loop through the fields, pulling out the secondaries.
1037        for my $field (sort keys %{$table}) {
1038            if ($table->{$field}->{relation} ne $entityName) {
1039                # Here we have a secondary field.
1040                $retVal{$field} = $table->{$field}->{type};
1041            }
1042        }
1043        # Return the result.
1044        return %retVal;
1045    }
1046    
1047    =head3 GetFieldRelationName
1048    
1049    C<< my $name = $erdb->GetFieldRelationName($objectName, $fieldName); >>
1050    
1051    Return the name of the relation containing a specified field.
1052    
1053    =over 4
1054    
1055    =item objectName
1056    
1057    Name of the entity or relationship containing the field.
1058    
1059    =item fieldName
1060    
1061    Name of the relevant field in that entity or relationship.
1062    
1063    =item RETURN
1064    
1065    Returns the name of the database relation containing the field, or C<undef> if
1066    the field does not exist.
1067    
1068    =back
1069    
1070    =cut
1071    
1072    sub GetFieldRelationName {
1073        # Get the parameters.
1074        my ($self, $objectName, $fieldName) = @_;
1075        # Declare the return variable.
1076        my $retVal;
1077        # Get the object field table.
1078        my $table = $self->GetFieldTable($objectName);
1079        # Only proceed if the field exists.
1080        if (exists $table->{$fieldName}) {
1081            # Determine the name of the relation that contains this field.
1082            $retVal = $table->{$fieldName}->{relation};
1083        }
1084        # Return the result.
1085        return $retVal;
1086    }
1087    
1088    =head3 DeleteValue
1089    
1090    C<< my $numDeleted = $erdb->DeleteValue($entityName, $id, $fieldName, $fieldValue); >>
1091    
1092    Delete secondary field values from the database. This method can be used to delete all
1093    values of a specified field for a particular entity instance, or only a single value.
1094    
1095    Secondary fields are stored in two-column relations separate from an entity's primary
1096    table, and as a result a secondary field can legitimately have no value or multiple
1097    values. Therefore, it makes sense to talk about deleting secondary fields where it
1098    would not make sense for primary fields.
1099    
1100    =over 4
1101    
1102    =item entityName
1103    
1104    Name of the entity from which the fields are to be deleted.
1105    
1106    =item id
1107    
1108    ID of the entity instance to be processed. If the instance is not found, this
1109    method will have no effect. If C<undef> is specified, all values for all of
1110    the entity instances will be deleted.
1111    
1112    =item fieldName
1113    
1114    Name of the field whose values are to be deleted.
1115    
1116    =item fieldValue (optional)
1117    
1118    Value to be deleted. If not specified, then all values of the specified field
1119    will be deleted for the entity instance. If specified, then only the values which
1120    match this parameter will be deleted.
1121    
1122    =item RETURN
1123    
1124    Returns the number of rows deleted.
1125    
1126    =back
1127    
1128    =cut
1129    
1130    sub DeleteValue {
1131        # Get the parameters.
1132        my ($self, $entityName, $id, $fieldName, $fieldValue) = @_;
1133        # Declare the return value.
1134        my $retVal = 0;
1135        # We need to set up an SQL command to do the deletion. First, we
1136        # find the name of the field's relation.
1137        my $table = $self->GetFieldTable($entityName);
1138        my $field = $table->{$fieldName};
1139        my $relation = $field->{relation};
1140        # Make sure this is a secondary field.
1141        if ($relation eq $entityName) {
1142            Confess("Cannot delete values of $fieldName for $entityName.");
1143        } else {
1144            # Set up the SQL command to delete all values.
1145            my $sql = "DELETE FROM $relation";
1146            # Build the filter.
1147            my @filters = ();
1148            my @parms = ();
1149            # Check for a filter by ID.
1150            if (defined $id) {
1151                push @filters, "id = ?";
1152                push @parms, $id;
1153            }
1154            # Check for a filter by value.
1155            if (defined $fieldValue) {
1156                push @filters, "$fieldName = ?";
1157                push @parms, $fieldValue;
1158            }
1159            # Append the filters to the command.
1160            if (@filters) {
1161                $sql .= " WHERE " . join(" AND ", @filters);
1162            }
1163            # Execute the command.
1164            my $dbh = $self->{_dbh};
1165            $retVal = $dbh->SQL($sql, 0, @parms);
1166        }
1167        # Return the result.
1168        return $retVal;
1169    }
1170    
1171  =head3 LoadTables  =head3 LoadTables
1172    
1173  C<< my $stats = $erdb->LoadTables($directoryName, $rebuild); >>  C<< my $stats = $erdb->LoadTables($directoryName, $rebuild); >>
# Line 1233  Line 1425 
1425      return $retVal;      return $retVal;
1426  }  }
1427    
1428    
1429    
1430  =head3 Search  =head3 Search
1431    
1432  C<< my $query = $erdb->Search($searchExpression, $idx, \@objectNames, $filterClause, \@params); >>  C<< my $query = $erdb->Search($searchExpression, $idx, \@objectNames, $filterClause, \@params); >>
# Line 1246  Line 1440 
1440    
1441  =item searchExpression  =item searchExpression
1442    
1443  Boolean search expression for the text fields of the target object.  Boolean search expression for the text fields of the target object. The default mode for
1444    a Boolean search expression is OR, but we want the default to be AND, so we will
1445    add a C<+> operator to each word with no other operator before it.
1446    
1447  =item idx  =item idx
1448    
# Line 1300  Line 1496 
1496          my @fields = @{$object1Structure->{searchFields}};          my @fields = @{$object1Structure->{searchFields}};
1497          # Clean the search expression.          # Clean the search expression.
1498          my $actualKeywords = $self->CleanKeywords($searchExpression);          my $actualKeywords = $self->CleanKeywords($searchExpression);
1499            # Prefix a "+" to each uncontrolled word. This converts the default
1500            # search mode from OR to AND.
1501            $actualKeywords =~ s/(^|\s)(\w|")/$1\+$2/g;
1502          Trace("Actual keywords for search are\n$actualKeywords") if T(3);          Trace("Actual keywords for search are\n$actualKeywords") if T(3);
1503          # We need two match expressions, one for the filter clause and one in the          # We need two match expressions, one for the filter clause and one in the
1504          # query itself. Both will use a parameter mark, so we need to push the          # query itself. Both will use a parameter mark, so we need to push the
# Line 1407  Line 1606 
1606      # Declare the return variable.      # Declare the return variable.
1607      my %retVal = ();      my %retVal = ();
1608      # Find the entity's data structure.      # Find the entity's data structure.
1609      my $entityData = $self->{Entities}->{$entityName};      my $entityData = $self->{_metaData}->{Entities}->{$entityName};
1610      # Loop through its fields, adding each special field to the return hash.      # Loop through its fields, adding each special field to the return hash.
1611      my $fieldHash = $entityData->{Fields};      my $fieldHash = $entityData->{Fields};
1612      for my $fieldName (keys %{$fieldHash}) {      for my $fieldName (keys %{$fieldHash}) {
# Line 1422  Line 1621 
1621    
1622  =head3 Delete  =head3 Delete
1623    
1624  C<< my $stats = $erdb->Delete($entityName, $objectID); >>  C<< my $stats = $erdb->Delete($entityName, $objectID, %options); >>
1625    
1626  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
1627  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.
1628  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 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
1630    relationship connected to a dependent entity or if it is the "to" entity connected to a 1-to-many
1631  dependent relationship.  dependent relationship.
1632    
1633  =over 4  =over 4
# Line 1441  Line 1641 
1641  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<%>),
1642  then it is presumed to by a LIKE pattern.  then it is presumed to by a LIKE pattern.
1643    
1644  =item testFlag  =item options
1645    
1646  If TRUE, the delete statements will be traced without being executed.  A hash detailing the options for this delete operation.
1647    
1648  =item RETURN  =item RETURN
1649    
# Line 1452  Line 1652 
1652    
1653  =back  =back
1654    
1655    The permissible options for this method are as follows.
1656    
1657    =over 4
1658    
1659    =item testMode
1660    
1661    If TRUE, then the delete statements will be traced, but no changes will be made to the database.
1662    
1663    =item keepRoot
1664    
1665    If TRUE, then the entity instances will not be deleted, only the dependent records.
1666    
1667    =back
1668    
1669  =cut  =cut
1670  #: Return Type $%;  #: Return Type $%;
1671  sub Delete {  sub Delete {
1672      # Get the parameters.      # Get the parameters.
1673      my ($self, $entityName, $objectID, $testFlag) = @_;      my ($self, $entityName, $objectID, %options) = @_;
1674      # Declare the return variable.      # Declare the return variable.
1675      my $retVal = Stats->new();      my $retVal = Stats->new();
1676      # Get the DBKernel object.      # Get the DBKernel object.
# Line 1473  Line 1687 
1687      # FROM-relationships and entities.      # FROM-relationships and entities.
1688      my @fromPathList = ();      my @fromPathList = ();
1689      my @toPathList = ();      my @toPathList = ();
1690      # 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
1691      # 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
1692      # 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
1693      # TODO list is always an entity.      # to-do list is always an entity.
1694      my @todoList = ([$entityName]);      my @todoList = ([$entityName]);
1695      while (@todoList) {      while (@todoList) {
1696          # Get the current path.          # Get the current path.
# Line 1484  Line 1698 
1698          # Copy it into a list.          # Copy it into a list.
1699          my @stackedPath = @{$current};          my @stackedPath = @{$current};
1700          # 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.
1701          my $entityName = pop @stackedPath;          my $myEntityName = pop @stackedPath;
1702          # Add it to the alreadyFound list.          # Add it to the alreadyFound list.
1703          $alreadyFound{$entityName} = 1;          $alreadyFound{$myEntityName} = 1;
1704            # Figure out if we need to delete this entity.
1705            if ($myEntityName ne $entityName || ! $options{keepRoot}) {
1706          # Get the entity data.          # Get the entity data.
1707          my $entityData = $self->_GetStructure($entityName);              my $entityData = $self->_GetStructure($myEntityName);
1708          # 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.  
1709          my $relations = $entityData->{Relations};          my $relations = $entityData->{Relations};
1710          for my $relation (keys %{$relations}) {          for my $relation (keys %{$relations}) {
1711              my @augmentedList = (@stackedPath, $relation);              my @augmentedList = (@stackedPath, $relation);
1712              push @fromPathList, \@augmentedList;              push @fromPathList, \@augmentedList;
1713          }          }
1714            }
1715          # Now we need to look for relationships connected to this entity.          # Now we need to look for relationships connected to this entity.
1716          my $relationshipList = $self->{_metaData}->{Relationships};          my $relationshipList = $self->{_metaData}->{Relationships};
1717          for my $relationshipName (keys %{$relationshipList}) {          for my $relationshipName (keys %{$relationshipList}) {
1718              my $relationship = $relationshipList->{$relationshipName};              my $relationship = $relationshipList->{$relationshipName};
1719              # Check the FROM field. We're only interested if it's us.              # Check the FROM field. We're only interested if it's us.
1720              if ($relationship->{from} eq $entityName) {              if ($relationship->{from} eq $myEntityName) {
1721                  # Add the path to this relationship.                  # Add the path to this relationship.
1722                  my @augmentedList = (@stackedPath, $entityName, $relationshipName);                  my @augmentedList = (@stackedPath, $myEntityName, $relationshipName);
1723                  push @fromPathList, \@augmentedList;                  push @fromPathList, \@augmentedList;
1724                  # 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
1725                  # and the target hasn't been seen yet, we want to                  # and the target hasn't been seen yet, we want to
# Line 1522  Line 1738 
1738              }              }
1739              # Now check the TO field. In this case only the relationship needs              # Now check the TO field. In this case only the relationship needs
1740              # deletion.              # deletion.
1741              if ($relationship->{to} eq $entityName) {              if ($relationship->{to} eq $myEntityName) {
1742                  my @augmentedList = (@stackedPath, $entityName, $relationshipName);                  my @augmentedList = (@stackedPath, $myEntityName, $relationshipName);
1743                  push @toPathList, \@augmentedList;                  push @toPathList, \@augmentedList;
1744              }              }
1745          }          }
1746      }      }
1747      # Create the first qualifier for the WHERE clause. This selects the      # Create the first qualifier for the WHERE clause. This selects the
1748      # 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
1749      # 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
1750      # to the table containing the dependent records to delete.      # to the table containing the dependent records to delete.
1751      my $qualifier = ($objectID =~ /%/ ? "LIKE ?" : "= ?");      my $qualifier = ($objectID =~ /%/ ? "LIKE ?" : "= ?");
1752      # 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 1569  Line 1785 
1785                  }                  }
1786              }              }
1787              # Now we have our desired DELETE statement.              # Now we have our desired DELETE statement.
1788              if ($testFlag) {              if ($options{testMode}) {
1789                  # Here the user wants to trace without executing.                  # Here the user wants to trace without executing.
1790                  Trace($stmt) if T(0);                  Trace($stmt) if T(0);
1791              } else {              } else {
1792                  # 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
1793                  # if an error occurs, so we just go ahead and do it.                  # if an error occurs, so we just go ahead and do it.
1794                  Trace("Executing delete from $target using '$objectID'.") if T(3);                  Trace("Executing delete from $target using '$objectID'.") if T(3);
1795                  my $rv = $db->SQL($stmt, 0, $objectID);                  my $rv = $db->SQL($stmt, 0, $objectID);
# Line 1588  Line 1804 
1804      return $retVal;      return $retVal;
1805  }  }
1806    
1807    =head3 Disconnect
1808    
1809    C<< $erdb->Disconnect($relationshipName, $originEntityName, $originEntityID); >>
1810    
1811    Disconnect an entity instance from all the objects to which it is related. This
1812    will delete each relationship instance that connects to the specified entity.
1813    
1814    =over 4
1815    
1816    =item relationshipName
1817    
1818    Name of the relationship whose instances are to be deleted.
1819    
1820    =item originEntityName
1821    
1822    Name of the entity that is to be disconnected.
1823    
1824    =item originEntityID
1825    
1826    ID of the entity that is to be disconnected.
1827    
1828    =back
1829    
1830    =cut
1831    
1832    sub Disconnect {
1833        # Get the parameters.
1834        my ($self, $relationshipName, $originEntityName, $originEntityID) = @_;
1835        # Get the relationship descriptor.
1836        my $structure = $self->_GetStructure($relationshipName);
1837        # Insure we have a relationship.
1838        if (! exists $structure->{from}) {
1839            Confess("$relationshipName is not a relationship in the database.");
1840        } else {
1841            # Get the database handle.
1842            my $dbh = $self->{_dbh};
1843            # We'll set this value to 1 if we find our entity.
1844            my $found = 0;
1845            # Loop through the ends of the relationship.
1846            for my $dir ('from', 'to') {
1847                if ($structure->{$dir} eq $originEntityName) {
1848                    # Delete all relationship instances on this side of the entity instance.
1849                    Trace("Disconnecting in $dir direction with ID \"$originEntityID\".");
1850                    $dbh->SQL("DELETE FROM $relationshipName WHERE ${dir}_link = ?", 0, $originEntityID);
1851                    $found = 1;
1852                }
1853            }
1854            # Insure we found the entity on at least one end.
1855            if (! $found) {
1856                Confess("Entity \"$originEntityName\" does not use $relationshipName.");
1857            }
1858        }
1859    }
1860    
1861    =head3 DeleteRow
1862    
1863    C<< $erdb->DeleteRow($relationshipName, $fromLink, $toLink, \%values); >>
1864    
1865    Delete a row from a relationship. In most cases, only the from-link and to-link are
1866    needed; however, for relationships with intersection data values can be specified
1867    for the other fields using a hash.
1868    
1869    =over 4
1870    
1871    =item relationshipName
1872    
1873    Name of the relationship from which the row is to be deleted.
1874    
1875    =item fromLink
1876    
1877    ID of the entity instance in the From direction.
1878    
1879    =item toLink
1880    
1881    ID of the entity instance in the To direction.
1882    
1883    =item values
1884    
1885    Reference to a hash of other values to be used for filtering the delete.
1886    
1887    =back
1888    
1889    =cut
1890    
1891    sub DeleteRow {
1892        # Get the parameters.
1893        my ($self, $relationshipName, $fromLink, $toLink, $values) = @_;
1894        # Create a hash of all the filter information.
1895        my %filter = ('from-link' => $fromLink, 'to-link' => $toLink);
1896        if (defined $values) {
1897            for my $key (keys %{$values}) {
1898                $filter{$key} = $values->{$key};
1899            }
1900        }
1901        # Build an SQL statement out of the hash.
1902        my @filters = ();
1903        my @parms = ();
1904        for my $key (keys %filter) {
1905            push @filters, _FixName($key) . " = ?";
1906            push @parms, $filter{$key};
1907        }
1908        Trace("Parms for delete row are " . join(", ", map { "\"$_\"" } @parms) . ".") if T(SQL => 4);
1909        my $command = "DELETE FROM $relationshipName WHERE " .
1910                      join(" AND ", @filters);
1911        # Execute it.
1912        my $dbh = $self->{_dbh};
1913        $dbh->SQL($command, undef, @parms);
1914    }
1915    
1916  =head3 SortNeeded  =head3 SortNeeded
1917    
1918  C<< my $parms = $erdb->SortNeeded($relationName); >>  C<< my $parms = $erdb->SortNeeded($relationName); >>
# Line 1638  Line 1963 
1963      } elsif (exists $relationshipTable->{$relationName}) {      } elsif (exists $relationshipTable->{$relationName}) {
1964          # Here we have a relationship. We sort using the FROM index.          # Here we have a relationship. We sort using the FROM index.
1965          my $relationshipData = $relationshipTable->{$relationName};          my $relationshipData = $relationshipTable->{$relationName};
1966          my $index = $relationData->{Indexes}->{"idx${relationName}From"};          my $index = $relationData->{Indexes}->{idxFrom};
1967          push @keyNames, @{$index->{IndexFields}};          push @keyNames, @{$index->{IndexFields}};
1968      } else {      } else {
1969          # Here we have a secondary entity relation, so we have a sort on the ID field.          # Here we have a secondary entity relation, so we have a sort on the ID field.
# Line 1984  Line 2309 
2309    
2310  =head3 InsertObject  =head3 InsertObject
2311    
2312  C<< my $ok = $erdb->InsertObject($objectType, \%fieldHash); >>  C<< $erdb->InsertObject($objectType, \%fieldHash); >>
2313    
2314  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
2315  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 2010  Line 2335 
2335    
2336  Hash of field names to values.  Hash of field names to values.
2337    
 =item RETURN  
   
 Returns 1 if successful, 0 if an error occurred.  
   
2338  =back  =back
2339    
2340  =cut  =cut
# Line 2112  Line 2433 
2433                  $retVal = $sth->execute(@parameterList);                  $retVal = $sth->execute(@parameterList);
2434                  if (!$retVal) {                  if (!$retVal) {
2435                      my $errorString = $sth->errstr();                      my $errorString = $sth->errstr();
2436                      Trace("Insert error: $errorString.") if T(0);                      Confess("Error inserting into $relationName: $errorString");
2437                    } else {
2438                        Trace("Insert successful using $parameterList[0].") if T(3);
2439                  }                  }
2440              }              }
2441          }          }
2442      }      }
2443      # Return the success indicator.      # Return a 1 for backward compatability.
2444      return $retVal;      return 1;
2445    }
2446    
2447    =head3 UpdateEntity
2448    
2449    C<< $erdb->UpdateEntity($entityName, $id, \%fields); >>
2450    
2451    Update the values of an entity. This is an unprotected update, so it should only be
2452    done if the database resides on a database server.
2453    
2454    =over 4
2455    
2456    =item entityName
2457    
2458    Name of the entity to update. (This is the entity type.)
2459    
2460    =item id
2461    
2462    ID of the entity to update. If no entity exists with this ID, an error will be thrown.
2463    
2464    =item fields
2465    
2466    Reference to a hash mapping field names to their new values. All of the fields named
2467    must be in the entity's primary relation, and they cannot any of them be the ID field.
2468    
2469    =back
2470    
2471    =cut
2472    
2473    sub UpdateEntity {
2474        # Get the parameters.
2475        my ($self, $entityName, $id, $fields) = @_;
2476        # Get a list of the field names being updated.
2477        my @fieldList = keys %{$fields};
2478        # Verify that the fields exist.
2479        my $checker = $self->GetFieldTable($entityName);
2480        for my $field (@fieldList) {
2481            if ($field eq 'id') {
2482                Confess("Cannot update the ID field for entity $entityName.");
2483            } elsif ($checker->{$field}->{relation} ne $entityName) {
2484                Confess("Cannot find $field in primary relation of $entityName.");
2485            }
2486        }
2487        # Build the SQL statement.
2488        my @sets = ();
2489        my @valueList = ();
2490        for my $field (@fieldList) {
2491            push @sets, _FixName($field) . " = ?";
2492            push @valueList, $fields->{$field};
2493        }
2494        my $command = "UPDATE $entityName SET " . join(", ", @sets) . " WHERE id = ?";
2495        # Add the ID to the list of binding values.
2496        push @valueList, $id;
2497        # Call SQL to do the work.
2498        my $rows = $self->{_dbh}->SQL($command, 0, @valueList);
2499        # Check for errors.
2500        if ($rows == 0) {
2501            Confess("Entity $id of type $entityName not found.");
2502        }
2503  }  }
2504    
2505  =head3 LoadTable  =head3 LoadTable
2506    
2507  C<< my %results = $erdb->LoadTable($fileName, $relationName, $truncateFlag); >>  C<< my $results = $erdb->LoadTable($fileName, $relationName, $truncateFlag); >>
2508    
2509  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
2510  first.  first.
# Line 2212  Line 2593 
2593              # The full-text index (if any) is always built last, even for MySQL.              # The full-text index (if any) is always built last, even for MySQL.
2594              # First we need to see if this table has a full-text index. Only              # First we need to see if this table has a full-text index. Only
2595              # primary relations are allowed that privilege.              # primary relations are allowed that privilege.
2596                Trace("Checking for full-text index on $relationName.") if T(2);
2597              if ($self->_IsPrimary($relationName)) {              if ($self->_IsPrimary($relationName)) {
2598                  # Get the relation's entity/relationship structure.                  $self->CreateSearchIndex($relationName);
                 my $structure = $self->_GetStructure($relationName);  
                 # Check for a searchable fields list.  
                 if (exists $structure->{searchFields}) {  
                     # Here we know that we need to create a full-text search index.  
                     # Get an SQL-formatted field name list.  
                     my $fields = join(", ", $self->_FixNames(@{$structure->{searchFields}}));  
                     # Create the index.  
                     $dbh->create_index(tbl => $relationName, idx => "search_idx_$relationName",  
                                        flds => $fields, kind => 'fulltext');  
                 }  
2599              }              }
2600          }          }
2601      }      }
# Line 2235  Line 2607 
2607      return $retVal;      return $retVal;
2608  }  }
2609    
2610    =head3 CreateSearchIndex
2611    
2612    C<< $erdb->CreateSearchIndex($objectName); >>
2613    
2614    Check for a full-text search index on the specified entity or relationship object, and
2615    if one is required, rebuild it.
2616    
2617    =over 4
2618    
2619    =item objectName
2620    
2621    Name of the entity or relationship to be indexed.
2622    
2623    =back
2624    
2625    =cut
2626    
2627    sub CreateSearchIndex {
2628        # Get the parameters.
2629        my ($self, $objectName) = @_;
2630        # Get the relation's entity/relationship structure.
2631        my $structure = $self->_GetStructure($objectName);
2632        # Get the database handle.
2633        my $dbh = $self->{_dbh};
2634        Trace("Checking for search fields in $objectName.") if T(3);
2635        # Check for a searchable fields list.
2636        if (exists $structure->{searchFields}) {
2637            # Here we know that we need to create a full-text search index.
2638            # Get an SQL-formatted field name list.
2639            my $fields = join(", ", _FixNames(@{$structure->{searchFields}}));
2640            # Create the index. If it already exists, it will be dropped.
2641            $dbh->create_index(tbl => $objectName, idx => "search_idx",
2642                               flds => $fields, kind => 'fulltext');
2643            Trace("Index created for $fields in $objectName.") if T(2);
2644        }
2645    }
2646    
2647  =head3 DropRelation  =head3 DropRelation
2648    
2649  C<< $erdb->DropRelation($relationName); >>  C<< $erdb->DropRelation($relationName); >>
# Line 2263  Line 2672 
2672      $dbh->drop_table(tbl => $relationName);      $dbh->drop_table(tbl => $relationName);
2673  }  }
2674    
2675    =head3 MatchSqlPattern
2676    
2677    C<< my $matched = ERDB::MatchSqlPattern($value, $pattern); >>
2678    
2679    Determine whether or not a specified value matches an SQL pattern. An SQL
2680    pattern has two wild card characters: C<%> that matches multiple characters,
2681    and C<_> that matches a single character. These can be escaped using a
2682    backslash (C<\>). We pull this off by converting the SQL pattern to a
2683    PERL regular expression. As per SQL rules, the match is case-insensitive.
2684    
2685    =over 4
2686    
2687    =item value
2688    
2689    Value to be matched against the pattern. Note that an undefined or empty
2690    value will not match anything.
2691    
2692    =item pattern
2693    
2694    SQL pattern against which to match the value. An undefined or empty pattern will
2695    match everything.
2696    
2697    =item RETURN
2698    
2699    Returns TRUE if the value and pattern match, else FALSE.
2700    
2701    =back
2702    
2703    =cut
2704    
2705    sub MatchSqlPattern {
2706        # Get the parameters.
2707        my ($value, $pattern) = @_;
2708        # Declare the return variable.
2709        my $retVal;
2710        # Insure we have a pattern.
2711        if (! defined($pattern) || $pattern eq "") {
2712            $retVal = 1;
2713        } else {
2714            # Break the pattern into pieces around the wildcard characters. Because we
2715            # use parentheses in the split function's delimiter expression, we'll get
2716            # list elements for the delimiters as well as the rest of the string.
2717            my @pieces = split /([_%]|\\[_%])/, $pattern;
2718            # Check some fast special cases.
2719            if ($pattern eq '%') {
2720                # A null pattern matches everything.
2721                $retVal = 1;
2722            } elsif (@pieces == 1) {
2723                # No wildcards, so we have a literal comparison. Note we're case-insensitive.
2724                $retVal = (lc($value) eq lc($pattern));
2725            } elsif (@pieces == 2 && $pieces[1] eq '%') {
2726                # A wildcard at the end, so we have a substring match. This is also case-insensitive.
2727                $retVal = (lc(substr($value, 0, length($pieces[0]))) eq lc($pieces[0]));
2728            } else {
2729                # Okay, we have to do it the hard way. Convert each piece to a PERL pattern.
2730                my $realPattern = "";
2731                for my $piece (@pieces) {
2732                    # Determine the type of piece.
2733                    if ($piece eq "") {
2734                        # Empty pieces are ignored.
2735                    } elsif ($piece eq "%") {
2736                        # Here we have a multi-character wildcard. Note that it can match
2737                        # zero or more characters.
2738                        $realPattern .= ".*"
2739                    } elsif ($piece eq "_") {
2740                        # Here we have a single-character wildcard.
2741                        $realPattern .= ".";
2742                    } elsif ($piece eq "\\%" || $piece eq "\\_") {
2743                        # This is an escape sequence (which is a rare thing, actually).
2744                        $realPattern .= substr($piece, 1, 1);
2745                    } else {
2746                        # Here we have raw text.
2747                        $realPattern .= quotemeta($piece);
2748                    }
2749                }
2750                # Do the match.
2751                $retVal = ($value =~ /^$realPattern$/i ? 1 : 0);
2752            }
2753        }
2754        # Return the result.
2755        return $retVal;
2756    }
2757    
2758  =head3 GetEntity  =head3 GetEntity
2759    
2760  C<< my $entityObject = $erdb->GetEntity($entityType, $ID); >>  C<< my $entityObject = $erdb->GetEntity($entityType, $ID); >>
# Line 2416  Line 2908 
2908  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
2909  feature ID followed by all of its aliases.  feature ID followed by all of its aliases.
2910    
2911  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)']); >>
2912    
2913  =over 4  =over 4
2914    
# Line 2670  Line 3162 
3162      # Declare the return variable. The field name is valid until we hear      # Declare the return variable. The field name is valid until we hear
3163      # differently.      # differently.
3164      my $retVal = 1;      my $retVal = 1;
3165        # Compute the maximum name length.
3166        my $maxLen = $TypeTable{'name-string'}->{maxLen};
3167      # Look for bad stuff in the name.      # Look for bad stuff in the name.
3168      if ($fieldName =~ /--/) {      if ($fieldName =~ /--/) {
3169          # Here we have a doubled minus sign.          # Here we have a doubled minus sign.
# Line 2679  Line 3173 
3173          # Here the field name is missing the initial letter.          # Here the field name is missing the initial letter.
3174          Trace("Field name $fieldName does not begin with a letter.") if T(1);          Trace("Field name $fieldName does not begin with a letter.") if T(1);
3175          $retVal = 0;          $retVal = 0;
3176        } elsif (length($fieldName) > $maxLen) {
3177            # Here the field name is too long.
3178            Trace("Maximum field name length is $maxLen. Field name must be truncated to " . substr($fieldName,0, $maxLen) . ".");
3179      } else {      } else {
3180          # Strip out the minus signs. Everything remaining must be a letter          # Strip out the minus signs. Everything remaining must be a letter,
3181          # or digit.          # underscore, or digit.
3182          my $strippedName = $fieldName;          my $strippedName = $fieldName;
3183          $strippedName =~ s/-//g;          $strippedName =~ s/-//g;
3184          if ($strippedName !~ /^[A-Za-z0-9]+$/) {          if ($strippedName !~ /^(\w|\d)+$/) {
3185              Trace("Field name $fieldName contains illegal characters.") if T(1);              Trace("Field name $fieldName contains illegal characters.") if T(1);
3186              $retVal = 0;              $retVal = 0;
3187          }          }
# Line 2833  Line 3330 
3330      # Substitute the bulletin board codes.      # Substitute the bulletin board codes.
3331      $retVal =~ s!\[(/?[bi])\]!<$1>!g;      $retVal =~ s!\[(/?[bi])\]!<$1>!g;
3332      $retVal =~ s!\[p\]!</p><p>!g;      $retVal =~ s!\[p\]!</p><p>!g;
3333        $retVal =~ s!\[link\s+([^\]]+)\]!<a href="$1">!g;
3334        $retVal =~ s!\[/link\]!</a>!g;
3335      # Return the result.      # Return the result.
3336      return $retVal;      return $retVal;
3337  }  }
3338    
3339    =head3 BeginTran
3340    
3341    C<< $erdb->BeginTran(); >>
3342    
3343    Start a database transaction.
3344    
3345    =cut
3346    
3347    sub BeginTran {
3348        my ($self) = @_;
3349        $self->{_dbh}->begin_tran();
3350    
3351    }
3352    
3353    =head3 CommitTran
3354    
3355    C<< $erdb->CommitTran(); >>
3356    
3357    Commit an active database transaction.
3358    
3359    =cut
3360    
3361    sub CommitTran {
3362        my ($self) = @_;
3363        $self->{_dbh}->commit_tran();
3364    }
3365    
3366    =head3 RollbackTran
3367    
3368    C<< $erdb->RollbackTran(); >>
3369    
3370    Roll back an active database transaction.
3371    
3372    =cut
3373    
3374    sub RollbackTran {
3375        my ($self) = @_;
3376        $self->{_dbh}->roll_tran();
3377    }
3378    
3379    
3380  =head2 Data Mining Methods  =head2 Data Mining Methods
3381    
# Line 3363  Line 3902 
3902      # Prepare the command.      # Prepare the command.
3903      my $sth = $dbh->prepare_command($command);      my $sth = $dbh->prepare_command($command);
3904      # Execute it with the parameters bound in.      # Execute it with the parameters bound in.
3905      $sth->execute(@{$params}) || Confess("SELECT error" . $sth->errstr());      $sth->execute(@{$params}) || Confess("SELECT error:  " . $sth->errstr());
3906      # Return the statement handle.      # Return the statement handle.
3907      return $sth;      return $sth;
3908  }  }
# Line 3604  Line 4143 
4143    
4144  =head3 _LoadMetaData  =head3 _LoadMetaData
4145    
4146    C<< my $metadata = ERDB::_LoadMetaData($filename); >>
4147    
4148  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.
4149  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
4150  load or use the database. The schema for the XML file is F<ERDatabase.xml>.  load or use the database. The schema for the XML file is F<ERDatabase.xml>.
# Line 3627  Line 4168 
4168  sub _LoadMetaData {  sub _LoadMetaData {
4169      # Get the parameters.      # Get the parameters.
4170      my ($filename) = @_;      my ($filename) = @_;
4171      Trace("Reading Sprout DBD from $filename.") if T(2);      Trace("Reading DBD from $filename.") if T(2);
4172      # 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
4173      # get the exact structure we want.      # get the exact structure we want.
4174      my $metadata = ReadMetaXML($filename);      my $metadata = ReadMetaXML($filename);
# Line 3753  Line 4294 
4294              if ($found == 0) {              if ($found == 0) {
4295                  push @{$indexList}, { IndexFields => [ {name => 'id', order => 'ascending'} ] };                  push @{$indexList}, { IndexFields => [ {name => 'id', order => 'ascending'} ] };
4296              }              }
4297              # Now we need to convert the relation's index list to an index table. We begin by creating              # Attach all the indexes to the relation.
4298              # an empty table in the relation structure.              _ProcessIndexes($indexList, $relation);
             $relation->{Indexes} = { };  
             # Loop through the indexes.  
             my $count = 0;  
             for my $index (@{$indexList}) {  
                 # Add this index to the index table.  
                 _AddIndex("idx$relationName$count", $relation, $index);  
                 # Increment the counter so that the next index has a different name.  
                 $count++;  
             }  
4299          }          }
4300          # Finally, we add the relation structure to the entity.          # Finally, we add the relation structure to the entity.
4301          $entityStructure->{Relations} = $relationTable;          $entityStructure->{Relations} = $relationTable;
# Line 3777  Line 4309 
4309          _FixupFields($relationshipStructure, $relationshipName, 2, 3);          _FixupFields($relationshipStructure, $relationshipName, 2, 3);
4310          # Format a description for the FROM field.          # Format a description for the FROM field.
4311          my $fromEntity = $relationshipStructure->{from};          my $fromEntity = $relationshipStructure->{from};
4312          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].";
4313          # Get the FROM entity's key type.          # Get the FROM entity's key type.
4314          my $fromType = $entityList->{$fromEntity}->{keyType};          my $fromType = $entityList->{$fromEntity}->{keyType};
4315          # Add the FROM field.          # Add the FROM field.
# Line 3787  Line 4319 
4319                                                      PrettySort => 1});                                                      PrettySort => 1});
4320          # Format a description for the TO field.          # Format a description for the TO field.
4321          my $toEntity = $relationshipStructure->{to};          my $toEntity = $relationshipStructure->{to};
4322          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].";
4323          # Get the TO entity's key type.          # Get the TO entity's key type.
4324          my $toType = $entityList->{$toEntity}->{keyType};          my $toType = $entityList->{$toEntity}->{keyType};
4325          # Add the TO field.          # Add the TO field.
# Line 3799  Line 4331 
4331          my $thisRelation = { Fields => _ReOrderRelationTable($relationshipStructure->{Fields}),          my $thisRelation = { Fields => _ReOrderRelationTable($relationshipStructure->{Fields}),
4332                               Indexes => { } };                               Indexes => { } };
4333          $relationshipStructure->{Relations} = { $relationshipName => $thisRelation };          $relationshipStructure->{Relations} = { $relationshipName => $thisRelation };
4334    
4335            # Add the alternate indexes (if any). This MUST be done before the FROM and
4336            # TO indexes, because it erases the relation's index list.
4337            if (exists $relationshipStructure->{Indexes}) {
4338                _ProcessIndexes($relationshipStructure->{Indexes}, $thisRelation);
4339            }
4340            # Add the relation to the master table.
4341          # Create the FROM and TO indexes.          # Create the FROM and TO indexes.
4342          _CreateRelationshipIndex("From", $relationshipName, $relationshipStructure);          _CreateRelationshipIndex("From", $relationshipName, $relationshipStructure);
4343          _CreateRelationshipIndex("To", $relationshipName, $relationshipStructure);          _CreateRelationshipIndex("To", $relationshipName, $relationshipStructure);
         # Add the relation to the master table.  
4344          $masterRelationTable{$relationshipName} = $thisRelation;          $masterRelationTable{$relationshipName} = $thisRelation;
4345      }      }
4346      # Now store the master relation table in the metadata structure.      # Now store the master relation table in the metadata structure.
# Line 3958  Line 4496 
4496          $newIndex->{Unique} = 'true';          $newIndex->{Unique} = 'true';
4497      }      }
4498      # Add the index to the relation.      # Add the index to the relation.
4499      _AddIndex("idx$relationshipName$indexKey", $relationStructure, $newIndex);      _AddIndex("idx$indexKey", $relationStructure, $newIndex);
4500    }
4501    
4502    =head3 _ProcessIndexes
4503    
4504    C<< ERDB::_ProcessIndexes($indexList, $relation); >>
4505    
4506    Build the data structures for the specified indexes in the specified relation.
4507    
4508    =over 4
4509    
4510    =item indexList
4511    
4512    Reference to a list of indexes. Each index is a hash reference containing an optional
4513    C<Notes> value that describes the index and an C<IndexFields> value that is a reference
4514    to a list of index field structures. An index field structure, in turn, is a reference
4515    to a hash that contains a C<name> attribute for the field name and an C<order>
4516    attribute that specifies either C<ascending> or C<descending>. In this sense the
4517    index list encapsulates the XML C<Indexes> structure in the database definition.
4518    
4519    =item relation
4520    
4521    The structure that describes the current relation. The new index descriptors will
4522    be stored in the structure's C<Indexes> member. Any previous data in the structure
4523    will be lost.
4524    
4525    =back
4526    
4527    =cut
4528    
4529    sub _ProcessIndexes {
4530        # Get the parameters.
4531        my ($indexList, $relation) = @_;
4532        # Now we need to convert the relation's index list to an index table. We begin by creating
4533        # an empty table in the relation structure.
4534        $relation->{Indexes} = { };
4535        # Loop through the indexes.
4536        my $count = 0;
4537        for my $index (@{$indexList}) {
4538            # Add this index to the index table.
4539            _AddIndex("idx$count", $relation, $index);
4540            # Increment the counter so that the next index has a different name.
4541            $count++;
4542        }
4543  }  }
4544    
4545  =head3 _AddIndex  =head3 _AddIndex
# Line 4490  Line 5071 
5071      # Compute the number of columns.      # Compute the number of columns.
5072      my $colCount = @colNames;      my $colCount = @colNames;
5073      # Generate the title row.      # Generate the title row.
5074      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";
5075      # Loop through the columns, adding the column header rows.      # Loop through the columns, adding the column header rows.
5076      $htmlString .= "<tr>";      $htmlString .= "<tr>";
5077      for my $colName (@colNames) {      for my $colName (@colNames) {
# Line 4509  Line 5090 
5090  =cut  =cut
5091    
5092  sub _CloseTable {  sub _CloseTable {
5093      return "</table></p>\n";      return "</table>\n";
5094  }  }
5095    
5096  =head3 _ShowField  =head3 _ShowField

Legend:
Removed from v.1.74  
changed lines
  Added in v.1.87

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3