[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.70, Fri Oct 13 21:45:11 2006 UTC revision 1.74, Fri Nov 3 16:49:44 2006 UTC
# Line 11  Line 11 
11      use Time::HiRes qw(gettimeofday);      use Time::HiRes qw(gettimeofday);
12      use Digest::MD5 qw(md5_base64);      use Digest::MD5 qw(md5_base64);
13      use FIG;      use FIG;
14        use CGI;
15    
16  =head1 Entity-Relationship Database Package  =head1 Entity-Relationship Database Package
17    
# Line 59  Line 60 
60  B<start-position>, which indicates where in the contig that the sequence begins. This attribute  B<start-position>, which indicates where in the contig that the sequence begins. This attribute
61  is implemented as the C<start_position> field in the C<IsMadeUpOf> relation.  is implemented as the C<start_position> field in the C<IsMadeUpOf> relation.
62    
63  The database itself is described by an XML file using the F<ERDatabase.xsd> schema. In addition to  The database itself is described by an XML file. In addition to all the data required to define
64  all the data required to define the entities, relationships, and attributes, the schema provides  the entities, relationships, and attributes, the schema provides space for notes describing
65  space for notes describing the data and what it means. These notes are used by L</ShowMetaData>  the data and what it means. These notes are used by L</ShowMetaData> to generate documentation
66  to generate documentation for the database.  for the database.
67    
68    Special support is provided for text searching. An entity field can be marked as <em>searchable</em>,
69    in which case it will be used to generate a text search index in which the user searches for words
70    in the field instead of a particular field value.
71    
72  Finally, every entity and relationship object has a flag indicating if it is new or old. The object  Finally, every entity and relationship object has a flag indicating if it is new or old. The object
73  is considered I<old> if it was loaded by the L</LoadTables> method. It is considered I<new> if it  is considered I<old> if it was loaded by the L</LoadTables> method. It is considered I<new> if it
74  was inserted by the L</InsertObject> method.  was inserted by the L</InsertObject> method.
75    
 To facilitate testing, the ERDB module supports automatic generation of test data. This process  
 is described in the L</GenerateEntity> and L</GenerateConnection> methods, though it is not yet  
 fully implemented.  
   
76  =head2 XML Database Description  =head2 XML Database Description
77    
78  =head3 Data Types  =head3 Data Types
# Line 217  Line 218 
218  index will be created for each relation with at least one searchable field in it.  index will be created for each relation with at least one searchable field in it.
219  For best results, this option should only be used for string or text fields.  For best results, this option should only be used for string or text fields.
220    
221    =item special
222    
223    This attribute allows the subclass to assign special meaning for certain fields.
224    The interpretation is up to the subclass itself. Currently, only entity fields
225    can have this attribute.
226    
227  =back  =back
228    
229  =head3 Indexes  =head3 Indexes
230    
231  An entity can have multiple alternate indexes associated with it. The fields must  An entity can have multiple alternate indexes associated with it. The fields must
232  be from the primary relation. The alternate indexes assist in ordering results  all be from the same relation. The alternate indexes assist in ordering results
233  from a query. A relationship can have up to two indexes-- a I<to-index> and a  from a query. A relationship can have up to two indexes-- a I<to-index> and a
234  I<from-index>. These order the results when crossing the relationship. For  I<from-index>. These order the results when crossing the relationship. For
235  example, in the relationship C<HasContig> from C<Genome> to C<Contig>, the  example, in the relationship C<HasContig> from C<Genome> to C<Contig>, the
# Line 328  Line 335 
335    
336  # 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.
337  # "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
338  # of the specified type. "dataGen" is PERL string that will be evaluated if no test data generation  # of the specified type. "avgLen" is the average byte length for estimating
339  # string is specified in the field definition. "avgLen" is the average byte length for estimating  # record sizes. "sort" is the key modifier for the sort command, "notes" is a type description.
340  # record sizes. "sort" is the key modifier for the sort command.  my %TypeTable = ( char =>    { sqlType => 'CHAR(1)',            maxLen => 1,            avgLen =>   1, sort => "",
341  my %TypeTable = ( char =>    { sqlType => 'CHAR(1)',            maxLen => 1,            avgLen =>   1, sort => "",  dataGen => "StringGen('A')" },                                 notes => "single ASCII character"},
342                    int =>     { sqlType => 'INTEGER',            maxLen => 20,           avgLen =>   4, sort => "n", dataGen => "IntGen(0, 99999999)" },                    int =>     { sqlType => 'INTEGER',            maxLen => 20,           avgLen =>   4, sort => "n",
343                    counter => { sqlType => 'INTEGER UNSIGNED',   maxLen => 20,           avgLen =>   4, sort => "n", dataGen => "IntGen(0, 99999999)" },                                 notes => "signed 32-bit integer"},
344                    string =>  { sqlType => 'VARCHAR(255)',       maxLen => 255,          avgLen => 100, sort => "",  dataGen => "StringGen(IntGen(10,250))" },                    counter => { sqlType => 'INTEGER UNSIGNED',   maxLen => 20,           avgLen =>   4, sort => "n",
345                    text =>    { sqlType => 'TEXT',               maxLen => 1000000000,   avgLen => 500, sort => "",  dataGen => "StringGen(IntGen(80,1000))" },                                 notes => "unsigned 32-bit integer"},
346                    date =>    { sqlType => 'BIGINT',             maxLen => 80,           avgLen =>   8, sort => "n", dataGen => "DateGen(-7, 7, IntGen(0,1400))" },                    string =>  { sqlType => 'VARCHAR(255)',       maxLen => 255,          avgLen => 100, sort => "",
347                    float =>   { sqlType => 'DOUBLE PRECISION',   maxLen => 40,           avgLen =>   8, sort => "g", dataGen => "FloatGen(0.0, 100.0)" },                                 notes => "character string, 0 to 255 characters"},
348                    boolean => { sqlType => 'SMALLINT',           maxLen => 1,            avgLen =>   1, sort => "n", dataGen => "IntGen(0, 1)" },                    text =>    { sqlType => 'TEXT',               maxLen => 1000000000,   avgLen => 500, sort => "",
349                                   notes => "character string, nearly unlimited length, cannot be indexed"},
350                      date =>    { sqlType => 'BIGINT',             maxLen => 80,           avgLen =>   8, sort => "n",
351                                   notes => "signed, 64-bit integer"},
352                      float =>   { sqlType => 'DOUBLE PRECISION',   maxLen => 40,           avgLen =>   8, sort => "g",
353                                   notes => "64-bit double precision floating-point number"},
354                      boolean => { sqlType => 'SMALLINT',           maxLen => 1,            avgLen =>   1, sort => "n",
355                                   notes => "boolean value: 0 if false, 1 if true"},
356                   'hash-string' =>                   'hash-string' =>
357                               { sqlType => 'VARCHAR(22)',        maxLen => 22,           avgLen =>  22, sort => "",  dataGen => "SringGen(22)" },                               { sqlType => 'VARCHAR(22)',        maxLen => 22,           avgLen =>  22, sort => "",
358                                   notes => "string stored in digested form, used for certain types of key fields"},
359                   'id-string' =>                   'id-string' =>
360                               { sqlType => 'VARCHAR(25)',        maxLen => 25,           avgLen =>  25, sort => "",  dataGen => "SringGen(22)" },                               { sqlType => 'VARCHAR(25)',        maxLen => 25,           avgLen =>  25, sort => "",
361                                   notes => "character string, 0 to 25 characters"},
362                   'key-string' =>                   'key-string' =>
363                               { sqlType => 'VARCHAR(40)',        maxLen => 40,           avgLen =>  10, sort => "",  dataGen => "StringGen(IntGen(10,40))" },                               { sqlType => 'VARCHAR(40)',        maxLen => 40,           avgLen =>  10, sort => "",
364                                   notes => "character string, 0 to 40 characters"},
365                   'name-string' =>                   'name-string' =>
366                               { sqlType => 'VARCHAR(80)',        maxLen => 80,           avgLen =>  40, sort => "",  dataGen => "StringGen(IntGen(10,80))" },                               { sqlType => 'VARCHAR(80)',        maxLen => 80,           avgLen =>  40, sort => "",
367                                   notes => "character string, 0 to 80 characters"},
368                   'medium-string' =>                   'medium-string' =>
369                               { sqlType => 'VARCHAR(160)',       maxLen => 160,          avgLen =>  40, sort => "",  dataGen => "StringGen(IntGen(10,160))" },                               { sqlType => 'VARCHAR(160)',       maxLen => 160,          avgLen =>  40, sort => "",
370                                   notes => "character string, 0 to 160 characters"},
371                  );                  );
372    
373  # Table translating arities into natural language.  # Table translating arities into natural language.
# Line 357  Line 376 
376                     'MM' => 'many-to-many'                     'MM' => 'many-to-many'
377                   );                   );
378    
379  # Table for interpreting string patterns.  # Options for XML input and output.
380    
381    my %XmlOptions = (GroupTags =>  { Relationships => 'Relationship',
382                                      Entities => 'Entity',
383                                      Fields => 'Field',
384                                      Indexes => 'Index',
385                                      IndexFields => 'IndexField'
386                                    },
387                      KeyAttr =>    { Relationship => 'name',
388                                      Entity => 'name',
389                                      Field => 'name'
390                                    },
391                      SuppressEmpty => 1,
392                     );
393    
394  my %PictureTable = ( 'A' => "abcdefghijklmnopqrstuvwxyz",  my %XmlInOpts  = (
395                       '9' => "0123456789",                    ForceArray => ['Field', 'Index', 'IndexField'],
396                       'X' => "abcdefghijklmnopqrstuvwxyz0123456789",                    ForceContent => 1,
397                       'V' => "aeiou",                    NormalizeSpace => 2,
                      'K' => "bcdfghjklmnoprstvwxyz"  
398                     );                     );
399    my %XmlOutOpts = (
400                      RootName => 'Database',
401                      XMLDecl => 1,
402                     );
403    
404    
405  =head2 Public Methods  =head2 Public Methods
406    
# Line 506  Line 542 
542          my $entityData = $entityList->{$key};          my $entityData = $entityList->{$key};
543          # If there's descriptive text, display it.          # If there's descriptive text, display it.
544          if (my $notes = $entityData->{Notes}) {          if (my $notes = $entityData->{Notes}) {
545              $retVal .= "<p>" . _HTMLNote($notes->{content}) . "</p>\n";              $retVal .= "<p>" . HTMLNote($notes->{content}) . "</p>\n";
546          }          }
547          # Now we want a list of the entity's relationships. First, we set up the relationship subsection.          # Now we want a list of the entity's relationships. First, we set up the relationship subsection.
548          $retVal .= "<h4>Relationships for <b>$key</b></h4>\n<ul>\n";          $retVal .= "<h4>Relationships for <b>$key</b></h4>\n<ul>\n";
# Line 563  Line 599 
599          $retVal .= "</p>\n";          $retVal .= "</p>\n";
600          # If there are notes on this relationship, display them.          # If there are notes on this relationship, display them.
601          if (my $notes = $relationshipStructure->{Notes}) {          if (my $notes = $relationshipStructure->{Notes}) {
602              $retVal .= "<p>" . _HTMLNote($notes->{content}) . "</p>\n";              $retVal .= "<p>" . HTMLNote($notes->{content}) . "</p>\n";
603          }          }
604          # Generate the relationship's relation table.          # Generate the relationship's relation table.
605          my $htmlString = _ShowRelationTable($key, $relationshipStructure->{Relations}->{$key});          my $htmlString = _ShowRelationTable($key, $relationshipStructure->{Relations}->{$key});
# Line 610  Line 646 
646      return Data::Dumper::Dumper($self->{_metaData});      return Data::Dumper::Dumper($self->{_metaData});
647  }  }
648    
649    =head3 FindIndexForEntity
650    
651    C<< my $indexFound = ERDB::FindIndexForEntity($xml, $entityName, $attributeName); >>
652    
653    This method locates the entry in an entity's index list that begins with the
654    specified attribute name. If the entity has no index list, one will be
655    created. This method works on raw XML, not a live ERDB object.
656    
657    =over 4
658    
659    =item xml
660    
661    The raw XML structure defining the database.
662    
663    =item entityName
664    
665    The name of the relevant entity.
666    
667    =item attributeName
668    
669    The name of the attribute relevant to the search.
670    
671    =item RETURN
672    
673    The numerical index in the index list of the index entry for the specified entity and
674    attribute, or C<undef> if no such index exists.
675    
676    =back
677    
678    =cut
679    
680    sub FindIndexForEntity {
681        # Get the parameters.
682        my ($xml, $entityName, $attributeName) = @_;
683        # Declare the return variable.
684        my $retVal;
685        # Get the named entity.
686        my $entityData = $xml->{Entities}->{$entityName};
687        if (! $entityData) {
688            Confess("Entity $entityName not found in DBD structure.");
689        } else {
690            # Insure it has an index list.
691            if (! exists $entityData->{Indexes}) {
692                $entityData->{Indexes} = [];
693            } else {
694                # Search for the desired index.
695                my $indexList = $entityData->{Indexes};
696                my $n = scalar @{$indexList};
697                Trace("Searching $n indexes in index list for $entityName.") if T(2);
698                # We use an indexed FOR here because we're returning an
699                # index number instead of an object. We do THAT so we can
700                # delete the index from the list if needed.
701                for (my $i = 0; $i < $n && !defined($retVal); $i++) {
702                    my $index = $indexList->[$i];
703                    my $fields = $index->{IndexFields};
704                    # Technically this IF should be safe (that is, we are guaranteed
705                    # the existence of a "$fields->[0]"), because when we load the XML
706                    # we have SuppressEmpty specified.
707                    if ($fields->[0]->{name} eq $attributeName) {
708                        $retVal = $i;
709                    }
710                }
711            }
712        }
713        Trace("Index for $attributeName of $entityName found at position $retVal.") if defined($retVal) && T(3);
714        Trace("Index for $attributeName not found in $entityName.") if !defined($retVal) && T(3);
715        # Return the result.
716        return $retVal;
717    }
718    
719  =head3 CreateTables  =head3 CreateTables
720    
721  C<< $erdb->CreateTables(); >>  C<< $erdb->CreateTables(); >>
# Line 964  Line 1070 
1070      return sort keys %{$entityList};      return sort keys %{$entityList};
1071  }  }
1072    
1073    =head3 GetDataTypes
1074    
1075    C<< my %types = ERDB::GetDataTypes(); >>
1076    
1077    Return a table of ERDB data types. The table returned is a hash of hashes.
1078    The keys of the big hash are the datatypes. Each smaller hash has several
1079    values used to manage the data. The most interesting is the SQL type (key
1080    C<sqlType>) and the descriptive node (key C<notes>).
1081    
1082    Note that changing the values in the smaller hashes will seriously break
1083    things, so this data should be treated as read-only.
1084    
1085    =cut
1086    
1087    sub GetDataTypes {
1088        return %TypeTable;
1089    }
1090    
1091    
1092  =head3 IsEntity  =head3 IsEntity
1093    
1094  C<< my $flag = $erdb->IsEntity($entityName); >>  C<< my $flag = $erdb->IsEntity($entityName); >>
# Line 1158  Line 1283 
1283      my ($self, $searchExpression, $idx, $objectNames, $filterClause, $params) = @_;      my ($self, $searchExpression, $idx, $objectNames, $filterClause, $params) = @_;
1284      # Declare the return variable.      # Declare the return variable.
1285      my $retVal;      my $retVal;
1286      # Create a safety copy of the parameter list.      # Create a safety copy of the parameter list. Note we have to be careful to insure
1287      my @myParams = @{$params};      # a parameter list exists before we copy it.
1288        my @myParams = ();
1289        if (defined $params) {
1290            @myParams = @{$params};
1291        }
1292      # Get the first object's structure so we have access to the searchable fields.      # Get the first object's structure so we have access to the searchable fields.
1293      my $object1Name = $objectNames->[$idx];      my $object1Name = $objectNames->[$idx];
1294      my $object1Structure = $self->_GetStructure($object1Name);      my $object1Structure = $self->_GetStructure($object1Name);
# Line 1169  Line 1298 
1298      } else {      } else {
1299          # Get the field list.          # Get the field list.
1300          my @fields = @{$object1Structure->{searchFields}};          my @fields = @{$object1Structure->{searchFields}};
1301            # Clean the search expression.
1302            my $actualKeywords = $self->CleanKeywords($searchExpression);
1303            Trace("Actual keywords for search are\n$actualKeywords") if T(3);
1304          # 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
1305          # 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
1306          # search expression onto the front of the parameter list twice.          # search expression onto the front of the parameter list twice.
1307          unshift @myParams, $searchExpression, $searchExpression;          unshift @myParams, $actualKeywords, $actualKeywords;
1308          # Build the match expression.          # Build the match expression.
1309          my @matchFilterFields = map { "$object1Name." . _FixName($_) } @fields;          my @matchFilterFields = map { "$object1Name." . _FixName($_) } @fields;
1310          my $matchClause = "MATCH (" . join(", ", @matchFilterFields) . ") AGAINST (? IN BOOLEAN MODE)";          my $matchClause = "MATCH (" . join(", ", @matchFilterFields) . ") AGAINST (? IN BOOLEAN MODE)";
# Line 1246  Line 1378 
1378      return @retVal;      return @retVal;
1379  }  }
1380    
1381    =head3 SpecialFields
1382    
1383    C<< my %specials = $erdb->SpecialFields($entityName); >>
1384    
1385    Return a hash mapping special fields in the specified entity to the value of their
1386    C<special> attribute. This enables the subclass to get access to the special field
1387    attributes without needed to plumb the internal ERDB data structures.
1388    
1389    =over 4
1390    
1391    =item entityName
1392    
1393    Name of the entity whose special fields are desired.
1394    
1395    =item RETURN
1396    
1397    Returns a hash. The keys of the hash are the special field names, and the values
1398    are the values from each special field's C<special> attribute.
1399    
1400    =back
1401    
1402    =cut
1403    
1404    sub SpecialFields {
1405        # Get the parameters.
1406        my ($self, $entityName) = @_;
1407        # Declare the return variable.
1408        my %retVal = ();
1409        # Find the entity's data structure.
1410        my $entityData = $self->{Entities}->{$entityName};
1411        # Loop through its fields, adding each special field to the return hash.
1412        my $fieldHash = $entityData->{Fields};
1413        for my $fieldName (keys %{$fieldHash}) {
1414            my $fieldData = $fieldHash->{$fieldName};
1415            if (exists $fieldData->{special}) {
1416                $retVal{$fieldName} = $fieldData->{special};
1417            }
1418        }
1419        # Return the result.
1420        return %retVal;
1421    }
1422    
1423  =head3 Delete  =head3 Delete
1424    
1425  C<< my $stats = $erdb->Delete($entityName, $objectID); >>  C<< my $stats = $erdb->Delete($entityName, $objectID); >>
# Line 2016  Line 2190 
2190      };      };
2191      if (!defined $rv) {      if (!defined $rv) {
2192          $retVal->AddMessage($@) if ($@);          $retVal->AddMessage($@) if ($@);
2193          $retVal->AddMessage("Table load failed for $relationName using $fileName.");          $retVal->AddMessage("Table load failed for $relationName using $fileName: " . $dbh->error_message);
2194          Trace("Table load failed for $relationName.") if T(1);          Trace("Table load failed for $relationName.") if T(1);
2195      } else {      } else {
2196          # Here we successfully loaded the table.          # Here we successfully loaded the table.
# Line 2061  Line 2235 
2235      return $retVal;      return $retVal;
2236  }  }
2237    
2238  =head3 GenerateEntity  =head3 DropRelation
   
 C<< my $fieldHash = $erdb->GenerateEntity($id, $type, \%values); >>  
2239    
2240  Generate the data for a new entity instance. This method creates a field hash suitable for  C<< $erdb->DropRelation($relationName); >>
 passing as a parameter to L</InsertObject>. The ID is specified by the callr, but the rest  
 of the fields are generated using information in the database schema.  
2241    
2242  Each data type has a default algorithm for generating random test data. This can be overridden  Physically drop a relation from the database.
 by including a B<DataGen> element in the field. If this happens, the content of the element is  
 executed as a PERL program in the context of this module. The element may make use of a C<$this>  
 variable which contains the field hash as it has been built up to the current point. If any  
 fields are dependent on other fields, the C<pass> attribute can be used to control the order  
 in which the fields are generated. A field with a high data pass number will be generated after  
 a field with a lower one. If any external values are needed, they should be passed in via the  
 optional third parameter, which will be available to the data generation script under the name  
 C<$value>. Several useful utility methods are provided for generating random values, including  
 L</IntGen>, L</StringGen>, L</FloatGen>, and L</DateGen>. Note that dates are stored and generated  
 in the form of a timestamp number rather than a string.  
2243    
2244  =over 4  =over 4
2245    
2246  =item id  =item relationName
   
 ID to assign to the new entity.  
   
 =item type  
   
 Type name for the new entity.  
   
 =item values  
2247    
2248  Hash containing additional values that might be needed by the data generation methods (optional).  Name of the relation to drop. If it does not exist, this method will have
2249    no effect.
2250    
2251  =back  =back
2252    
2253  =cut  =cut
2254    
2255  sub GenerateEntity {  sub DropRelation {
2256      # Get the parameters.      # Get the parameters.
2257      my ($self, $id, $type, $values) = @_;      my ($self, $relationName) = @_;
2258      # Create the return hash.      # Get the database handle.
2259      my $this = { id => $id };      my $dbh = $self->{_dbh};
2260      # Get the metadata structure.      # Drop the relation. The method used here has no effect if the relation
2261      my $metadata = $self->{_metaData};      # does not exist.
2262      # Get this entity's list of fields.      Trace("Invoking DB Kernel to drop $relationName.") if T(3);
2263      if (!exists $metadata->{Entities}->{$type}) {      $dbh->drop_table(tbl => $relationName);
         Confess("Unrecognized entity type $type in GenerateEntity.");  
     } else {  
         my $entity = $metadata->{Entities}->{$type};  
         my $fields = $entity->{Fields};  
         # Generate data from the fields.  
         _GenerateFields($this, $fields, $type, $values);  
     }  
     # Return the hash created.  
     return $this;  
2264  }  }
2265    
2266  =head3 GetEntity  =head3 GetEntity
# Line 2450  Line 2594 
2594      return $objectData->{Fields};      return $objectData->{Fields};
2595  }  }
2596    
2597    =head3 SplitKeywords
2598    
2599    C<< my @keywords = ERDB::SplitKeywords($keywordString); >>
2600    
2601    This method returns a list of the positive keywords in the specified
2602    keyword string. All of the operators will have been stripped off,
2603    and if the keyword is preceded by a minus operator (C<->), it will
2604    not be in the list returned. The idea here is to get a list of the
2605    keywords the user wants to see. The list will be processed to remove
2606    duplicates.
2607    
2608    It is possible to create a string that confuses this method. For example
2609    
2610        frog toad -frog
2611    
2612    would return both C<frog> and C<toad>. If this is a problem we can deal
2613    with it later.
2614    
2615    =over 4
2616    
2617    =item keywordString
2618    
2619    The keyword string to be parsed.
2620    
2621    =item RETURN
2622    
2623    Returns a list of the words in the keyword string the user wants to
2624    see.
2625    
2626    =back
2627    
2628    =cut
2629    
2630    sub SplitKeywords {
2631        # Get the parameters.
2632        my ($keywordString) = @_;
2633        # Make a safety copy of the string. (This helps during debugging.)
2634        my $workString = $keywordString;
2635        # Convert operators we don't care about to spaces.
2636        $workString =~ tr/+"()<>/ /;
2637        # Split the rest of the string along space boundaries. Note that we
2638        # eliminate any words that are zero length or begin with a minus sign.
2639        my @wordList = grep { $_ && substr($_, 0, 1) ne "-" } split /\s+/, $workString;
2640        # Use a hash to remove duplicates.
2641        my %words = map { $_ => 1 } @wordList;
2642        # Return the result.
2643        return sort keys %words;
2644    }
2645    
2646    =head3 ValidateFieldName
2647    
2648    C<< my $okFlag = ERDB::ValidateFieldName($fieldName); >>
2649    
2650    Return TRUE if the specified field name is valid, else FALSE. Valid field names must
2651    be hyphenated words subject to certain restrictions.
2652    
2653    =over 4
2654    
2655    =item fieldName
2656    
2657    Field name to be validated.
2658    
2659    =item RETURN
2660    
2661    Returns TRUE if the field name is valid, else FALSE.
2662    
2663    =back
2664    
2665    =cut
2666    
2667    sub ValidateFieldName {
2668        # Get the parameters.
2669        my ($fieldName) = @_;
2670        # Declare the return variable. The field name is valid until we hear
2671        # differently.
2672        my $retVal = 1;
2673        # Look for bad stuff in the name.
2674        if ($fieldName =~ /--/) {
2675            # Here we have a doubled minus sign.
2676            Trace("Field name $fieldName has a doubled hyphen.") if T(1);
2677            $retVal = 0;
2678        } elsif ($fieldName !~ /^[A-Za-z]/) {
2679            # Here the field name is missing the initial letter.
2680            Trace("Field name $fieldName does not begin with a letter.") if T(1);
2681            $retVal = 0;
2682        } else {
2683            # Strip out the minus signs. Everything remaining must be a letter
2684            # or digit.
2685            my $strippedName = $fieldName;
2686            $strippedName =~ s/-//g;
2687            if ($strippedName !~ /^[A-Za-z0-9]+$/) {
2688                Trace("Field name $fieldName contains illegal characters.") if T(1);
2689                $retVal = 0;
2690            }
2691        }
2692        # Return the result.
2693        return $retVal;
2694    }
2695    
2696    =head3 ReadMetaXML
2697    
2698    C<< my $rawMetaData = ERDB::ReadDBD($fileName); >>
2699    
2700    This method reads a raw database definition XML file and returns it.
2701    Normally, the metadata used by the ERDB system has been processed and
2702    modified to make it easier to load and retrieve the data; however,
2703    this method can be used to get the data in its raw form.
2704    
2705    =over 4
2706    
2707    =item fileName
2708    
2709    Name of the XML file to read.
2710    
2711    =item RETURN
2712    
2713    Returns a hash reference containing the raw XML data from the specified file.
2714    
2715    =back
2716    
2717    =cut
2718    
2719    sub ReadMetaXML {
2720        # Get the parameters.
2721        my ($fileName) = @_;
2722        # Read the XML.
2723        my $retVal = XML::Simple::XMLin($fileName, %XmlOptions, %XmlInOpts);
2724        Trace("XML metadata loaded from file $fileName.") if T(1);
2725        # Return the result.
2726        return $retVal;
2727    }
2728    
2729    =head3 GetEntityFieldHash
2730    
2731    C<< my $fieldHashRef = ERDB::GetEntityFieldHash($structure, $entityName); >>
2732    
2733    Get the field hash of the named entity in the specified raw XML structure.
2734    The field hash may not exist, in which case we need to create it.
2735    
2736    =over 4
2737    
2738    =item structure
2739    
2740    Raw XML structure defininng the database. This is not the run-time XML used by
2741    an ERDB object, since that has all sorts of optimizations built-in.
2742    
2743    =item entityName
2744    
2745    Name of the entity whose field structure is desired.
2746    
2747    =item RETURN
2748    
2749    Returns the field hash used to define the entity's fields.
2750    
2751    =back
2752    
2753    =cut
2754    
2755    sub GetEntityFieldHash {
2756        # Get the parameters.
2757        my ($structure, $entityName) = @_;
2758        # Get the entity structure.
2759        my $entityData = $structure->{Entities}->{$entityName};
2760        # Look for a field structure.
2761        my $retVal = $entityData->{Fields};
2762        # If it doesn't exist, create it.
2763        if (! defined($retVal)) {
2764            $entityData->{Fields} = {};
2765            $retVal = $entityData->{Fields};
2766        }
2767        # Return the result.
2768        return $retVal;
2769    }
2770    
2771    =head3 WriteMetaXML
2772    
2773    C<< ERDB::WriteMetaXML($structure, $fileName); >>
2774    
2775    Write the metadata XML to a file. This method is the reverse of L</ReadMetaXML>, and is
2776    used to update the database definition. It must be used with care, however, since it
2777    will only work on a raw structure, not on the processed structure created by an ERDB
2778    constructor.
2779    
2780    =over 4
2781    
2782    =item structure
2783    
2784    XML structure to be written to the file.
2785    
2786    =item fileName
2787    
2788    Name of the output file to which the updated XML should be stored.
2789    
2790    =back
2791    
2792    =cut
2793    
2794    sub WriteMetaXML {
2795        # Get the parameters.
2796        my ($structure, $fileName) = @_;
2797        # Compute the output.
2798        my $fileString = XML::Simple::XMLout($structure, %XmlOptions, %XmlOutOpts);
2799        # Write it to the file.
2800        my $xmlOut = Open(undef, ">$fileName");
2801        print $xmlOut $fileString;
2802    }
2803    
2804    
2805    =head3 HTMLNote
2806    
2807    Convert a note or comment to HTML by replacing some bulletin-board codes with HTML. The codes
2808    supported are C<[b]> for B<bold>, C<[i]> for I<italics>, and C<[p]> for a new paragraph.
2809    Except for C<[p]>, all the codes are closed by slash-codes. So, for
2810    example, C<[b]Feature[/b]> displays the string C<Feature> in boldface.
2811    
2812    C<< my $realHtml = ERDB::HTMLNote($dataString); >>
2813    
2814    =over 4
2815    
2816    =item dataString
2817    
2818    String to convert to HTML.
2819    
2820    =item RETURN
2821    
2822    An HTML string derived from the input string.
2823    
2824    =back
2825    
2826    =cut
2827    
2828    sub HTMLNote {
2829        # Get the parameter.
2830        my ($dataString) = @_;
2831        # HTML-escape the text.
2832        my $retVal = CGI::escapeHTML($dataString);
2833        # Substitute the bulletin board codes.
2834        $retVal =~ s!\[(/?[bi])\]!<$1>!g;
2835        $retVal =~ s!\[p\]!</p><p>!g;
2836        # Return the result.
2837        return $retVal;
2838    }
2839    
2840    
2841  =head2 Data Mining Methods  =head2 Data Mining Methods
2842    
2843  =head3 GetUsefulCrossValues  =head3 GetUsefulCrossValues
# Line 2603  Line 2991 
2991      return @retVal;      return @retVal;
2992  }  }
2993    
2994  =head2 Internal Utility Methods  =head2 Virtual Methods
2995    
2996  =head3 _RelationMap  =head3 CleanKeywords
2997    
2998  C<< my @relationMap = _RelationMap($mappedNameHashRef, $mappedNameListRef); >>  C<< my $cleanedString = $erdb->CleanKeywords($searchExpression); >>
2999    
3000  Create the relation map for an SQL query. The relation map is used by B<DBObject>  Clean up a search expression or keyword list. This is a virtual method that may
3001  to determine how to interpret the results of the query.  be overridden by the subclass. The base-class method removes extra spaces
3002    and converts everything to lower case.
3003    
3004  =over 4  =over 4
3005    
3006  =item mappedNameHashRef  =item searchExpression
3007    
3008  Reference to a hash that maps modified object names to real object names.  Search expression or keyword list to clean. Note that a search expression may
3009    contain boolean operators which need to be preserved. This includes leading
3010    minus signs.
3011    
3012  =item mappedNameListRef  =item RETURN
3013    
3014    Cleaned expression or keyword list.
3015    
3016    =back
3017    
3018    =cut
3019    
3020    sub CleanKeywords {
3021        # Get the parameters.
3022        my ($self, $searchExpression) = @_;
3023        # Lower-case the expression and copy it into the return variable. Note that we insure we
3024        # don't accidentally end up with an undefined value.
3025        my $retVal = lc($searchExpression || "");
3026        # Remove extra spaces.
3027        $retVal =~ s/\s+/ /g;
3028        $retVal =~ s/(^\s+)|(\s+$)//g;
3029        # Return the result.
3030        return $retVal;
3031    }
3032    
3033    =head3 GetSourceObject
3034    
3035    C<< my $source = $erdb->GetSourceObject($entityName); >>
3036    
3037    Return the object to be used in loading special attributes of the specified entity. The
3038    algorithm for loading special attributes is stored in the C<DataGen> elements of the
3039    XML
3040    
3041    =head2 Internal Utility Methods
3042    
3043    =head3 _RelationMap
3044    
3045    C<< my @relationMap = _RelationMap($mappedNameHashRef, $mappedNameListRef); >>
3046    
3047    Create the relation map for an SQL query. The relation map is used by B<DBObject>
3048    to determine how to interpret the results of the query.
3049    
3050    =over 4
3051    
3052    =item mappedNameHashRef
3053    
3054    Reference to a hash that maps modified object names to real object names.
3055    
3056    =item mappedNameListRef
3057    
3058  Reference to a list of modified object names in the order they appear in the  Reference to a list of modified object names in the order they appear in the
3059  SELECT list.  SELECT list.
# Line 2945  Line 3380 
3380      return Stats->new();      return Stats->new();
3381  }  }
3382    
 =head3 _GenerateFields  
   
 Generate field values from a field structure and store in a specified table. The field names  
 are first sorted by pass count, certain pre-defined fields are removed from the list, and  
 then we rip through them evaluation the data generation string. Fields in the primary relation  
 are stored as scalars; fields in secondary relations are stored as value lists.  
   
 This is a static method.  
   
 =over 4  
   
 =item this  
   
 Hash table into which the field values should be placed.  
   
 =item fields  
   
 Field structure from which the field descriptors should be taken.  
   
 =item type  
   
 Type name of the object whose fields are being generated.  
   
 =item values (optional)  
   
 Reference to a value structure from which additional values can be taken.  
   
 =item from (optiona)  
   
 Reference to the source entity instance if relationship data is being generated.  
   
 =item to (optional)  
   
 Reference to the target entity instance if relationship data is being generated.  
   
 =back  
   
 =cut  
   
 sub _GenerateFields {  
     # Get the parameters.  
     my ($this, $fields, $type, $values, $from, $to) = @_;  
     # Sort the field names by pass number.  
     my @fieldNames = sort { $fields->{$a}->{DataGen}->{pass} <=> $fields->{$b}->{DataGen}->{pass} } keys %{$fields};  
     # Loop through the field names, generating data.  
     for my $name (@fieldNames) {  
         # Only proceed if this field needs to be generated.  
         if (!exists $this->{$name}) {  
             # Get this field's data generation descriptor.  
             my $fieldDescriptor = $fields->{$name};  
             my $data = $fieldDescriptor->{DataGen};  
             # Get the code to generate the field value.  
             my $codeString = $data->{content};  
             # Determine whether or not this field is in the primary relation.  
             if ($fieldDescriptor->{relation} eq $type) {  
                 # Here we have a primary relation field. Store the field value as  
                 # a scalar.  
                 $this->{$name} = eval($codeString);  
             } else {  
                 # Here we have a secondary relation field. Create a null list  
                 # and push the desired number of field values onto it.  
                 my @fieldValues = ();  
                 my $count = IntGen(0,$data->{testCount});  
                 for (my $i = 0; $i < $count; $i++) {  
                     my $newValue = eval($codeString);  
                     push @fieldValues, $newValue;  
                 }  
                 # Store the value list in the main hash.  
                 $this->{$name} = \@fieldValues;  
             }  
         }  
     }  
 }  
   
3383  =head3 _DumpRelation  =head3 _DumpRelation
3384    
3385  Dump the specified relation's to the specified output file in tab-delimited format.  Dump the specified relation to the specified output file in tab-delimited format.
3386    
3387  This is an instance method.  This is an instance method.
3388    
# Line 3166  Line 3527 
3527          for my $object (values %{$metadata->{$section}}) {          for my $object (values %{$metadata->{$section}}) {
3528              # Loop through the object's fields.              # Loop through the object's fields.
3529              for my $fieldName (keys %{$object->{Fields}}) {              for my $fieldName (keys %{$object->{Fields}}) {
3530                  # Now we make some initial validations.                  # If this field name is invalid, set the return value to zero
3531                  if ($fieldName =~ /--/) {                  # so we know we encountered an error.
3532                      # Here we have a doubled minus sign.                  if (! ValidateFieldName($fieldName)) {
                     print STDERR "Field name $fieldName has a doubled hyphen.\n";  
                     $retVal = 0;  
                 } elsif ($fieldName !~ /^[A-Za-z]/) {  
                     # Here the field name is missing the initial letter.  
                     print STDERR "Field name $fieldName does not begin with a letter.\n";  
                     $retVal = 0;  
                 } else {  
                     # Strip out the minus signs. Everything remaining must be a letter  
                     # or digit.  
                     my $strippedName = $fieldName;  
                     $strippedName =~ s/-//g;  
                     if ($strippedName !~ /^[A-Za-z0-9]+$/) {  
                         print STDERR "Field name $fieldName contains illegal characters.\n";  
3533                          $retVal = 0;                          $retVal = 0;
3534                      }                      }
3535                  }                  }
3536              }              }
3537          }          }
     }  
3538      # If an error was found, fail.      # If an error was found, fail.
3539      if ($retVal  == 0) {      if ($retVal  == 0) {
3540          Confess("Errors found in field names.");          Confess("Errors found in field names.");
# Line 3254  Line 3601 
3601      return $retVal;      return $retVal;
3602  }  }
3603    
3604    
3605  =head3 _LoadMetaData  =head3 _LoadMetaData
3606    
3607  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.
# Line 3282  Line 3630 
3630      Trace("Reading Sprout DBD from $filename.") if T(2);      Trace("Reading Sprout DBD from $filename.") if T(2);
3631      # 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
3632      # get the exact structure we want.      # get the exact structure we want.
3633      my $metadata = XML::Simple::XMLin($filename,      my $metadata = ReadMetaXML($filename);
                                       GroupTags => { Relationships => 'Relationship',  
                                                      Entities => 'Entity',  
                                                      Fields => 'Field',  
                                                      Indexes => 'Index',  
                                                      IndexFields => 'IndexField'},  
                                       KeyAttr => { Relationship => 'name',  
                                                    Entity => 'name',  
                                                    Field => 'name'},  
                                       ForceArray => ['Field', 'Index', 'IndexField'],  
                                       ForceContent => 1,  
                                       NormalizeSpace => 2  
                                       );  
     Trace("XML metadata loaded from file $filename.") if T(1);  
3634      # Before we go any farther, we need to validate the field and object names. If an error is found,      # Before we go any farther, we need to validate the field and object names. If an error is found,
3635      # the method below will fail.      # the method below will fail.
3636      _ValidateFieldNames($metadata);      _ValidateFieldNames($metadata);
# Line 3722  Line 4057 
4057              my $type = $fieldData->{type};              my $type = $fieldData->{type};
4058              # Plug in a relation name if it is needed.              # Plug in a relation name if it is needed.
4059              Tracer::MergeOptions($fieldData, { relation => $defaultRelationName });              Tracer::MergeOptions($fieldData, { relation => $defaultRelationName });
             # Plug in a data generator if we need one.  
             if (!exists $fieldData->{DataGen}) {  
                 # The data generator will use the default for the field's type.  
                 $fieldData->{DataGen} = { content => $TypeTable{$type}->{dataGen} };  
             }  
4060              # Check for searchability.              # Check for searchability.
4061              if ($fieldData->{searchable}) {              if ($fieldData->{searchable}) {
4062                  # Only allow this for a primary relation.                  # Only allow this for a primary relation.
# Line 3736  Line 4066 
4066                      push @textFields, $fieldName;                      push @textFields, $fieldName;
4067                  }                  }
4068              }              }
             # Plug in the defaults for the optional data generation parameters.  
             Tracer::MergeOptions($fieldData->{DataGen}, { testCount => 1, pass => 0 });  
4069              # Add the PrettySortValue.              # Add the PrettySortValue.
4070              $fieldData->{PrettySort} = (($type eq "text") ? $textPrettySortValue : $prettySortValue);              $fieldData->{PrettySort} = (($type eq "text") ? $textPrettySortValue : $prettySortValue);
4071          }          }
# Line 4096  Line 4424 
4424          $htmlString .= "<li><b>Index $fullName</b>\n<ul>\n";          $htmlString .= "<li><b>Index $fullName</b>\n<ul>\n";
4425          # Add any note text.          # Add any note text.
4426          if (my $note = $indexData->{Notes}) {          if (my $note = $indexData->{Notes}) {
4427              $htmlString .= "<li>" . _HTMLNote($note->{content}) . "</li>\n";              $htmlString .= "<li>" . HTMLNote($note->{content}) . "</li>\n";
4428          }          }
4429          # Add the fiield list.          # Add the fiield list.
4430          $htmlString .= "<li><i>" . join(', ', @{$indexData->{IndexFields}}) . "</i></li>\n";          $htmlString .= "<li><i>" . join(', ', @{$indexData->{IndexFields}}) . "</i></li>\n";
# Line 4211  Line 4539 
4539      my $htmlString = "<tr><th align=\"left\">$fieldData->{name}</th><td>$fieldData->{type}</td>";      my $htmlString = "<tr><th align=\"left\">$fieldData->{name}</th><td>$fieldData->{type}</td>";
4540      # If we have content, add it as a third column.      # If we have content, add it as a third column.
4541      if (exists $fieldData->{Notes}) {      if (exists $fieldData->{Notes}) {
4542          $htmlString .= "<td>" . _HTMLNote($fieldData->{Notes}->{content}) . "</td>";          $htmlString .= "<td>" . HTMLNote($fieldData->{Notes}->{content}) . "</td>";
4543      }      }
4544      # Close off the row.      # Close off the row.
4545      $htmlString .= "</tr>\n";      $htmlString .= "</tr>\n";
# Line 4219  Line 4547 
4547      return $htmlString;      return $htmlString;
4548  }  }
4549    
 =head3 _HTMLNote  
   
 Convert a note or comment to HTML by replacing some bulletin-board codes with HTML. The codes  
 supported are C<[b]> for B<bold>, C<[i]> for I<italics>, and C<[p]> for a new paragraph.  
 Except for C<[p]>, all the codes are closed by slash-codes. So, for  
 example, C<[b]Feature[/b]> displays the string C<Feature> in boldface.  
   
 This is a static method.  
   
 =over 4  
   
 =item dataString  
   
 String to convert to HTML.  
   
 =item RETURN  
   
 An HTML string derived from the input string.  
   
 =back  
   
 =cut  
   
 sub _HTMLNote {  
     # Get the parameter.  
     my ($dataString) = @_;  
     # Substitute the codes.  
     $dataString =~ s!\[(/?[bi])\]!<$1>!g;  
     $dataString =~ s!\[p\]!</p><p>!g;  
     # Return the result.  
     return $dataString;  
 }  
   
 =head2 Data Generation Utilities  
   
 =head3 IntGen  
   
 C<< my $integer = IntGen($min, $max); >>  
   
 Returns a random number between the specified minimum and maximum (inclusive).  
   
 =over 4  
   
 =item min  
   
 Minimum permissible return value.  
   
 =item max  
   
 Maximum permissible return value.  
   
 =item RETURN  
   
 Returns a value no lower than the minimum and no greater than the maximum.  
   
 =back  
   
 =cut  
   
 sub IntGen {  
     # Get the parameters.  
     my ($min, $max) = @_;  
     # Determine the range of possible values. Note we put some space well above the  
     # maximum value to give it a fighting chance of apppearing in the list.  
     my $span = $max + 0.99 - $min;  
     # Create an integer in the range.  
     my $retVal = $min + int(rand($span));  
     # Return the result.  
     return $retVal;  
 }  
   
 =head3 RandChar  
   
 C<< my $char = RandChar($sourceString); >>  
   
 Select a random character from a string.  
   
 =over 4  
   
 =item sourceString  
   
 String from which the random character should be selected.  
   
 =item RETURN  
   
 Returns a single character from the incoming string.  
   
 =back  
   
 =cut  
   
 sub RandChar {  
     # Get the parameter.  
     my ($sourceString) = @_;  
     # Select a random character.  
     my $retVal = IntGen(0, (length $sourceString) - 1);  
     # Return it.  
     return substr($sourceString, $retVal, 1);  
 }  
   
 =head3 RandChars  
   
 C<< my $string = RandChars($sourceString, $length); >>  
   
 Create a string from characters taken from a source string.  
   
 =over 4  
   
 =item sourceString  
   
 String from which the random characters should be selected.  
   
 =item length  
   
 Number of characters to put in the output string.  
   
 =item RETURN  
   
 Returns a string of the specified length consisting of characters taken from the  
 source string.  
   
 =back  
   
 =cut  
   
 sub RandChars {  
     # Get the parameters.  
     my ($sourceString, $length) = @_;  
     # Call RandChar repeatedly to generate the string.  
     my $retVal = "";  
     for (my $i = 0; $i < $length; $i++) {  
         $retVal .= RandChar($sourceString);  
     }  
     # Return the result.  
     return $retVal;  
 }  
   
 =head3 RandParam  
   
 C<< my $value = RandParam($parm1, $parm2, ... $parmN); >>  
   
 Return a randomly-selected value from the parameter list.  
   
 =over 4  
   
 =item parm1, parm2, ... parmN  
   
 List of values of which one will be selected.  
   
 =item RETURN  
   
 Returns a randomly-chosen value from the specified list.  
   
 =back  
   
 =cut  
   
 sub RandParam {  
     # Get the parameter.  
     my @parms = @_;  
     # Choose a random parameter from the list.  
     my $chosenIndex = IntGen(0, $#parms);  
     return $parms[$chosenIndex];  
 }  
   
 =head3 StringGen  
   
 C<< my $string = StringGen($pattern1, $pattern2, ... $patternN); >>  
   
 Returns a random string derived from a randomly-chosen format pattern. The pattern  
 can either be a number (indicating the number of characters desired, or the letter  
 C<P> followed by a picture. The picture should contain C<A> when a letter is desired,  
 C<9> when a digit is desired, C<V> when a vowel is desired, C<K> when a consonant is  
 desired, and C<X> when a letter or a digit is desired. Any other character will be  
 translated as a literal.  
   
 =over 4  
   
 =item pattern1, pattern2, ... patternN  
   
 List of patterns to be used to generate string values.  
   
 =item RETURN  
   
 A single string generated from a pattern.  
   
 =back  
   
 =cut  
   
 sub StringGen {  
     # Get the parameters.  
     my @patterns = @_;  
     # Choose the appropriate pattern.  
     my $chosenPattern = RandParam(@patterns);  
     # Declare the return variable.  
     my $retVal = "";  
     # Determine whether this is a count or a picture pattern.  
     if ($chosenPattern =~ m/^\d+/) {  
         # Here we have a count. Get the string of source characters.  
         my $letterString = $PictureTable{'X'};  
         my $stringLen = length $letterString;  
         # Save the number of characters we have to generate.  
         my $charsLeft = $chosenPattern;  
         # Loop until the return variable is full.  
         while ($charsLeft > 0) {  
             # Generate a random position in the soruce string.  
             my $stringIndex = IntGen(0, $stringLen - 1);  
             # Compute the number of characters to pull out of the source string.  
             my $chunkSize = $stringLen - $stringIndex;  
             if ($chunkSize > $charsLeft) { $chunkSize = $charsLeft; }  
             # Stuff this chunk into the return value.  
             $retVal .= substr($letterString, $stringIndex, $chunkSize);  
             # Record the data moved.  
             $charsLeft -= $chunkSize;  
         }  
     } elsif ($chosenPattern =~ m/^P/) {  
         # Here we have a picture string. We will move through the picture one  
         # character at a time generating data.  
         for (my $i = 1; $i < length $chosenPattern; $i++) {  
             # Get this picture character.  
             my $chr = substr($chosenPattern, $i, 1);  
             # Check to see if the picture char is one we recognize.  
             if (exists $PictureTable{$chr}) {  
                 # Choose a random character from the available values for this  
                 # picture character.  
                 $retVal .= RandChar($PictureTable{$chr});  
             } else {  
                 # Copy in the picture character as a literal.  
                 $retVal .= $chr;  
             }  
         }  
     } else {  
         # Here we have neither a picture string or a letter count, so we treat  
         # the string as a literal.  
         $retVal = $chosenPattern;  
     }  
     # Return the string formed.  
     return $retVal;  
 }  
   
 =head3 DateGen  
   
 C<< my $date = DateGen($startDayOffset, $endDayOffset, $minutes); >>  
   
 Return a numeric timestamp within the specified range of days with the specified minute  
 value. The range of days is specified relevant to the current day. Thus, the call  
   
 C<< my $date = DateGen(-1, 5, 720); >>  
   
 will return a timestamp at noon (72 minutes past midnight) sometime during the week that  
 began on the preceding day. If you want a random minute of the day, simply combine with  
 a call to L</IntGen>, as follows.  
   
 C<< my $date = DateGen(-1, 5, IntGen(0, 1439)); >>  
   
 =over 4  
   
 =item startDayOffset  
   
 The earliest day that can be returned, relative to the current day.  
   
 =item endDayOffset  
   
 The latest day that can be returned, related to the current day.  
   
 =item minutes  
   
 Number of minutes into the selected day that should be used.  
   
 =back  
   
 =cut  
   
 sub DateGen {  
     # Get the parameters.  
     my ($startDayOffset, $endDayOffset, $minutes) = @_;  
     # Get midnight of the current day.  
     my $now = time();  
     my ($sec, $min, $hour) = localtime($now);  
     my $today = $now - (($hour * 60 + $min) * 60 + $sec);  
     # Compute the day we want.  
     my $newDay = IntGen($startDayOffset, $endDayOffset) * 86400 + $today;  
     # Add the minutes.  
     my $retVal = $newDay + $minutes * 60;  
     # Return the result.  
     return $retVal;  
 }  
   
 =head3 FloatGen  
   
 C<< my $number = FloatGen($min, $max); >>  
   
 Return a random floating-point number greater than or equal to the specified minimum and  
 less than the specified maximum.  
   
 =over 4  
   
 =item min  
   
 Minimum permissible value for the number returned.  
   
 =item max  
   
 Maximum permissible value for the number returned.  
   
 =item RETURN  
   
 Returns a floating-point number anywhere in the specified range.  
   
 =back  
   
 =cut  
   
 sub FloatGen {  
     # Get the parameters.  
     my ($min, $max) = @_;  
     # Generate the result.  
     my $retVal = rand($max - $min) + $min;  
     return $retVal;  
 }  
   
 =head3 ListGen  
   
 C<< my @list = ListGen($pattern, $count); >>  
   
 Return a list containing a fixed number of randomly-generated strings.  
   
 =over 4  
   
 =item pattern  
   
 A pattern (in the form expected by L</StringGen>) that should be used to generate the  
 strings in the list.  
   
 =item count  
   
 The number of list entries to generate.  
   
 =item RETURN  
   
 Returns a list consisting of the specified number of strings.  
   
 =back  
   
 =cut  
   
 sub ListGen {  
     # Get the parameters.  
     my ($pattern, $count) = @_;  
     # Generate the list.  
     my @retVal = ();  
     for (my $i = 0; $i < $count; $i++) {  
         push @retVal, StringGen($pattern);  
     }  
     # Return it.  
     return @retVal;  
 }  
   
4550  1;  1;

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3