[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.77, Mon Nov 20 05:53:02 2006 UTC revision 1.92, Mon Jun 11 18:51:23 2007 UTC
# Line 6  Line 6 
6      use Data::Dumper;      use Data::Dumper;
7      use XML::Simple;      use XML::Simple;
8      use DBQuery;      use DBQuery;
9      use DBObject;      use ERDBObject;
10      use Stats;      use Stats;
11      use Time::HiRes qw(gettimeofday);      use Time::HiRes qw(gettimeofday);
12      use Digest::MD5 qw(md5_base64);      use Digest::MD5 qw(md5_base64);
     use FIG;  
13      use CGI;      use CGI;
14    
15  =head1 Entity-Relationship Database Package  =head1 Entity-Relationship Database Package
# Line 228  Line 227 
227    
228  =head3 Indexes  =head3 Indexes
229    
230  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
231  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
232  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
233  I<from-index>. These order the results when crossing the relationship. For  I<from-index> that order the results when crossing the relationship. For
234  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
235  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
236  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
237    indexes. A relationship's index must specify only fields in
238  the relationship.  the relationship.
239    
240  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.
241  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
242  using the B<ToIndex> tag.  specified using the B<ToIndex> tag.
243    
244  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>
245  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 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 301  Line 303 
303    
304  A relationship is described by the C<Relationship> tag. Within a relationship,  A relationship is described by the C<Relationship> tag. Within a relationship,
305  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
306  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
307  the to-index.  the to-index, and an C<Indexes> tag containing the alternate indexes.
308    
309  The C<Relationship> tag has the following attributes.  The C<Relationship> tag has the following attributes.
310    
# Line 370  Line 372 
372                   'medium-string' =>                   'medium-string' =>
373                               { sqlType => 'VARCHAR(160)',       maxLen => 160,          avgLen =>  40, sort => "",                               { sqlType => 'VARCHAR(160)',       maxLen => 160,          avgLen =>  40, sort => "",
374                                 indexMod =>   0, notes => "character string, 0 to 160 characters"},                                 indexMod =>   0, notes => "character string, 0 to 160 characters"},
375                     'long-string' =>
376                                 { sqlType => 'VARCHAR(500)',       maxLen => 500,          avglen => 255, sort => "",
377                                   indexMod =>   0, notes => "character string, 0 to 500 characters"},
378                  );                  );
379    
380  # Table translating arities into natural language.  # Table translating arities into natural language.
# Line 394  Line 399 
399                   );                   );
400    
401  my %XmlInOpts  = (  my %XmlInOpts  = (
402                    ForceArray => ['Field', 'Index', 'IndexField'],                    ForceArray => ['Field', 'Index', 'IndexField', 'Relationship', 'Entity'],
403                    ForceContent => 1,                    ForceContent => 1,
404                    NormalizeSpace => 2,                    NormalizeSpace => 2,
405                   );                   );
# Line 546  Line 551 
551          if (my $notes = $entityData->{Notes}) {          if (my $notes = $entityData->{Notes}) {
552              $retVal .= "<p>" . HTMLNote($notes->{content}) . "</p>\n";              $retVal .= "<p>" . HTMLNote($notes->{content}) . "</p>\n";
553          }          }
554          # 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.
555            my $relCount = keys %{$relationshipList};
556            if ($relCount > 0) {
557                # First, we set up the relationship subsection.
558          $retVal .= "<h4>Relationships for <b>$key</b></h4>\n<ul>\n";          $retVal .= "<h4>Relationships for <b>$key</b></h4>\n<ul>\n";
559          # Loop through the relationships.          # Loop through the relationships.
560          for my $relationship (sort keys %{$relationshipList}) {          for my $relationship (sort keys %{$relationshipList}) {
# Line 562  Line 570 
570          }          }
571          # Close off the relationship list.          # Close off the relationship list.
572          $retVal .= "</ul>\n";          $retVal .= "</ul>\n";
573            }
574          # Get the entity's relations.          # Get the entity's relations.
575          my $relationList = $entityData->{Relations};          my $relationList = $entityData->{Relations};
576          # Create a header for the relation subsection.          # Create a header for the relation subsection.
# Line 648  Line 657 
657      return Data::Dumper::Dumper($self->{_metaData});      return Data::Dumper::Dumper($self->{_metaData});
658  }  }
659    
660    =head3 CreatePPO
661    
662    C<< ERDB::CreatePPO($erdbXMLFile, $ppoXMLFile); >>
663    
664    Create a PPO XML file from an ERDB data definition XML file. At the
665    current time, the PPO XML file can be used to create a database with
666    similar functionality. Eventually, the PPO will be able to use the
667    created XML to access the live ERDB database.
668    
669    =over 4
670    
671    =item erdbXMLFile
672    
673    Name of the XML data definition file for the ERDB database. This
674    file must exist.
675    
676    =item ppoXMLFile
677    
678    Output file for the PPO XML definition. If this file exists, it
679    will be overwritten.
680    
681    =back
682    
683    =cut
684    
685    sub CreatePPO {
686        # Get the parameters.
687        my ($erdbXMLFile, $ppoXMLFile) = @_;
688        # First, we want to slurp in the ERDB XML file in its raw form.
689        my $xml = ReadMetaXML($erdbXMLFile);
690        # Create a variable to hold all of the objects in the PPO project.
691        my @objects = ();
692        # Get the relationship hash.
693        my $relationships = $xml->{Relationships};
694        # Loop through the entities.
695        my $entities = $xml->{Entities};
696        for my $entityName (keys %{$entities}) {
697            # Get the entity's data structures.
698            my $entityObject = $entities->{$entityName};
699            # We put the object's fields in here, according to their type.
700            my (@object_refs, @scalars, @indexes, @arrays);
701            # Create the ID field for the entity. We get the key type from the
702            # entity object and compute the corresponding SQL type.
703            my $type = $TypeTable{$entityObject->{keyType}}->{sqlType};
704            push @scalars, { label => 'id', type => $type };
705            # Loop through the entity fields.
706            for my $fieldName ( keys %{$entityObject->{Fields}} ) {
707                # Get the field object.
708                my $fieldObject = $entityObject->{Fields}->{$fieldName};
709                # Convert it to a scalar tag.
710                my $scalar = _CreatePPOField($fieldName, $fieldObject);
711                # If we have a relation, this field is stored in an array.
712                # otherwise, it is a scalar. The array tag has scalars
713                # stored as an XML array. In ERDB, there is only ever one,
714                # but PPO can have more.
715                my $relation = $fieldObject->{relation};
716                if ($relation) {
717                    push @arrays, { scalar => [$scalar] };
718                } else {
719                    push @scalars, $scalar;
720                }
721            }
722            # Loop through the relationships. If this entity is the to-entity
723            # on a relationship of 1M arity, then it is implemented as a PPO
724            # object reference.
725            for my $relationshipName (keys %{$relationships}) {
726                # Get the relationship data.
727                my $relationshipData = $relationships->{$relationshipName};
728                # If we have a from for this entity and an arity of 1M, we
729                # have an object reference.
730                if ($relationshipData->{to} eq $entityName &&
731                    $relationshipData->{arity} eq '1M') {
732                    # Build the object reference tag.
733                    push @object_refs, { label => $relationshipName,
734                                         type => $relationshipData->{from} };
735                }
736            }
737            # Create the indexes.
738            my $indexList = $entityObject->{Indexes};
739            push @indexes, map { _CreatePPOIndex($_) } @{$indexList};
740            # Build the object XML tree.
741            my $object = { label => $entityName,
742                           object_ref => \@object_refs,
743                           scalar => \@scalars,
744                           index => \@indexes,
745                           array => \@arrays
746                          };
747            # Push the object onto the objects list.
748            push @objects, $object;
749        }
750        # Loop through the relationships, searching for MMs. The 1Ms were
751        # already handled by the entity search above.
752        for my $relationshipName (keys %{$relationships}) {
753            # Get this relationship's object.
754            my $relationshipObject = $relationships->{$relationshipName};
755            # Only proceed if it's many-to-many.
756            if ($relationshipObject->{arity} eq 'MM') {
757                # Create the tag lists for the relationship object.
758                my (@object_refs, @scalars, @indexes);
759                # The relationship will be created as an object with object
760                # references for its links to the participating entities.
761                my %links = ( from_link => $relationshipObject->{from},
762                              to_link => $relationshipObject->{to} );
763                for my $link (keys %links) {
764                    # Create an object_ref tag for this piece of the
765                    # relationship (from or to).
766                    my $object_ref = { label => $link,
767                                       type => $links{$link} };
768                    push @object_refs, $object_ref;
769                }
770                # Loop through the intersection data fields, creating scalar tags.
771                # There are no fancy array tags in a relationship.
772                for my $fieldName (keys %{$relationshipObject->{Fields}}) {
773                    my $fieldObject = $relationshipObject->{Fields}->{$fieldName};
774                    push @scalars, _CreatePPOField($fieldName, $fieldObject);
775                }
776                # Finally, the indexes: currently we cannot support the to-index and
777                # from-index in PPO, so we just process the alternate indexes.
778                my $indexList = $relationshipObject->{Indexes};
779                push @indexes, map { _CreatePPOIndex($_) } @{$indexList};
780                # Wrap up all the stuff about this relationship.
781                my $object = { label => $relationshipName,
782                               scalar => \@scalars,
783                               object_ref => \@object_refs,
784                               index => \@indexes
785                             };
786                # Push it into the object list.
787                push @objects, $object;
788            }
789        }
790        # Compute a title.
791        my $title;
792        if ($erdbXMLFile =~ /(\/|^)([^\/]+)DBD\.xml/) {
793            # Here we have a standard file name we can use for a title.
794            $title = $2;
795        } else {
796            # Here the file name is non-standard, so we carve up the
797            # database title.
798            $title = $xml->{Title}->{content};
799            $title =~ s/\s\.,//g;
800        }
801        # Wrap up the XML as a project.
802        my $ppoXML = { project => { label => $title,
803                                    object => \@objects }};
804        # Write out the results.
805        my $ppoString = XML::Simple::XMLout($ppoXML,
806                                            AttrIndent => 1,
807                                            KeepRoot => 1);
808        Tracer::PutFile($ppoXMLFile, [ $ppoString ]);
809    }
810    
811  =head3 FindIndexForEntity  =head3 FindIndexForEntity
812    
813  C<< my $indexFound = ERDB::FindIndexForEntity($xml, $entityName, $attributeName); >>  C<< my $indexFound = ERDB::FindIndexForEntity($xml, $entityName, $attributeName); >>
# Line 737  Line 897 
897      # Loop through the relations.      # Loop through the relations.
898      for my $relationName (@relNames) {      for my $relationName (@relNames) {
899          # Create a table for this relation.          # Create a table for this relation.
900          $self->CreateTable($relationName);          $self->CreateTable($relationName, 1);
901          Trace("Relation $relationName created.") if T(2);          Trace("Relation $relationName created.") if T(2);
902      }      }
903  }  }
# Line 857  Line 1017 
1017              my $oldString = $fieldList->[$i];              my $oldString = $fieldList->[$i];
1018              if (length($oldString) > $maxLen) {              if (length($oldString) > $maxLen) {
1019                  # Here it's too big, so we truncate it.                  # Here it's too big, so we truncate it.
1020                  Trace("Truncating field $i in relation $relName to $maxLen characters from \"$oldString\".") if T(1);                  Trace("Truncating field $i ($fieldTypes->[$i]->{name}) in relation $relName to $maxLen characters from \"$oldString\".") if T(1);
1021                  $fieldList->[$i] = substr $oldString, 0, $maxLen;                  $fieldList->[$i] = substr $oldString, 0, $maxLen;
1022                  $retVal++;                  $retVal++;
1023              }              }
# Line 966  Line 1126 
1126          my @rawFields = @{$indexData->{IndexFields}};          my @rawFields = @{$indexData->{IndexFields}};
1127          # Get a hash of the relation's field types.          # Get a hash of the relation's field types.
1128          my %types = map { $_->{name} => $_->{type} } @{$relationData->{Fields}};          my %types = map { $_->{name} => $_->{type} } @{$relationData->{Fields}};
1129          # We need to check for text fields. We need a append a length limitation for them. To do          # We need to check for text fields so we can append a length limitation for them. To do
1130          # that, we need the relation's field list.          # that, we need the relation's field list.
1131          my $relFields = $relationData->{Fields};          my $relFields = $relationData->{Fields};
1132          for (my $i = 0; $i <= $#rawFields; $i++) {          for (my $i = 0; $i <= $#rawFields; $i++) {
# Line 1418  Line 1578 
1578      return $retVal;      return $retVal;
1579  }  }
1580    
1581    
1582    
1583  =head3 Search  =head3 Search
1584    
1585  C<< my $query = $erdb->Search($searchExpression, $idx, \@objectNames, $filterClause, \@params); >>  C<< my $query = $erdb->Search($searchExpression, $idx, \@objectNames, $filterClause, \@params); >>
# Line 1489  Line 1651 
1651          my $actualKeywords = $self->CleanKeywords($searchExpression);          my $actualKeywords = $self->CleanKeywords($searchExpression);
1652          # Prefix a "+" to each uncontrolled word. This converts the default          # Prefix a "+" to each uncontrolled word. This converts the default
1653          # search mode from OR to AND.          # search mode from OR to AND.
1654          $actualKeywords =~ s/(^|\s)(\w)/$1\+$2/g;          $actualKeywords =~ s/(^|\s)(\w|")/$1\+$2/g;
1655          Trace("Actual keywords for search are\n$actualKeywords") if T(3);          Trace("Actual keywords for search are\n$actualKeywords") if T(3);
1656          # 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
1657          # 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 1612  Line 1774 
1774    
1775  =head3 Delete  =head3 Delete
1776    
1777  C<< my $stats = $erdb->Delete($entityName, $objectID, $testFlag); >>  C<< my $stats = $erdb->Delete($entityName, $objectID, %options); >>
1778    
1779  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
1780  relationship instances dependent on it. The definition of I<dependence> is recursive.  relationship instances dependent on it. The definition of I<dependence> is recursive.
# Line 1632  Line 1794 
1794  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<%>),
1795  then it is presumed to by a LIKE pattern.  then it is presumed to by a LIKE pattern.
1796    
1797  =item testFlag  =item options
1798    
1799  If TRUE, the delete statements will be traced without being executed.  A hash detailing the options for this delete operation.
1800    
1801  =item RETURN  =item RETURN
1802    
# Line 1643  Line 1805 
1805    
1806  =back  =back
1807    
1808    The permissible options for this method are as follows.
1809    
1810    =over 4
1811    
1812    =item testMode
1813    
1814    If TRUE, then the delete statements will be traced, but no changes will be made to the database.
1815    
1816    =item keepRoot
1817    
1818    If TRUE, then the entity instances will not be deleted, only the dependent records.
1819    
1820    =back
1821    
1822  =cut  =cut
1823  #: Return Type $%;  #: Return Type $%;
1824  sub Delete {  sub Delete {
1825      # Get the parameters.      # Get the parameters.
1826      my ($self, $entityName, $objectID, $testFlag) = @_;      my ($self, $entityName, $objectID, %options) = @_;
1827      # Declare the return variable.      # Declare the return variable.
1828      my $retVal = Stats->new();      my $retVal = Stats->new();
1829      # Get the DBKernel object.      # Get the DBKernel object.
# Line 1664  Line 1840 
1840      # FROM-relationships and entities.      # FROM-relationships and entities.
1841      my @fromPathList = ();      my @fromPathList = ();
1842      my @toPathList = ();      my @toPathList = ();
1843      # 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
1844      # 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
1845      # 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
1846      # to-do list is always an entity.      # to-do list is always an entity.
# Line 1675  Line 1851 
1851          # Copy it into a list.          # Copy it into a list.
1852          my @stackedPath = @{$current};          my @stackedPath = @{$current};
1853          # 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.
1854          my $entityName = pop @stackedPath;          my $myEntityName = pop @stackedPath;
1855          # Add it to the alreadyFound list.          # Add it to the alreadyFound list.
1856          $alreadyFound{$entityName} = 1;          $alreadyFound{$myEntityName} = 1;
1857            # Figure out if we need to delete this entity.
1858            if ($myEntityName ne $entityName || ! $options{keepRoot}) {
1859          # Get the entity data.          # Get the entity data.
1860          my $entityData = $self->_GetStructure($entityName);              my $entityData = $self->_GetStructure($myEntityName);
1861          # 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.  
1862          my $relations = $entityData->{Relations};          my $relations = $entityData->{Relations};
1863          for my $relation (keys %{$relations}) {          for my $relation (keys %{$relations}) {
1864              my @augmentedList = (@stackedPath, $relation);              my @augmentedList = (@stackedPath, $relation);
1865              push @fromPathList, \@augmentedList;              push @fromPathList, \@augmentedList;
1866          }          }
1867            }
1868          # Now we need to look for relationships connected to this entity.          # Now we need to look for relationships connected to this entity.
1869          my $relationshipList = $self->{_metaData}->{Relationships};          my $relationshipList = $self->{_metaData}->{Relationships};
1870          for my $relationshipName (keys %{$relationshipList}) {          for my $relationshipName (keys %{$relationshipList}) {
1871              my $relationship = $relationshipList->{$relationshipName};              my $relationship = $relationshipList->{$relationshipName};
1872              # Check the FROM field. We're only interested if it's us.              # Check the FROM field. We're only interested if it's us.
1873              if ($relationship->{from} eq $entityName) {              if ($relationship->{from} eq $myEntityName) {
1874                  # Add the path to this relationship.                  # Add the path to this relationship.
1875                  my @augmentedList = (@stackedPath, $entityName, $relationshipName);                  my @augmentedList = (@stackedPath, $myEntityName, $relationshipName);
1876                  push @fromPathList, \@augmentedList;                  push @fromPathList, \@augmentedList;
1877                  # 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
1878                  # and the target hasn't been seen yet, we want to                  # and the target hasn't been seen yet, we want to
# Line 1713  Line 1891 
1891              }              }
1892              # Now check the TO field. In this case only the relationship needs              # Now check the TO field. In this case only the relationship needs
1893              # deletion.              # deletion.
1894              if ($relationship->{to} eq $entityName) {              if ($relationship->{to} eq $myEntityName) {
1895                  my @augmentedList = (@stackedPath, $entityName, $relationshipName);                  my @augmentedList = (@stackedPath, $myEntityName, $relationshipName);
1896                  push @toPathList, \@augmentedList;                  push @toPathList, \@augmentedList;
1897              }              }
1898          }          }
1899      }      }
1900      # Create the first qualifier for the WHERE clause. This selects the      # Create the first qualifier for the WHERE clause. This selects the
1901      # 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
1902      # 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
1903      # to the table containing the dependent records to delete.      # to the table containing the dependent records to delete.
1904      my $qualifier = ($objectID =~ /%/ ? "LIKE ?" : "= ?");      my $qualifier = ($objectID =~ /%/ ? "LIKE ?" : "= ?");
1905      # 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 1760  Line 1938 
1938                  }                  }
1939              }              }
1940              # Now we have our desired DELETE statement.              # Now we have our desired DELETE statement.
1941              if ($testFlag) {              if ($options{testMode}) {
1942                  # Here the user wants to trace without executing.                  # Here the user wants to trace without executing.
1943                  Trace($stmt) if T(0);                  Trace($stmt) if T(0);
1944              } else {              } else {
# Line 1779  Line 1957 
1957      return $retVal;      return $retVal;
1958  }  }
1959    
1960    =head3 Disconnect
1961    
1962    C<< $erdb->Disconnect($relationshipName, $originEntityName, $originEntityID); >>
1963    
1964    Disconnect an entity instance from all the objects to which it is related. This
1965    will delete each relationship instance that connects to the specified entity.
1966    
1967    =over 4
1968    
1969    =item relationshipName
1970    
1971    Name of the relationship whose instances are to be deleted.
1972    
1973    =item originEntityName
1974    
1975    Name of the entity that is to be disconnected.
1976    
1977    =item originEntityID
1978    
1979    ID of the entity that is to be disconnected.
1980    
1981    =back
1982    
1983    =cut
1984    
1985    sub Disconnect {
1986        # Get the parameters.
1987        my ($self, $relationshipName, $originEntityName, $originEntityID) = @_;
1988        # Get the relationship descriptor.
1989        my $structure = $self->_GetStructure($relationshipName);
1990        # Insure we have a relationship.
1991        if (! exists $structure->{from}) {
1992            Confess("$relationshipName is not a relationship in the database.");
1993        } else {
1994            # Get the database handle.
1995            my $dbh = $self->{_dbh};
1996            # We'll set this value to 1 if we find our entity.
1997            my $found = 0;
1998            # Loop through the ends of the relationship.
1999            for my $dir ('from', 'to') {
2000                if ($structure->{$dir} eq $originEntityName) {
2001                    # Delete all relationship instances on this side of the entity instance.
2002                    Trace("Disconnecting in $dir direction with ID \"$originEntityID\".");
2003                    $dbh->SQL("DELETE FROM $relationshipName WHERE ${dir}_link = ?", 0, $originEntityID);
2004                    $found = 1;
2005                }
2006            }
2007            # Insure we found the entity on at least one end.
2008            if (! $found) {
2009                Confess("Entity \"$originEntityName\" does not use $relationshipName.");
2010            }
2011        }
2012    }
2013    
2014    =head3 DeleteRow
2015    
2016    C<< $erdb->DeleteRow($relationshipName, $fromLink, $toLink, \%values); >>
2017    
2018    Delete a row from a relationship. In most cases, only the from-link and to-link are
2019    needed; however, for relationships with intersection data values can be specified
2020    for the other fields using a hash.
2021    
2022    =over 4
2023    
2024    =item relationshipName
2025    
2026    Name of the relationship from which the row is to be deleted.
2027    
2028    =item fromLink
2029    
2030    ID of the entity instance in the From direction.
2031    
2032    =item toLink
2033    
2034    ID of the entity instance in the To direction.
2035    
2036    =item values
2037    
2038    Reference to a hash of other values to be used for filtering the delete.
2039    
2040    =back
2041    
2042    =cut
2043    
2044    sub DeleteRow {
2045        # Get the parameters.
2046        my ($self, $relationshipName, $fromLink, $toLink, $values) = @_;
2047        # Create a hash of all the filter information.
2048        my %filter = ('from-link' => $fromLink, 'to-link' => $toLink);
2049        if (defined $values) {
2050            for my $key (keys %{$values}) {
2051                $filter{$key} = $values->{$key};
2052            }
2053        }
2054        # Build an SQL statement out of the hash.
2055        my @filters = ();
2056        my @parms = ();
2057        for my $key (keys %filter) {
2058            push @filters, _FixName($key) . " = ?";
2059            push @parms, $filter{$key};
2060        }
2061        Trace("Parms for delete row are " . join(", ", map { "\"$_\"" } @parms) . ".") if T(SQL => 4);
2062        my $command = "DELETE FROM $relationshipName WHERE " .
2063                      join(" AND ", @filters);
2064        # Execute it.
2065        my $dbh = $self->{_dbh};
2066        $dbh->SQL($command, undef, @parms);
2067    }
2068    
2069    =head3 DeleteLike
2070    
2071    C<< my $deleteCount = $erdb->DeleteLike($relName, $filter, \@parms); >>
2072    
2073    Delete all the relationship rows that satisfy a particular filter condition. Unlike a normal
2074    filter, only fields from the relationship itself can be used.
2075    
2076    =over 4
2077    
2078    =item relName
2079    
2080    Name of the relationship whose records are to be deleted.
2081    
2082    =item filter
2083    
2084    A filter clause (L</Get>-style) for the delete query.
2085    
2086    =item parms
2087    
2088    Reference to a list of parameters for the filter clause.
2089    
2090    =item RETURN
2091    
2092    Returns a count of the number of rows deleted.
2093    
2094    =back
2095    
2096    =cut
2097    
2098    sub DeleteLike {
2099        # Get the parameters.
2100        my ($self, $objectName, $filter, $parms) = @_;
2101        # Declare the return variable.
2102        my $retVal;
2103        # Insure the parms argument is an array reference if the caller left it off.
2104        if (! defined($parms)) {
2105            $parms = [];
2106        }
2107        # Insure we have a relationship. The main reason for this is if we delete an entity
2108        # instance we have to yank out a bunch of other stuff with it.
2109        if ($self->IsEntity($objectName)) {
2110            Confess("Cannot use DeleteLike on $objectName, because it is not a relationship.");
2111        } else {
2112            # Create the SQL command suffix to get the desierd records.
2113            my ($suffix) = $self->_SetupSQL([$objectName], $filter);
2114            # Convert it to a DELETE command.
2115            my $command = "DELETE $suffix";
2116            # Execute the command.
2117            my $dbh = $self->{_dbh};
2118            my $result = $dbh->SQL($command, 0, @{$parms});
2119            # Check the results. Note we convert the "0D0" result to a real zero.
2120            # A failure causes an abnormal termination, so the caller isn't going to
2121            # worry about it.
2122            if (! defined $result) {
2123                Confess("Error deleting from $objectName: " . $dbh->errstr());
2124            } elsif ($result == 0) {
2125                $retVal = 0;
2126            } else {
2127                $retVal = $result;
2128            }
2129        }
2130        # Return the result count.
2131        return $retVal;
2132    }
2133    
2134  =head3 SortNeeded  =head3 SortNeeded
2135    
2136  C<< my $parms = $erdb->SortNeeded($relationName); >>  C<< my $parms = $erdb->SortNeeded($relationName); >>
# Line 1919  Line 2271 
2271    
2272  =item RETURN  =item RETURN
2273    
2274  Returns a list of B<DBObject>s that satisfy the query conditions.  Returns a list of B<ERDBObject>s that satisfy the query conditions.
2275    
2276  =back  =back
2277    
# Line 2175  Line 2527 
2527    
2528  =head3 InsertObject  =head3 InsertObject
2529    
2530  C<< my $ok = $erdb->InsertObject($objectType, \%fieldHash); >>  C<< $erdb->InsertObject($objectType, \%fieldHash); >>
2531    
2532  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
2533  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 2201  Line 2553 
2553    
2554  Hash of field names to values.  Hash of field names to values.
2555    
 =item RETURN  
   
 Returns 1 if successful, 0 if an error occurred.  
   
2556  =back  =back
2557    
2558  =cut  =cut
# Line 2303  Line 2651 
2651                  $retVal = $sth->execute(@parameterList);                  $retVal = $sth->execute(@parameterList);
2652                  if (!$retVal) {                  if (!$retVal) {
2653                      my $errorString = $sth->errstr();                      my $errorString = $sth->errstr();
2654                      Trace("Insert error: $errorString.") if T(0);                      Confess("Error inserting into $relationName: $errorString");
2655                    } else {
2656                        Trace("Insert successful using $parameterList[0].") if T(3);
2657                  }                  }
2658              }              }
2659          }          }
2660      }      }
2661      # Return the success indicator.      # Return a 1 for backward compatability.
2662      return $retVal;      return 1;
2663    }
2664    
2665    =head3 UpdateEntity
2666    
2667    C<< $erdb->UpdateEntity($entityName, $id, \%fields); >>
2668    
2669    Update the values of an entity. This is an unprotected update, so it should only be
2670    done if the database resides on a database server.
2671    
2672    =over 4
2673    
2674    =item entityName
2675    
2676    Name of the entity to update. (This is the entity type.)
2677    
2678    =item id
2679    
2680    ID of the entity to update. If no entity exists with this ID, an error will be thrown.
2681    
2682    =item fields
2683    
2684    Reference to a hash mapping field names to their new values. All of the fields named
2685    must be in the entity's primary relation, and they cannot any of them be the ID field.
2686    
2687    =back
2688    
2689    =cut
2690    
2691    sub UpdateEntity {
2692        # Get the parameters.
2693        my ($self, $entityName, $id, $fields) = @_;
2694        # Get a list of the field names being updated.
2695        my @fieldList = keys %{$fields};
2696        # Verify that the fields exist.
2697        my $checker = $self->GetFieldTable($entityName);
2698        for my $field (@fieldList) {
2699            if ($field eq 'id') {
2700                Confess("Cannot update the ID field for entity $entityName.");
2701            } elsif ($checker->{$field}->{relation} ne $entityName) {
2702                Confess("Cannot find $field in primary relation of $entityName.");
2703            }
2704        }
2705        # Build the SQL statement.
2706        my @sets = ();
2707        my @valueList = ();
2708        for my $field (@fieldList) {
2709            push @sets, _FixName($field) . " = ?";
2710            push @valueList, $fields->{$field};
2711        }
2712        my $command = "UPDATE $entityName SET " . join(", ", @sets) . " WHERE id = ?";
2713        # Add the ID to the list of binding values.
2714        push @valueList, $id;
2715        # Call SQL to do the work.
2716        my $rows = $self->{_dbh}->SQL($command, 0, @valueList);
2717        # Check for errors.
2718        if ($rows == 0) {
2719            Confess("Entity $id of type $entityName not found.");
2720        }
2721  }  }
2722    
2723  =head3 LoadTable  =head3 LoadTable
2724    
2725  C<< my %results = $erdb->LoadTable($fileName, $relationName, $truncateFlag); >>  C<< my $results = $erdb->LoadTable($fileName, $relationName, $truncateFlag); >>
2726    
2727  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
2728  first.  first.
# Line 2361  Line 2769 
2769          # leave extra room. We postulate a minimum row count of 1000 to          # leave extra room. We postulate a minimum row count of 1000 to
2770          # prevent problems with incoming empty load files.          # prevent problems with incoming empty load files.
2771          my $rowSize = $self->EstimateRowSize($relationName);          my $rowSize = $self->EstimateRowSize($relationName);
2772          my $estimate = FIG::max($fileSize * 1.5 / $rowSize, 1000);          my $estimate = $fileSize * 1.5 / $rowSize;
2773            if ($estimate < 1000) {
2774                $estimate = 1000;
2775            }
2776          # Re-create the table without its index.          # Re-create the table without its index.
2777          $self->CreateTable($relationName, 0, $estimate);          $self->CreateTable($relationName, 0, $estimate);
2778          # If this is a pre-index DBMS, create the index here.          # If this is a pre-index DBMS, create the index here.
# Line 2403  Line 2814 
2814              # 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.
2815              # 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
2816              # primary relations are allowed that privilege.              # primary relations are allowed that privilege.
2817                Trace("Checking for full-text index on $relationName.") if T(2);
2818              if ($self->_IsPrimary($relationName)) {              if ($self->_IsPrimary($relationName)) {
2819                  # 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",  
                                        flds => $fields, kind => 'fulltext');  
                 }  
2820              }              }
2821          }          }
2822      }      }
# Line 2426  Line 2828 
2828      return $retVal;      return $retVal;
2829  }  }
2830    
2831    =head3 CreateSearchIndex
2832    
2833    C<< $erdb->CreateSearchIndex($objectName); >>
2834    
2835    Check for a full-text search index on the specified entity or relationship object, and
2836    if one is required, rebuild it.
2837    
2838    =over 4
2839    
2840    =item objectName
2841    
2842    Name of the entity or relationship to be indexed.
2843    
2844    =back
2845    
2846    =cut
2847    
2848    sub CreateSearchIndex {
2849        # Get the parameters.
2850        my ($self, $objectName) = @_;
2851        # Get the relation's entity/relationship structure.
2852        my $structure = $self->_GetStructure($objectName);
2853        # Get the database handle.
2854        my $dbh = $self->{_dbh};
2855        Trace("Checking for search fields in $objectName.") if T(3);
2856        # Check for a searchable fields list.
2857        if (exists $structure->{searchFields}) {
2858            # Here we know that we need to create a full-text search index.
2859            # Get an SQL-formatted field name list.
2860            my $fields = join(", ", _FixNames(@{$structure->{searchFields}}));
2861            # Create the index. If it already exists, it will be dropped.
2862            $dbh->create_index(tbl => $objectName, idx => "search_idx",
2863                               flds => $fields, kind => 'fulltext');
2864            Trace("Index created for $fields in $objectName.") if T(2);
2865        }
2866    }
2867    
2868  =head3 DropRelation  =head3 DropRelation
2869    
2870  C<< $erdb->DropRelation($relationName); >>  C<< $erdb->DropRelation($relationName); >>
# Line 2454  Line 2893 
2893      $dbh->drop_table(tbl => $relationName);      $dbh->drop_table(tbl => $relationName);
2894  }  }
2895    
2896    =head3 MatchSqlPattern
2897    
2898    C<< my $matched = ERDB::MatchSqlPattern($value, $pattern); >>
2899    
2900    Determine whether or not a specified value matches an SQL pattern. An SQL
2901    pattern has two wild card characters: C<%> that matches multiple characters,
2902    and C<_> that matches a single character. These can be escaped using a
2903    backslash (C<\>). We pull this off by converting the SQL pattern to a
2904    PERL regular expression. As per SQL rules, the match is case-insensitive.
2905    
2906    =over 4
2907    
2908    =item value
2909    
2910    Value to be matched against the pattern. Note that an undefined or empty
2911    value will not match anything.
2912    
2913    =item pattern
2914    
2915    SQL pattern against which to match the value. An undefined or empty pattern will
2916    match everything.
2917    
2918    =item RETURN
2919    
2920    Returns TRUE if the value and pattern match, else FALSE.
2921    
2922    =back
2923    
2924    =cut
2925    
2926    sub MatchSqlPattern {
2927        # Get the parameters.
2928        my ($value, $pattern) = @_;
2929        # Declare the return variable.
2930        my $retVal;
2931        # Insure we have a pattern.
2932        if (! defined($pattern) || $pattern eq "") {
2933            $retVal = 1;
2934        } else {
2935            # Break the pattern into pieces around the wildcard characters. Because we
2936            # use parentheses in the split function's delimiter expression, we'll get
2937            # list elements for the delimiters as well as the rest of the string.
2938            my @pieces = split /([_%]|\\[_%])/, $pattern;
2939            # Check some fast special cases.
2940            if ($pattern eq '%') {
2941                # A null pattern matches everything.
2942                $retVal = 1;
2943            } elsif (@pieces == 1) {
2944                # No wildcards, so we have a literal comparison. Note we're case-insensitive.
2945                $retVal = (lc($value) eq lc($pattern));
2946            } elsif (@pieces == 2 && $pieces[1] eq '%') {
2947                # A wildcard at the end, so we have a substring match. This is also case-insensitive.
2948                $retVal = (lc(substr($value, 0, length($pieces[0]))) eq lc($pieces[0]));
2949            } else {
2950                # Okay, we have to do it the hard way. Convert each piece to a PERL pattern.
2951                my $realPattern = "";
2952                for my $piece (@pieces) {
2953                    # Determine the type of piece.
2954                    if ($piece eq "") {
2955                        # Empty pieces are ignored.
2956                    } elsif ($piece eq "%") {
2957                        # Here we have a multi-character wildcard. Note that it can match
2958                        # zero or more characters.
2959                        $realPattern .= ".*"
2960                    } elsif ($piece eq "_") {
2961                        # Here we have a single-character wildcard.
2962                        $realPattern .= ".";
2963                    } elsif ($piece eq "\\%" || $piece eq "\\_") {
2964                        # This is an escape sequence (which is a rare thing, actually).
2965                        $realPattern .= substr($piece, 1, 1);
2966                    } else {
2967                        # Here we have raw text.
2968                        $realPattern .= quotemeta($piece);
2969                    }
2970                }
2971                # Do the match.
2972                $retVal = ($value =~ /^$realPattern$/i ? 1 : 0);
2973            }
2974        }
2975        # Return the result.
2976        return $retVal;
2977    }
2978    
2979  =head3 GetEntity  =head3 GetEntity
2980    
2981  C<< my $entityObject = $erdb->GetEntity($entityType, $ID); >>  C<< my $entityObject = $erdb->GetEntity($entityType, $ID); >>
# Line 2472  Line 2994 
2994    
2995  =item RETURN  =item RETURN
2996    
2997  Returns a B<DBObject> representing the desired entity instance, or an undefined value if no  Returns a B<ERDBObject> representing the desired entity instance, or an undefined value if no
2998  instance is found with the specified key.  instance is found with the specified key.
2999    
3000  =back  =back
# Line 2605  Line 3127 
3127  fields specified returns multiple values, they are flattened in with the rest. For  fields specified returns multiple values, they are flattened in with the rest. For
3128  example, the following call will return a list of the features in a particular  example, the following call will return a list of the features in a particular
3129  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
3130  feature ID followed by all of its aliases.  feature ID followed by all of its essentiality determinations.
3131    
3132  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(essential)']); >>
3133    
3134  =over 4  =over 4
3135    
# Line 2861  Line 3383 
3383      # Declare the return variable. The field name is valid until we hear      # Declare the return variable. The field name is valid until we hear
3384      # differently.      # differently.
3385      my $retVal = 1;      my $retVal = 1;
3386        # Compute the maximum name length.
3387        my $maxLen = $TypeTable{'name-string'}->{maxLen};
3388      # Look for bad stuff in the name.      # Look for bad stuff in the name.
3389      if ($fieldName =~ /--/) {      if ($fieldName =~ /--/) {
3390          # Here we have a doubled minus sign.          # Here we have a doubled minus sign.
# Line 2870  Line 3394 
3394          # Here the field name is missing the initial letter.          # Here the field name is missing the initial letter.
3395          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);
3396          $retVal = 0;          $retVal = 0;
3397        } elsif (length($fieldName) > $maxLen) {
3398            # Here the field name is too long.
3399            Trace("Maximum field name length is $maxLen. Field name must be truncated to " . substr($fieldName,0, $maxLen) . ".");
3400      } else {      } else {
3401          # Strip out the minus signs. Everything remaining must be a letter,          # Strip out the minus signs. Everything remaining must be a letter,
3402          # underscore, or digit.          # underscore, or digit.
# Line 3024  Line 3551 
3551      # Substitute the bulletin board codes.      # Substitute the bulletin board codes.
3552      $retVal =~ s!\[(/?[bi])\]!<$1>!g;      $retVal =~ s!\[(/?[bi])\]!<$1>!g;
3553      $retVal =~ s!\[p\]!</p><p>!g;      $retVal =~ s!\[p\]!</p><p>!g;
3554        $retVal =~ s!\[link\s+([^\]]+)\]!<a href="$1">!g;
3555        $retVal =~ s!\[/link\]!</a>!g;
3556        # Return the result.
3557        return $retVal;
3558    }
3559    
3560    =head3 BeginTran
3561    
3562    C<< $erdb->BeginTran(); >>
3563    
3564    Start a database transaction.
3565    
3566    =cut
3567    
3568    sub BeginTran {
3569        my ($self) = @_;
3570        $self->{_dbh}->begin_tran();
3571    
3572    }
3573    
3574    =head3 CommitTran
3575    
3576    C<< $erdb->CommitTran(); >>
3577    
3578    Commit an active database transaction.
3579    
3580    =cut
3581    
3582    sub CommitTran {
3583        my ($self) = @_;
3584        $self->{_dbh}->commit_tran();
3585    }
3586    
3587    =head3 RollbackTran
3588    
3589    C<< $erdb->RollbackTran(); >>
3590    
3591    Roll back an active database transaction.
3592    
3593    =cut
3594    
3595    sub RollbackTran {
3596        my ($self) = @_;
3597        $self->{_dbh}->roll_tran();
3598    }
3599    
3600    =head3 UpdateField
3601    
3602    C<< my $count = $erdb->UpdateField($objectNames, $fieldName, $oldValue, $newValue, $filter, $parms); >>
3603    
3604    Update all occurrences of a specific field value to a new value. The number of rows changed will be
3605    returned.
3606    
3607    =over 4
3608    
3609    =item fieldName
3610    
3611    Name of the field in standard I<objectName>C<(>I<fieldName>C<)> format.
3612    
3613    =item oldValue
3614    
3615    Value to be modified. All occurrences of this value in the named field will be replaced by the
3616    new value.
3617    
3618    =item newValue
3619    
3620    New value to be substituted for the old value when it's found.
3621    
3622    =item filter
3623    
3624    A standard ERDB filter clause (see L</Get>). The filter will be applied before any substitutions take place.
3625    
3626    =item parms
3627    
3628    Reference to a list of parameter values in the filter.
3629    
3630    =item RETURN
3631    
3632    Returns the number of rows modified.
3633    
3634    =back
3635    
3636    =cut
3637    
3638    sub UpdateField {
3639        # Get the parameters.
3640        my ($self, $fieldName, $oldValue, $newValue, $filter, $parms) = @_;
3641        # Get the object and field names from the field name parameter.
3642        $fieldName =~ /^([^(]+)\(([^)]+)\)/;
3643        my $objectName = $1;
3644        my $realFieldName = _FixName($2);
3645        # Add the old value to the filter. Note we allow the possibility that no
3646        # filter was specified.
3647        my $realFilter = "$fieldName = ?";
3648        if ($filter) {
3649            $realFilter .= " AND $filter";
3650        }
3651        # Format the query filter.
3652        my ($suffix, $mappedNameListRef, $mappedNameHashRef) =
3653            $self->_SetupSQL([$objectName], $realFilter);
3654        # Create the query. Since there is only one object name, the mapped-name data is not
3655        # necessary. Neither is the FROM clause.
3656        $suffix =~ s/^FROM.+WHERE\s+//;
3657        # Create the update statement.
3658        my $command = "UPDATE $objectName SET $realFieldName = ? WHERE $suffix";
3659        # Get the database handle.
3660        my $dbh = $self->{_dbh};
3661        # Add the old and new values to the parameter list. Note we allow the possibility that
3662        # there are no user-supplied parameters.
3663        my @params = ($newValue, $oldValue);
3664        if (defined $parms) {
3665            push @params, @{$parms};
3666        }
3667        # Execute the update.
3668        my $retVal = $dbh->SQL($command, 0, @params);
3669        # Make the funky zero a real zero.
3670        if ($retVal == 0) {
3671            $retVal = 0;
3672        }
3673      # Return the result.      # Return the result.
3674      return $retVal;      return $retVal;
3675  }  }
# Line 3184  Line 3830 
3830    
3831  =head2 Virtual Methods  =head2 Virtual Methods
3832    
3833    =head3 _CreatePPOIndex
3834    
3835    C<< my $index = ERDB::_CreatePPOIndex($indexObject); >>
3836    
3837    Convert the XML for an ERDB index to the XML structure for a PPO
3838    index.
3839    
3840    =over 4
3841    
3842    ERDB XML structure for an index.
3843    
3844    =item RETURN
3845    
3846    PPO XML structure for the same index.
3847    
3848    =back
3849    
3850    =cut
3851    
3852    sub _CreatePPOIndex {
3853        # Get the parameters.
3854        my ($indexObject) = @_;
3855        # The incoming index contains a list of the index fields in the IndexFields
3856        # member. We loop through it to create the index tags.
3857        my @fields = map { { label => _FixName($_->{name}) } } @{$indexObject->{IndexFields}};
3858        # Wrap the fields in attribute tags.
3859        my $retVal = { attribute => \@fields };
3860        # Return the result.
3861        return $retVal;
3862    }
3863    
3864    =head3 _CreatePPOField
3865    
3866    C<< my $fieldXML = ERDB::_CreatePPOField($fieldName, $fieldObject); >>
3867    
3868    Convert the ERDB XML structure for a field to a PPO scalar XML structure.
3869    
3870    =over 4
3871    
3872    =item fieldName
3873    
3874    Name of the scalar field.
3875    
3876    =item fieldObject
3877    
3878    ERDB XML structure describing the field.
3879    
3880    =item RETURN
3881    
3882    Returns a PPO XML structure for the same field.
3883    
3884    =back
3885    
3886    =cut
3887    
3888    sub _CreatePPOField {
3889        # Get the parameters.
3890        my ($fieldName, $fieldObject) = @_;
3891        # Get the field type.
3892        my $type = $TypeTable{$fieldObject->{type}}->{sqlType};
3893        # Fix up the field name.
3894        $fieldName = _FixName($fieldName);
3895        # Build the scalar tag.
3896        my $retVal = { label => $fieldName, type => $type };
3897        # Return the result.
3898        return $retVal;
3899    }
3900    
3901  =head3 CleanKeywords  =head3 CleanKeywords
3902    
3903  C<< my $cleanedString = $erdb->CleanKeywords($searchExpression); >>  C<< my $cleanedString = $erdb->CleanKeywords($searchExpression); >>
# Line 3235  Line 3949 
3949    
3950  C<< my @relationMap = _RelationMap($mappedNameHashRef, $mappedNameListRef); >>  C<< my @relationMap = _RelationMap($mappedNameHashRef, $mappedNameListRef); >>
3951    
3952  Create the relation map for an SQL query. The relation map is used by B<DBObject>  Create the relation map for an SQL query. The relation map is used by B<ERDBObject>
3953  to determine how to interpret the results of the query.  to determine how to interpret the results of the query.
3954    
3955  =over 4  =over 4
# Line 3252  Line 3966 
3966  =item RETURN  =item RETURN
3967    
3968  Returns a list of 2-tuples. Each tuple consists of an object name as used in the  Returns a list of 2-tuples. Each tuple consists of an object name as used in the
3969  query followed by the actual name of that object. This enables the B<DBObject> to  query followed by the actual name of that object. This enables the B<ERDBObject> to
3970  determine the order of the tables in the query and which object name belongs to each  determine the order of the tables in the query and which object name belongs to each
3971  mapped object name. Most of the time these two values are the same; however, if a  mapped object name. Most of the time these two values are the same; however, if a
3972  relation occurs twice in the query, the relation name in the field list and WHERE  relation occurs twice in the query, the relation name in the field list and WHERE
# Line 3795  Line 4509 
4509    
4510  =head3 _LoadMetaData  =head3 _LoadMetaData
4511    
4512    C<< my $metadata = ERDB::_LoadMetaData($filename); >>
4513    
4514  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.
4515  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
4516  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 3944  Line 4660 
4660              if ($found == 0) {              if ($found == 0) {
4661                  push @{$indexList}, { IndexFields => [ {name => 'id', order => 'ascending'} ] };                  push @{$indexList}, { IndexFields => [ {name => 'id', order => 'ascending'} ] };
4662              }              }
4663              # 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.
4664              # 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$count", $relation, $index);  
                 # Increment the counter so that the next index has a different name.  
                 $count++;  
             }  
4665          }          }
4666          # Finally, we add the relation structure to the entity.          # Finally, we add the relation structure to the entity.
4667          $entityStructure->{Relations} = $relationTable;          $entityStructure->{Relations} = $relationTable;
# Line 3968  Line 4675 
4675          _FixupFields($relationshipStructure, $relationshipName, 2, 3);          _FixupFields($relationshipStructure, $relationshipName, 2, 3);
4676          # Format a description for the FROM field.          # Format a description for the FROM field.
4677          my $fromEntity = $relationshipStructure->{from};          my $fromEntity = $relationshipStructure->{from};
4678          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].";
4679          # Get the FROM entity's key type.          # Get the FROM entity's key type.
4680          my $fromType = $entityList->{$fromEntity}->{keyType};          my $fromType = $entityList->{$fromEntity}->{keyType};
4681          # Add the FROM field.          # Add the FROM field.
# Line 3978  Line 4685 
4685                                                      PrettySort => 1});                                                      PrettySort => 1});
4686          # Format a description for the TO field.          # Format a description for the TO field.
4687          my $toEntity = $relationshipStructure->{to};          my $toEntity = $relationshipStructure->{to};
4688          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].";
4689          # Get the TO entity's key type.          # Get the TO entity's key type.
4690          my $toType = $entityList->{$toEntity}->{keyType};          my $toType = $entityList->{$toEntity}->{keyType};
4691          # Add the TO field.          # Add the TO field.
# Line 3990  Line 4697 
4697          my $thisRelation = { Fields => _ReOrderRelationTable($relationshipStructure->{Fields}),          my $thisRelation = { Fields => _ReOrderRelationTable($relationshipStructure->{Fields}),
4698                               Indexes => { } };                               Indexes => { } };
4699          $relationshipStructure->{Relations} = { $relationshipName => $thisRelation };          $relationshipStructure->{Relations} = { $relationshipName => $thisRelation };
4700    
4701            # Add the alternate indexes (if any). This MUST be done before the FROM and
4702            # TO indexes, because it erases the relation's index list.
4703            if (exists $relationshipStructure->{Indexes}) {
4704                _ProcessIndexes($relationshipStructure->{Indexes}, $thisRelation);
4705            }
4706            # Add the relation to the master table.
4707          # Create the FROM and TO indexes.          # Create the FROM and TO indexes.
4708          _CreateRelationshipIndex("From", $relationshipName, $relationshipStructure);          _CreateRelationshipIndex("From", $relationshipName, $relationshipStructure);
4709          _CreateRelationshipIndex("To", $relationshipName, $relationshipStructure);          _CreateRelationshipIndex("To", $relationshipName, $relationshipStructure);
         # Add the relation to the master table.  
4710          $masterRelationTable{$relationshipName} = $thisRelation;          $masterRelationTable{$relationshipName} = $thisRelation;
4711      }      }
4712      # Now store the master relation table in the metadata structure.      # Now store the master relation table in the metadata structure.
# Line 4152  Line 4865 
4865      _AddIndex("idx$indexKey", $relationStructure, $newIndex);      _AddIndex("idx$indexKey", $relationStructure, $newIndex);
4866  }  }
4867    
4868    =head3 _ProcessIndexes
4869    
4870    C<< ERDB::_ProcessIndexes($indexList, $relation); >>
4871    
4872    Build the data structures for the specified indexes in the specified relation.
4873    
4874    =over 4
4875    
4876    =item indexList
4877    
4878    Reference to a list of indexes. Each index is a hash reference containing an optional
4879    C<Notes> value that describes the index and an C<IndexFields> value that is a reference
4880    to a list of index field structures. An index field structure, in turn, is a reference
4881    to a hash that contains a C<name> attribute for the field name and an C<order>
4882    attribute that specifies either C<ascending> or C<descending>. In this sense the
4883    index list encapsulates the XML C<Indexes> structure in the database definition.
4884    
4885    =item relation
4886    
4887    The structure that describes the current relation. The new index descriptors will
4888    be stored in the structure's C<Indexes> member. Any previous data in the structure
4889    will be lost.
4890    
4891    =back
4892    
4893    =cut
4894    
4895    sub _ProcessIndexes {
4896        # Get the parameters.
4897        my ($indexList, $relation) = @_;
4898        # Now we need to convert the relation's index list to an index table. We begin by creating
4899        # an empty table in the relation structure.
4900        $relation->{Indexes} = { };
4901        # Loop through the indexes.
4902        my $count = 0;
4903        for my $index (@{$indexList}) {
4904            # Add this index to the index table.
4905            _AddIndex("idx$count", $relation, $index);
4906            # Increment the counter so that the next index has a different name.
4907            $count++;
4908        }
4909    }
4910    
4911  =head3 _AddIndex  =head3 _AddIndex
4912    
4913  Add an index to a relation structure.  Add an index to a relation structure.
# Line 4681  Line 5437 
5437      # Compute the number of columns.      # Compute the number of columns.
5438      my $colCount = @colNames;      my $colCount = @colNames;
5439      # Generate the title row.      # Generate the title row.
5440      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";
5441      # Loop through the columns, adding the column header rows.      # Loop through the columns, adding the column header rows.
5442      $htmlString .= "<tr>";      $htmlString .= "<tr>";
5443      for my $colName (@colNames) {      for my $colName (@colNames) {
# Line 4700  Line 5456 
5456  =cut  =cut
5457    
5458  sub _CloseTable {  sub _CloseTable {
5459      return "</table></p>\n";      return "</table>\n";
5460  }  }
5461    
5462  =head3 _ShowField  =head3 _ShowField

Legend:
Removed from v.1.77  
changed lines
  Added in v.1.92

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3