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

Annotation of /Sprout/CustomAttributes.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.20 - (view) (download) (as text)

1 : parrello 1.1 #!/usr/bin/perl -w
2 :    
3 :     package CustomAttributes;
4 :    
5 :     require Exporter;
6 :     use ERDB;
7 : parrello 1.4 @ISA = qw(ERDB);
8 : parrello 1.1 use strict;
9 :     use Tracer;
10 :     use ERDBLoad;
11 : parrello 1.13 use Stats;
12 : parrello 1.1
13 :     =head1 Custom SEED Attribute Manager
14 :    
15 :     =head2 Introduction
16 :    
17 :     The Custom SEED Attributes Manager allows the user to upload and retrieve
18 :     custom data for SEED objects. It uses the B<ERDB> database system to
19 : parrello 1.10 store the attributes.
20 :    
21 :     Attributes are organized by I<attribute key>. Attribute values are
22 :     assigned to I<objects>. In the real world, objects have types and IDs;
23 :     however, to the attribute database only the ID matters. This will create
24 :     a problem if we have a single ID that applies to two objects of different
25 :     types, but it is more consistent with the original attribute implementation
26 : parrello 1.11 in the SEED (which this implementation replaces).
27 : parrello 1.10
28 : parrello 1.11 The actual attribute values are stored as a relationship between the attribute
29 :     keys and the objects. There can be multiple values for a single key/object pair.
30 : parrello 1.1
31 : parrello 1.19 =head3 Object IDs
32 :    
33 :     The object ID is normally represented as
34 :    
35 :     I<type>:I<id>
36 :    
37 :     where I<type> is the object type (C<Role>, C<Coupling>, etc.) and I<id> is
38 :     the actual object ID. Note that the object type must consist of only upper- and
39 :     lower-case letters! Thus, C<GenomeGroup> is a valid object type, but
40 :     C<genome_group> is not. Given that restriction, the object ID
41 :    
42 :     Family:aclame|cluster10
43 :    
44 :     would represent the FIG family C<aclame|cluster10>. For historical reasons,
45 :     there are three exceptions: subsystems, genomes, and features do not need
46 :     a type. So, for PEG 3361 of Streptomyces coelicolor A3(2), you simply code
47 :    
48 :     fig|100226.1.peg.3361
49 :    
50 :     The methods L</ParseID> and L</FormID> can be used to make this all seem
51 :     more consistent. Given any object ID string, L</ParseID> will convert it to an
52 :     object type and ID, and given any object type and ID, L</FormID> will
53 :     convert it to an object ID string. The attribute database is pretty
54 :     freewheeling about what it will allow for an ID; however, for best
55 :     results, the type should match an entity type from a Sprout genetics
56 :     database. If this rule is followed, then the database object
57 :     corresponding to an ID in the attribute database could be retrieved using
58 :     L</GetTargetObject> method.
59 :    
60 :     my $object = CustomAttributes::GetTargetObject($sprout, $idValue);
61 :    
62 :     =head3 Retrieval and Logging
63 :    
64 : parrello 1.1 The full suite of ERDB retrieval capabilities is provided. In addition,
65 :     custom methods are provided specific to this application. To get all
66 : parrello 1.6 the values of the attribute C<essential> in a specified B<Feature>, you
67 : parrello 1.1 would code
68 :    
69 : parrello 1.10 my @values = $attrDB->GetAttributes($fid, 'essential');
70 : parrello 1.1
71 : parrello 1.10 where I<$fid> contains the ID of the desired feature.
72 : parrello 1.1
73 : parrello 1.20 Keys can be split into two pieces using the splitter value defined in the
74 :     constructor (the default is C<::>). The first piece of the key is called
75 :     the I<real key>. This portion of the key must be defined using the
76 :     web interface (C<Attributes.cgi>). The second portion of the key is called
77 :     the I<sub key>, and can take any value.
78 : parrello 1.1
79 : parrello 1.18 Major attribute activity is recorded in a log (C<attributes.log>) in the
80 :     C<$FIG_Config::var> directory. The log reports the user name, time, and
81 :     the details of the operation. The user name will almost always be unknown,
82 : parrello 1.20 the exception being when it is specified in this object's constructor
83 :     (see L</new>).
84 : parrello 1.18
85 : parrello 1.1 =head2 FIG_Config Parameters
86 :    
87 :     The following configuration parameters are used to manage custom attributes.
88 :    
89 :     =over 4
90 :    
91 :     =item attrDbms
92 :    
93 :     Type of database manager used: C<mysql> for MySQL or C<pg> for PostGres.
94 :    
95 :     =item attrDbName
96 :    
97 :     Name of the attribute database.
98 :    
99 :     =item attrHost
100 :    
101 :     Name of the host server for the database. If omitted, the current host
102 :     is used.
103 :    
104 :     =item attrUser
105 :    
106 :     User name for logging in to the database.
107 :    
108 :     =item attrPass
109 :    
110 :     Password for logging in to the database.
111 :    
112 :     =item attrPort
113 :    
114 :     TCP/IP port for accessing the database.
115 :    
116 :     =item attrSock
117 :    
118 :     Socket name used to access the database. If omitted, the default socket
119 :     will be used.
120 :    
121 :     =item attrDBD
122 :    
123 :     Fully-qualified file name for the database definition XML file. This file
124 :     functions as data to the attribute management process, so if the data is
125 :     moved, this file must go with it.
126 :    
127 :     =back
128 :    
129 :     =head2 Public Methods
130 :    
131 :     =head3 new
132 :    
133 : parrello 1.18 C<< my $attrDB = CustomAttributes->new(%options); >>
134 : parrello 1.1
135 : parrello 1.18 Construct a new CustomAttributes object. The following options are
136 :     supported.
137 : parrello 1.3
138 :     =over 4
139 :    
140 :     =item splitter
141 :    
142 :     Value to be used to split attribute values into sections in the
143 : parrello 1.18 L</Fig Replacement Methods>. The default is a double colon C<::>,
144 :     and should only be overridden in extreme circumstances.
145 :    
146 :     =item user
147 :    
148 :     Name of the current user. This will appear in the attribute log.
149 : parrello 1.3
150 :     =back
151 : parrello 1.1
152 :     =cut
153 :    
154 :     sub new {
155 :     # Get the parameters.
156 : parrello 1.18 my ($class, %options) = @_;
157 : parrello 1.1 # Connect to the database.
158 :     my $dbh = DBKernel->new($FIG_Config::attrDbms, $FIG_Config::attrDbName,
159 :     $FIG_Config::attrUser, $FIG_Config::attrPass,
160 :     $FIG_Config::attrPort, $FIG_Config::attrHost,
161 :     $FIG_Config::attrSock);
162 :     # Create the ERDB object.
163 :     my $xmlFileName = $FIG_Config::attrDBD;
164 :     my $retVal = ERDB::new($class, $dbh, $xmlFileName);
165 : parrello 1.3 # Store the splitter value.
166 : parrello 1.18 $retVal->{splitter} = $options{splitter} || '::';
167 :     # Store the user name.
168 :     $retVal->{user} = $options{user} || '<unknown>';
169 :     Trace("User $retVal->{user} selected for attribute object.") if T(3);
170 : parrello 1.1 # Return the result.
171 :     return $retVal;
172 :     }
173 :    
174 : parrello 1.10 =head3 StoreAttributeKey
175 :    
176 :     C<< $attrDB->StoreAttributeKey($attributeName, $type, $notes, \@groups); >>
177 :    
178 :     Create or update an attribute for the database.
179 :    
180 :     =over 4
181 : parrello 1.1
182 :     =item attributeName
183 :    
184 : parrello 1.20 Name of the attribute (the real key). If it does not exist already, it will be created.
185 : parrello 1.1
186 :     =item type
187 :    
188 :     Data type of the attribute. This must be a valid ERDB data type name.
189 :    
190 :     =item notes
191 :    
192 :     Descriptive notes about the attribute. It is presumed to be raw text, not HTML.
193 :    
194 : parrello 1.10 =item groups
195 : parrello 1.1
196 : parrello 1.10 Reference to a list of the groups to which the attribute should be associated.
197 :     This will replace any groups to which the attribute is currently attached.
198 : parrello 1.1
199 :     =back
200 :    
201 :     =cut
202 :    
203 : parrello 1.3 sub StoreAttributeKey {
204 : parrello 1.1 # Get the parameters.
205 : parrello 1.10 my ($self, $attributeName, $type, $notes, $groups) = @_;
206 : parrello 1.8 # Declare the return variable.
207 :     my $retVal;
208 : parrello 1.1 # Get the data type hash.
209 :     my %types = ERDB::GetDataTypes();
210 :     # Validate the initial input values.
211 : parrello 1.20 if ($attributeName =~ /$self->{splitter}/) {
212 : parrello 1.1 Confess("Invalid attribute name \"$attributeName\" specified.");
213 :     } elsif (! $notes || length($notes) < 25) {
214 :     Confess("Missing or incomplete description for $attributeName.");
215 :     } elsif (! exists $types{$type}) {
216 :     Confess("Invalid data type \"$type\" for $attributeName.");
217 :     } else {
218 : parrello 1.18 # Create a variable to hold the action to be displayed for the log (Add or Update).
219 :     my $action;
220 : parrello 1.10 # Okay, we're ready to begin. See if this key exists.
221 :     my $attribute = $self->GetEntity('AttributeKey', $attributeName);
222 :     if (defined($attribute)) {
223 :     # It does, so we do an update.
224 : parrello 1.18 $action = "Update Key";
225 : parrello 1.10 $self->UpdateEntity('AttributeKey', $attributeName,
226 :     { description => $notes, 'data-type' => $type });
227 :     # Detach the key from its current groups.
228 :     $self->Disconnect('IsInGroup', 'AttributeKey', $attributeName);
229 :     } else {
230 :     # It doesn't, so we do an insert.
231 : parrello 1.18 $action = "Insert Key";
232 : parrello 1.10 $self->InsertObject('AttributeKey', { id => $attributeName,
233 :     description => $notes, 'data-type' => $type });
234 : parrello 1.8 }
235 : parrello 1.10 # Attach the key to the specified groups. (We presume the groups already
236 :     # exist.)
237 :     for my $group (@{$groups}) {
238 :     $self->InsertObject('IsInGroup', { 'from-link' => $attributeName,
239 :     'to-link' => $group });
240 : parrello 1.1 }
241 : parrello 1.18 # Log the operation.
242 :     $self->LogOperation($action, $attributeName, "Group list is " . join(" ", @{$groups}));
243 : parrello 1.1 }
244 :     }
245 :    
246 :    
247 : parrello 1.3 =head3 DeleteAttributeKey
248 :    
249 : parrello 1.10 C<< my $stats = $attrDB->DeleteAttributeKey($attributeName); >>
250 : parrello 1.1
251 :     Delete an attribute from the custom attributes database.
252 :    
253 :     =over 4
254 :    
255 : parrello 1.10 =item attributeName
256 : parrello 1.1
257 : parrello 1.10 Name of the attribute to delete.
258 : parrello 1.1
259 : parrello 1.10 =item RETURN
260 : parrello 1.1
261 : parrello 1.10 Returns a statistics object describing the effects of the deletion.
262 : parrello 1.1
263 :     =back
264 :    
265 :     =cut
266 :    
267 : parrello 1.3 sub DeleteAttributeKey {
268 : parrello 1.1 # Get the parameters.
269 : parrello 1.10 my ($self, $attributeName) = @_;
270 :     # Delete the attribute key.
271 :     my $retVal = $self->Delete('AttributeKey', $attributeName);
272 : parrello 1.18 # Log this operation.
273 :     $self->LogOperation("Delete Key", $attributeName, "Key will no longer be available for use by anyone.");
274 : parrello 1.10 # Return the result.
275 :     return $retVal;
276 :    
277 :     }
278 :    
279 :     =head3 NewName
280 :    
281 :     C<< my $text = CustomAttributes::NewName(); >>
282 :    
283 :     Return the string used to indicate the user wants to add a new attribute.
284 :    
285 :     =cut
286 :    
287 :     sub NewName {
288 :     return "(new)";
289 : parrello 1.1 }
290 :    
291 :     =head3 ControlForm
292 :    
293 : parrello 1.10 C<< my $formHtml = $attrDB->ControlForm($cgi, $name, \%keys); >>
294 : parrello 1.1
295 :     Return a form that can be used to control the creation and modification of
296 : parrello 1.10 attributes. Only a subset of the attribute keys will be displayed, as
297 :     determined by the incoming list.
298 : parrello 1.1
299 :     =over 4
300 :    
301 :     =item cgi
302 :    
303 :     CGI query object used to create HTML.
304 :    
305 :     =item name
306 :    
307 :     Name to give to the form. This should be unique for the web page.
308 :    
309 : parrello 1.10 =item keys
310 :    
311 :     Reference to a hash mapping attribute keys to n-tuples. Each tuple will contain the
312 :     attribute's data type, its description, and a list of the groups in which it participates.
313 :    
314 : parrello 1.1 =item RETURN
315 :    
316 : parrello 1.10 Returns the HTML for a form that can be used to submit instructions to the C<Attributes.cgi> script
317 :     for loading, creating, displaying, changing, or deleting an attribute. Note that only the form
318 :     controls are generated. The form tags are left to the caller.
319 : parrello 1.1
320 :     =back
321 :    
322 :     =cut
323 :    
324 :     sub ControlForm {
325 :     # Get the parameters.
326 : parrello 1.10 my ($self, $cgi, $name, $keys) = @_;
327 : parrello 1.1 # Declare the return list.
328 :     my @retVal = ();
329 :     # We'll put the controls in a table. Nothing else ever seems to look nice.
330 :     push @retVal, $cgi->start_table({ border => 2, cellpadding => 2 });
331 :     # The first row is for selecting the field name.
332 :     push @retVal, $cgi->Tr($cgi->th("Select a Field"),
333 : parrello 1.10 $cgi->td($self->FieldMenu($cgi, 10, 'fieldName', $keys,
334 :     new => 1,
335 :     notes => "document.$name.notes.value",
336 :     type => "document.$name.dataType.value",
337 :     groups => "document.$name.groups")));
338 : parrello 1.1 # Now we set up a dropdown for the data types. The values will be the
339 :     # data type names, and the labels will be the descriptions.
340 :     my %types = ERDB::GetDataTypes();
341 :     my %labelMap = map { $_ => $types{$_}->{notes} } keys %types;
342 :     my $typeMenu = $cgi->popup_menu(-name => 'dataType',
343 :     -values => [sort keys %types],
344 : parrello 1.10 -labels => \%labelMap,
345 :     -default => 'string');
346 :     # Allow the user to specify a new field name. This is required if the
347 :     # user has selected the "(new)" marker. We put a little scriptlet in here that
348 :     # selects the (new) marker when the user enters the field.
349 :     push @retVal, "<script language=\"javaScript\">";
350 :     my $fieldField = "document.$name.fieldName";
351 :     my $newName = "\"" . NewName() . "\"";
352 :     push @retVal, $cgi->Tr($cgi->th("New Field Name"),
353 :     $cgi->td($cgi->textfield(-name => 'newName',
354 :     -size => 30,
355 :     -value => "",
356 :     -onFocus => "setIfEmpty($fieldField, $newName);")),
357 :     );
358 : parrello 1.1 push @retVal, $cgi->Tr($cgi->th("Data type"),
359 :     $cgi->td($typeMenu));
360 :     # The next row is for the notes.
361 :     push @retVal, $cgi->Tr($cgi->th("Description"),
362 :     $cgi->td($cgi->textarea(-name => 'notes',
363 :     -rows => 6,
364 :     -columns => 80))
365 :     );
366 : parrello 1.10 # Now we have the groups, which are implemented as a checkbox group.
367 :     my @groups = $self->GetGroups();
368 :     push @retVal, $cgi->Tr($cgi->th("Groups"),
369 :     $cgi->td($cgi->checkbox_group(-name=>'groups',
370 :     -values=> \@groups))
371 :     );
372 : parrello 1.20 # Now the four buttons: STORE, SHOW, ERASE, and DELETE.
373 : parrello 1.1 push @retVal, $cgi->Tr($cgi->th("&nbsp;"),
374 : parrello 1.20 $cgi->td({align => 'center'}, join(" ",
375 :     $cgi->submit(-name => 'Delete', -value => 'DELETE'),
376 :     $cgi->submit(-name => 'Store', -value => 'STORE'),
377 :     $cgi->submit(-name => 'Erase', -value => 'ERASE'),
378 : parrello 1.7 $cgi->submit(-name => 'Show', -value => 'SHOW')
379 : parrello 1.20 ))
380 : parrello 1.1 );
381 :     # Close the table and the form.
382 :     push @retVal, $cgi->end_table();
383 :     # Return the assembled HTML.
384 :     return join("\n", @retVal, "");
385 :     }
386 :    
387 : parrello 1.11 =head3 LoadAttributesFrom
388 :    
389 :     C<< my $stats = $attrDB->LoadAttributesFrom($fileName, %options); >>
390 :    
391 :     Load attributes from the specified tab-delimited file. Each line of the file must
392 :     contain an object ID in the first column, an attribute key name in the second
393 :     column, and attribute values in the remaining columns. The attribute values will
394 : parrello 1.20 be assembled into a single value using the splitter code. In addition, the key names may
395 :     contain a splitter. If this is the case, the portion of the key after the splitter is
396 :     treated as a subkey.
397 : parrello 1.11
398 :     =over 4
399 :    
400 :     =item fileName
401 :    
402 : parrello 1.20 Name of the file from which to load the attributes, or an open handle for the file.
403 :     (This last enables the method to be used in conjunction with the CGI form upload
404 :     control.)
405 : parrello 1.11
406 :     =item options
407 :    
408 :     Hash of options for modifying the load process.
409 :    
410 :     =item RETURN
411 :    
412 :     Returns a statistics object describing the load.
413 :    
414 :     =back
415 :    
416 :     Permissible option values are as follows.
417 :    
418 :     =over 4
419 :    
420 :     =item append
421 :    
422 :     If TRUE, then the attributes will be appended to existing data; otherwise, the
423 :     first time a key name is encountered, it will be erased.
424 :    
425 : parrello 1.20 =item archive
426 :    
427 :     If specified, the name of a file into which the incoming data file should be saved.
428 :    
429 :     =item objectType
430 :    
431 :     If specified, the specified object type will be prefixed to each object ID.
432 :    
433 : parrello 1.11 =back
434 :    
435 :     =cut
436 :    
437 :     sub LoadAttributesFrom {
438 :     # Get the parameters.
439 :     my ($self, $fileName, %options) = @_;
440 :     # Declare the return variable.
441 :     my $retVal = Stats->new('keys', 'values');
442 :     # Check for append mode.
443 :     my $append = ($options{append} ? 1 : 0);
444 :     # Create a hash of key names found.
445 :     my %keyHash = ();
446 : parrello 1.20 # Open the file for input. Note we must anticipate the possibility of an
447 :     # open filehandle being passed in.
448 :     my $fh;
449 :     if (ref $fileName eq 'GLOB') {
450 :     Trace("Using file opened by caller.") if T(3);
451 :     $fh = $fileName;
452 :     } else {
453 :     Trace("Attributes will be loaded from $fileName.") if T(3);
454 :     $fh = Open(undef, "<$fileName");
455 :     }
456 :     # Now check to see if we need to archive.
457 :     my $ah;
458 :     if ($options{archive}) {
459 :     $ah = Open(undef, ">$options{archive}");
460 :     Trace("Load file will be archived to $options{archive}.") if T(3);
461 :     }
462 :     # Finally, open a database transaction.
463 :     $self->BeginTran();
464 :     # Insure we recover from errors. If an error occurs, we will delete the archive file and
465 :     # roll back the updates.
466 :     eval {
467 :     # Loop through the file.
468 :     while (! eof $fh) {
469 :     # Read the current line.
470 :     my ($id, $key, @values) = Tracer::GetLine($fh);
471 :     $retVal->Add(linesIn => 1);
472 :     # Check to see if we need to fix up the object ID.
473 :     if ($options{objectType}) {
474 :     $id = "$options{objectType}:$id";
475 :     }
476 :     # Archive the line (if necessary).
477 :     if (defined $ah) {
478 :     Tracer::PutLine($ah, [$id, $key, @values]);
479 :     }
480 :     # Do some validation.
481 :     if (! $id) {
482 :     # We ignore blank lines.
483 :     $retVal->Add(blankLines => 1);
484 :     } elsif (substr($id, 0, 1) eq '#') {
485 :     # A line beginning with a pound sign is a comment.
486 :     $retVal->Add(comments => 1);
487 :     } elsif (! defined($key)) {
488 :     # An ID without a key is a serious error.
489 :     my $lines = $retVal->Ask('linesIn');
490 :     Confess("Line $lines in $fileName has no attribute key.");
491 :     } else {
492 :     # The key contains a real part and an optional sub-part. We need the real part.
493 :     my ($realKey, $subKey) = $self->SplitKey($key);
494 :     # Now we need to check for a new key.
495 :     if (! exists $keyHash{$realKey}) {
496 :     if (! $self->Exists('AttributeKey', $realKey)) {
497 :     my $line = $retVal->Ask('linesIn');
498 :     Confess("Attribute \"$realKey\" on line $line of $fileName not found in database.");
499 :     } else {
500 :     # Make sure we know this is no longer a new key.
501 :     $keyHash{$realKey} = 1;
502 :     $retVal->Add(keys => 1);
503 :     # If this is NOT append mode, erase the key.
504 :     if (! $append) {
505 :     $self->EraseAttribute($realKey);
506 :     }
507 : parrello 1.11 }
508 : parrello 1.20 Trace("Key $realKey found.") if T(3);
509 : parrello 1.11 }
510 : parrello 1.20 # Everything is all set up, so add the value.
511 :     $self->AddAttribute($id, $key, @values);
512 :     my $progress = $retVal->Add(values => 1);
513 :     Trace("$progress values loaded.") if T(3) && ($progress % 1000 == 0);
514 : parrello 1.11 }
515 : parrello 1.20 }
516 :     };
517 :     # Check for an error.
518 :     if ($@) {
519 :     # Here we have an error. Roll back the transaction and delete the archive file.
520 :     my $message = $@;
521 :     Trace("Rolling back attribute updates due to error.") if T(1);
522 :     $self->RollbackTran();
523 :     if (defined $ah) {
524 :     Trace("Deleting archive file $options{archive}.") if T(1);
525 :     close $ah;
526 :     unlink $options{archive};
527 :     }
528 :     Confess("Error during attribute load: $message");
529 :     } else {
530 :     # Here the load worked. Commit the transaction and close the archive file.
531 :     Trace("Committing attribute upload.") if T(2);
532 :     $self->CommitTran();
533 :     if (defined $ah) {
534 :     Trace("Closing archive file $options{archive}.") if T(2);
535 :     close $ah;
536 : parrello 1.11 }
537 :     }
538 :     # Return the result.
539 :     return $retVal;
540 :     }
541 :    
542 : parrello 1.13 =head3 BackupKeys
543 :    
544 :     C<< my $stats = $attrDB->BackupKeys($fileName, %options); >>
545 :    
546 :     Backup the attribute key information from the attribute database.
547 :    
548 :     =over 4
549 :    
550 :     =item fileName
551 :    
552 :     Name of the output file.
553 :    
554 :     =item options
555 :    
556 :     Options for modifying the backup process.
557 :    
558 :     =item RETURN
559 :    
560 :     Returns a statistics object for the backup.
561 :    
562 :     =back
563 :    
564 :     Currently there are no options. The backup is straight to a text file in
565 :     tab-delimited format. Each key is backup up to two lines. The first line
566 :     is all of the data from the B<AttributeKey> table. The second is a
567 :     tab-delimited list of all the groups.
568 :    
569 :     =cut
570 :    
571 :     sub BackupKeys {
572 :     # Get the parameters.
573 :     my ($self, $fileName, %options) = @_;
574 :     # Declare the return variable.
575 :     my $retVal = Stats->new();
576 :     # Open the output file.
577 :     my $fh = Open(undef, ">$fileName");
578 :     # Set up to read the keys.
579 :     my $keyQuery = $self->Get(['AttributeKey'], "", []);
580 :     # Loop through the keys.
581 :     while (my $keyData = $keyQuery->Fetch()) {
582 :     $retVal->Add(key => 1);
583 :     # Get the fields.
584 :     my ($id, $type, $description) = $keyData->Values(['AttributeKey(id)', 'AttributeKey(data-type)',
585 :     'AttributeKey(description)']);
586 :     # Escape any tabs or new-lines in the description.
587 :     my $escapedDescription = Tracer::Escape($description);
588 :     # Write the key data to the output.
589 :     Tracer::PutLine($fh, [$id, $type, $escapedDescription]);
590 :     # Get the key's groups.
591 :     my @groups = $self->GetFlat(['IsInGroup'], "IsInGroup(from-link) = ?", [$id],
592 :     'IsInGroup(to-link)');
593 :     $retVal->Add(memberships => scalar(@groups));
594 :     # Write them to the output. Note we put a marker at the beginning to insure the line
595 :     # is nonempty.
596 :     Tracer::PutLine($fh, ['#GROUPS', @groups]);
597 :     }
598 : parrello 1.18 # Log the operation.
599 :     $self->LogOperation("Backup Keys", $fileName, $retVal->Display());
600 : parrello 1.13 # Return the result.
601 :     return $retVal;
602 :     }
603 :    
604 :     =head3 RestoreKeys
605 :    
606 :     C<< my $stats = $attrDB->RestoreKeys($fileName, %options); >>
607 :    
608 :     Restore the attribute keys and groups from a backup file.
609 :    
610 :     =over 4
611 :    
612 :     =item fileName
613 :    
614 :     Name of the file containing the backed-up keys. Each key has a pair of lines,
615 :     one containing the key data and one listing its groups.
616 :    
617 :     =back
618 :    
619 :     =cut
620 :    
621 :     sub RestoreKeys {
622 :     # Get the parameters.
623 :     my ($self, $fileName, %options) = @_;
624 :     # Declare the return variable.
625 :     my $retVal = Stats->new();
626 :     # Set up a hash to hold the group IDs.
627 :     my %groups = ();
628 :     # Open the file.
629 :     my $fh = Open(undef, "<$fileName");
630 :     # Loop until we're done.
631 :     while (! eof $fh) {
632 :     # Get a key record.
633 :     my ($id, $dataType, $description) = Tracer::GetLine($fh);
634 :     if ($id eq '#GROUPS') {
635 :     Confess("Group record found when key record expected.");
636 :     } elsif (! defined($description)) {
637 :     Confess("Invalid format found for key record.");
638 :     } else {
639 :     $retVal->Add("keyIn" => 1);
640 :     # Add this key to the database.
641 :     $self->InsertObject('AttributeKey', { id => $id, 'data-type' => $dataType,
642 :     description => Tracer::UnEscape($description) });
643 :     Trace("Attribute $id stored.") if T(3);
644 :     # Get the group line.
645 :     my ($marker, @groups) = Tracer::GetLine($fh);
646 :     if (! defined($marker)) {
647 :     Confess("End of file found where group record expected.");
648 :     } elsif ($marker ne '#GROUPS') {
649 :     Confess("Group record not found after key record.");
650 :     } else {
651 :     $retVal->Add(memberships => scalar(@groups));
652 :     # Connect the groups.
653 :     for my $group (@groups) {
654 :     # Find out if this is a new group.
655 :     if (! $groups{$group}) {
656 :     $retVal->Add(newGroup => 1);
657 :     # Add the group.
658 :     $self->InsertObject('AttributeGroup', { id => $group });
659 :     Trace("Group $group created.") if T(3);
660 :     # Make sure we know it's not new.
661 :     $groups{$group} = 1;
662 :     }
663 :     # Connect the group to our key.
664 :     $self->InsertObject('IsInGroup', { 'from-link' => $id, 'to-link' => $group });
665 :     }
666 :     Trace("$id added to " . scalar(@groups) . " groups.") if T(3);
667 :     }
668 :     }
669 :     }
670 : parrello 1.18 # Log the operation.
671 :     $self->LogOperation("Backup Keys", $fileName, $retVal->Display());
672 : parrello 1.13 # Return the result.
673 :     return $retVal;
674 :     }
675 :    
676 : parrello 1.20 =head3 ArchiveFileName
677 :    
678 :     C<< my $fileName = $ca->ArchiveFileName(); >>
679 :    
680 :     Compute a file name for archiving attribute input data. The file will be in the attribute log directory
681 :    
682 :     =cut
683 :    
684 :     sub ArchiveFileName {
685 :     # Get the parameters.
686 :     my ($self) = @_;
687 :     # Declare the return variable.
688 :     my $retVal;
689 :     # We start by turning the timestamp into something usable as a file name.
690 :     my $now = Tracer::Now();
691 :     $now =~ tr/ :\//___/;
692 :     # Next we get the directory name.
693 :     my $dir = "$FIG_Config::var/attributes";
694 :     if (! -e $dir) {
695 :     Trace("Creating attribute file directory $dir.") if T(1);
696 :     mkdir $dir;
697 :     }
698 :     # Put it together with the field name and the time stamp.
699 :     $retVal = "$dir/upload.$now";
700 :     # Modify the file name to insure it's unique.
701 :     my $seq = 0;
702 :     while (-e "$retVal.$seq.tbl") { $seq++ }
703 :     # Use the computed sequence number to get the correct file name.
704 :     $retVal .= ".$seq.tbl";
705 :     # Return the result.
706 :     return $retVal;
707 :     }
708 : parrello 1.13
709 : parrello 1.11 =head3 BackupAllAttributes
710 :    
711 :     C<< my $stats = $attrDB->BackupAllAttributes($fileName, %options); >>
712 :    
713 :     Backup all of the attributes to a file. The attributes will be stored in a
714 :     tab-delimited file suitable for reloading via L</LoadAttributesFrom>.
715 :    
716 :     =over 4
717 :    
718 :     =item fileName
719 :    
720 :     Name of the file to which the attribute data should be backed up.
721 :    
722 :     =item options
723 :    
724 :     Hash of options for the backup.
725 :    
726 :     =item RETURN
727 :    
728 :     Returns a statistics object describing the backup.
729 :    
730 :     =back
731 :    
732 :     Currently there are no options defined.
733 :    
734 :     =cut
735 :    
736 :     sub BackupAllAttributes {
737 :     # Get the parameters.
738 :     my ($self, $fileName, %options) = @_;
739 :     # Declare the return variable.
740 :     my $retVal = Stats->new();
741 :     # Get a list of the keys.
742 :     my @keys = $self->GetFlat(['AttributeKey'], "", [], 'AttributeKey(id)');
743 :     Trace(scalar(@keys) . " keys found during backup.") if T(2);
744 :     # Open the file for output.
745 : parrello 1.12 my $fh = Open(undef, ">$fileName");
746 : parrello 1.11 # Loop through the keys.
747 :     for my $key (@keys) {
748 :     Trace("Backing up attribute $key.") if T(3);
749 :     $retVal->Add(keys => 1);
750 :     # Loop through this key's values.
751 : parrello 1.12 my $query = $self->Get(['HasValueFor'], "HasValueFor(from-link) = ?", [$key]);
752 : parrello 1.11 my $valuesFound = 0;
753 :     while (my $line = $query->Fetch()) {
754 :     $valuesFound++;
755 :     # Get this row's data.
756 : parrello 1.20 my ($id, $key, $subKey, $value) = $line->Values(['HasValueFor(to-link)',
757 :     'HasValueFor(from-link)',
758 :     'HasValueFor(subkey)',
759 :     'HasValueFor(value)']);
760 :     # Check for a subkey.
761 :     if ($subKey ne '') {
762 :     $key = "$key$self->{splitter}$subKey";
763 :     }
764 : parrello 1.11 # Write it to the file.
765 : parrello 1.20 Tracer::PutLine($fh, [$id, $key, $value]);
766 : parrello 1.11 }
767 :     Trace("$valuesFound values backed up for key $key.") if T(3);
768 :     $retVal->Add(values => $valuesFound);
769 :     }
770 : parrello 1.18 # Log the operation.
771 :     $self->LogOperation("Backup Data", $fileName, $retVal->Display());
772 : parrello 1.11 # Return the result.
773 :     return $retVal;
774 :     }
775 :    
776 : parrello 1.1 =head3 FieldMenu
777 :    
778 : parrello 1.10 C<< my $menuHtml = $attrDB->FieldMenu($cgi, $height, $name, $keys, %options); >>
779 : parrello 1.1
780 :     Return the HTML for a menu to select an attribute field. The menu will
781 :     be a standard SELECT/OPTION thing which is called "popup menu" in the
782 :     CGI package, but actually looks like a list. The list will contain
783 : parrello 1.10 one selectable row per field.
784 : parrello 1.1
785 :     =over 4
786 :    
787 :     =item cgi
788 :    
789 :     CGI query object used to generate HTML.
790 :    
791 :     =item height
792 :    
793 :     Number of lines to display in the list.
794 :    
795 :     =item name
796 :    
797 :     Name to give to the menu. This is the name under which the value will
798 :     appear when the form is submitted.
799 :    
800 : parrello 1.10 =item keys
801 :    
802 :     Reference to a hash mapping each attribute key name to a list reference,
803 :     the list itself consisting of the attribute data type, its description,
804 :     and a list of its groups.
805 :    
806 :     =item options
807 :    
808 :     Hash containing options that modify the generation of the menu.
809 :    
810 :     =item RETURN
811 :    
812 :     Returns the HTML to create a form field that can be used to select an
813 :     attribute from the custom attributes system.
814 :    
815 :     =back
816 :    
817 :     The permissible options are as follows.
818 :    
819 :     =over 4
820 :    
821 :     =item new
822 : parrello 1.1
823 :     If TRUE, then extra rows will be provided to allow the user to select
824 :     a new attribute. In other words, the user can select an existing
825 :     attribute, or can choose a C<(new)> marker to indicate a field to
826 :     be created in the parent entity.
827 :    
828 : parrello 1.10 =item notes
829 : parrello 1.1
830 :     If specified, the name of a variable for displaying the notes attached
831 :     to the field. This must be in Javascript form ready for assignment.
832 :     So, for example, if you have a variable called C<notes> that
833 :     represents a paragraph element, you should code C<notes.innerHTML>.
834 :     If it actually represents a form field you should code C<notes.value>.
835 :     If an C<innerHTML> coding is used, the text will be HTML-escaped before
836 :     it is copied in. Specifying this parameter generates Javascript for
837 :     displaying the field description when a field is selected.
838 :    
839 : parrello 1.10 =item type
840 : parrello 1.1
841 :     If specified, the name of a variable for displaying the field's
842 :     data type. Data types are a much more controlled vocabulary than
843 :     notes, so there is no worry about HTML translation. Instead, the
844 :     raw value is put into the specified variable. Otherwise, the same
845 :     rules apply to this value that apply to I<$noteControl>.
846 :    
847 : parrello 1.10 =item groups
848 : parrello 1.1
849 : parrello 1.10 If specified, the name of a multiple-selection list control (also called
850 :     a popup menu) which shall be used to display the selected groups.
851 : parrello 1.1
852 :     =back
853 :    
854 :     =cut
855 :    
856 :     sub FieldMenu {
857 :     # Get the parameters.
858 : parrello 1.10 my ($self, $cgi, $height, $name, $keys, %options) = @_;
859 :     # Reformat the list of keys.
860 :     my %keys = %{$keys};
861 :     # Add the (new) key, if needed.
862 :     if ($options{new}) {
863 :     $keys{NewName()} = ["string", ""];
864 : parrello 1.1 }
865 : parrello 1.10 # Get a sorted list of key.
866 :     my @keys = sort keys %keys;
867 :     # We need to create the name for the onChange function. This function
868 : parrello 1.1 # may not do anything, but we need to know the name to generate the HTML
869 :     # for the menu.
870 :     my $changeName = "${name}_setNotes";
871 :     my $retVal = $cgi->popup_menu({name => $name,
872 :     size => $height,
873 :     onChange => "$changeName(this.value)",
874 : parrello 1.10 values => \@keys,
875 :     });
876 : parrello 1.1 # Create the change function.
877 :     $retVal .= "\n<script language=\"javascript\">\n";
878 :     $retVal .= " function $changeName(fieldValue) {\n";
879 : parrello 1.10 # The function only has a body if we have a control to store data about the
880 :     # attribute.
881 :     if ($options{notes} || $options{type} || $options{groups}) {
882 : parrello 1.1 # Check to see if we're storing HTML or text into the note control.
883 : parrello 1.10 my $noteControl = $options{notes};
884 : parrello 1.1 my $htmlMode = ($noteControl && $noteControl =~ /innerHTML$/);
885 :     # We use a CASE statement based on the newly-selected field value. The
886 :     # field description will be stored in the JavaScript variable "myText"
887 :     # and the data type in "myType". Note the default data type is a normal
888 :     # string, but the default notes is an empty string.
889 :     $retVal .= " var myText = \"\";\n";
890 :     $retVal .= " var myType = \"string\";\n";
891 :     $retVal .= " switch (fieldValue) {\n";
892 : parrello 1.10 # Loop through the keys.
893 :     for my $key (@keys) {
894 :     # Generate this case.
895 :     $retVal .= " case \"$key\" :\n";
896 :     # Here we either want to update the note display, the
897 :     # type display, the group list, or a combination of them.
898 :     my ($type, $notes, @groups) = @{$keys{$key}};
899 :     if ($noteControl) {
900 :     # Insure it's in the proper form.
901 :     if ($htmlMode) {
902 :     $notes = ERDB::HTMLNote($notes);
903 : parrello 1.1 }
904 : parrello 1.10 # Escape it for use as a string literal.
905 :     $notes =~ s/\n/\\n/g;
906 :     $notes =~ s/"/\\"/g;
907 :     $retVal .= " myText = \"$notes\";\n";
908 :     }
909 :     if ($options{type}) {
910 :     # Here we want the type updated.
911 :     $retVal .= " myType = \"$type\";\n";
912 :     }
913 :     if ($options{groups}) {
914 :     # Here we want the groups shown. Get a list of this attribute's groups.
915 :     # We'll search through this list for each group to see if it belongs with
916 :     # our attribute.
917 :     my $groupLiteral = "=" . join("=", @groups) . "=";
918 :     # Now we need some variables containing useful code for the javascript. It's
919 :     # worth knowing we go through a bit of pain to insure $groupField[i] isn't
920 :     # parsed as an array element.
921 :     my $groupField = $options{groups};
922 :     my $currentField = $groupField . "[i]";
923 :     # Do the javascript.
924 :     $retVal .= " var groupList = \"$groupLiteral\";\n";
925 :     $retVal .= " for (var i = 0; i < $groupField.length; i++) {\n";
926 :     $retVal .= " var srchString = \"=\" + $currentField.value + \"=\";\n";
927 :     $retVal .= " var srchLoc = groupList.indexOf(srchString);\n";
928 :     $retVal .= " $currentField.checked = (srchLoc >= 0);\n";
929 :     $retVal .= " }\n";
930 : parrello 1.1 }
931 : parrello 1.10 # Close this case.
932 :     $retVal .= " break;\n";
933 : parrello 1.1 }
934 :     # Close the CASE statement and make the appropriate assignments.
935 :     $retVal .= " }\n";
936 :     if ($noteControl) {
937 :     $retVal .= " $noteControl = myText;\n";
938 :     }
939 : parrello 1.10 if ($options{type}) {
940 :     $retVal .= " $options{type} = myType;\n";
941 : parrello 1.1 }
942 :     }
943 :     # Terminate the change function.
944 :     $retVal .= " }\n";
945 :     $retVal .= "</script>\n";
946 :     # Return the result.
947 :     return $retVal;
948 :     }
949 :    
950 : parrello 1.10 =head3 GetGroups
951 : parrello 1.3
952 : parrello 1.10 C<< my @groups = $attrDB->GetGroups(); >>
953 : parrello 1.3
954 : parrello 1.10 Return a list of the available groups.
955 : parrello 1.3
956 :     =cut
957 :    
958 : parrello 1.10 sub GetGroups {
959 : parrello 1.3 # Get the parameters.
960 : parrello 1.10 my ($self) = @_;
961 :     # Get the groups.
962 :     my @retVal = $self->GetFlat(['AttributeGroup'], "", [], 'AttributeGroup(id)');
963 :     # Return them.
964 :     return @retVal;
965 : parrello 1.3 }
966 :    
967 : parrello 1.10 =head3 GetAttributeData
968 : parrello 1.3
969 : parrello 1.10 C<< my %keys = $attrDB->GetAttributeData($type, @list); >>
970 : parrello 1.3
971 : parrello 1.10 Return attribute data for the selected attributes. The attribute
972 :     data is a hash mapping each attribute key name to a n-tuple containing the
973 :     data type, the description, and the groups. This is the same format expected in
974 :     the L</FieldMenu> and L</ControlForm> methods for the list of attributes to display.
975 : parrello 1.3
976 :     =over 4
977 :    
978 : parrello 1.10 =item type
979 : parrello 1.4
980 : parrello 1.10 Type of attribute criterion: C<name> for attributes whose names begin with the
981 :     specified string, or C<group> for attributes in the specified group.
982 : parrello 1.4
983 : parrello 1.10 =item list
984 : parrello 1.4
985 : parrello 1.10 List containing the names of the groups or keys for the desired attributes.
986 : parrello 1.4
987 :     =item RETURN
988 :    
989 : parrello 1.10 Returns a hash mapping each attribute key name to its data type, description, and
990 :     parent groups.
991 : parrello 1.4
992 :     =back
993 :    
994 :     =cut
995 :    
996 : parrello 1.10 sub GetAttributeData {
997 : parrello 1.4 # Get the parameters.
998 : parrello 1.10 my ($self, $type, @list) = @_;
999 :     # Set up a hash to store the attribute data.
1000 :     my %retVal = ();
1001 :     # Loop through the list items.
1002 :     for my $item (@list) {
1003 :     # Set up a query for the desired attributes.
1004 :     my $query;
1005 :     if ($type eq 'name') {
1006 :     # Here we're doing a generic name search. We need to escape it and then tack
1007 :     # on a %.
1008 :     my $parm = $item;
1009 :     $parm =~ s/_/\\_/g;
1010 :     $parm =~ s/%/\\%/g;
1011 :     $parm .= "%";
1012 :     # Ask for matching attributes. (Note that if the user passed in a null string
1013 :     # he'll get everything.)
1014 :     $query = $self->Get(['AttributeKey'], "AttributeKey(id) LIKE ?", [$parm]);
1015 :     } elsif ($type eq 'group') {
1016 :     $query = $self->Get(['IsInGroup', 'AttributeKey'], "IsInGroup(to-link) = ?", [$item]);
1017 : parrello 1.4 } else {
1018 : parrello 1.10 Confess("Unknown attribute query type \"$type\".");
1019 :     }
1020 :     while (my $row = $query->Fetch()) {
1021 :     # Get this attribute's data.
1022 :     my ($key, $type, $notes) = $row->Values(['AttributeKey(id)', 'AttributeKey(data-type)',
1023 :     'AttributeKey(description)']);
1024 :     # If it's new, get its groups and add it to the return hash.
1025 :     if (! exists $retVal{$key}) {
1026 :     my @groups = $self->GetFlat(['IsInGroup'], "IsInGroup(from-link) = ?",
1027 :     [$key], 'IsInGroup(to-link)');
1028 :     $retVal{$key} = [$type, $notes, @groups];
1029 : parrello 1.4 }
1030 :     }
1031 :     }
1032 :     # Return the result.
1033 : parrello 1.10 return %retVal;
1034 : parrello 1.4 }
1035 :    
1036 : parrello 1.18 =head3 LogOperation
1037 :    
1038 :     C<< $ca->LogOperation($action, $target, $description); >>
1039 :    
1040 :     Write an operation description to the attribute activity log (C<$FIG_Config::var/attributes.log>).
1041 :    
1042 :     =over 4
1043 :    
1044 :     =item action
1045 :    
1046 :     Action being logged (e.g. C<Delete Group> or C<Load Key>).
1047 :    
1048 :     =item target
1049 :    
1050 :     ID of the key or group affected.
1051 :    
1052 :     =item description
1053 :    
1054 :     Short description of the action.
1055 :    
1056 :     =back
1057 :    
1058 :     =cut
1059 :    
1060 :     sub LogOperation {
1061 :     # Get the parameters.
1062 :     my ($self, $action, $target, $description) = @_;
1063 :     # Get the user ID.
1064 :     my $user = $self->{user};
1065 :     # Get a timestamp.
1066 :     my $timeString = Tracer::Now();
1067 :     # Open the log file for appending.
1068 :     my $oh = Open(undef, ">>$FIG_Config::var/attributes.log");
1069 :     # Write the data to it.
1070 :     Tracer::PutLine($oh, [$timeString, $user, $action, $target, $description]);
1071 :     # Close the log file.
1072 :     close $oh;
1073 :     }
1074 :    
1075 : parrello 1.15 =head2 Internal Utility Methods
1076 :    
1077 :     =head3 _KeywordString
1078 :    
1079 :     C<< my $keywordString = $ca->_KeywordString($key, $value); >>
1080 :    
1081 :     Compute the keyword string for a specified key/value pair. This consists of the
1082 :     key name and value converted to lower case with underscores translated to spaces.
1083 :    
1084 :     This method is for internal use only. It is called whenever we need to update or
1085 :     insert a B<HasValueFor> record.
1086 :    
1087 :     =over 4
1088 :    
1089 :     =item key
1090 :    
1091 :     Name of the relevant attribute key.
1092 :    
1093 :     =item target
1094 :    
1095 :     ID of the target object to which this key/value pair will be associated.
1096 :    
1097 :     =item value
1098 :    
1099 :     The value to store for this key/object combination.
1100 :    
1101 :     =item RETURN
1102 :    
1103 :     Returns the value that should be stored as the keyword string for the specified
1104 :     key/value pair.
1105 :    
1106 :     =back
1107 :    
1108 :     =cut
1109 :    
1110 :     sub _KeywordString {
1111 :     # Get the parameters.
1112 :     my ($self, $key, $value) = @_;
1113 :     # Get a copy of the key name and convert underscores to spaces.
1114 :     my $keywordString = $key;
1115 :     $keywordString =~ s/_/ /g;
1116 :     # Add the value convert it all to lower case.
1117 :     my $retVal = lc "$keywordString $value";
1118 :     # Return the result.
1119 :     return $retVal;
1120 :     }
1121 :    
1122 :     =head3 _QueryResults
1123 :    
1124 :     C<< my @attributeList = $attrDB->_QueryResults($query, @values); >>
1125 :    
1126 :     Match the results of a B<HasValueFor> query against value criteria and return
1127 :     the results. This is an internal method that splits the values coming back
1128 :     and matches the sections against the specified section patterns. It serves
1129 :     as the back end to L</GetAttributes> and L</FindAttributes>.
1130 :    
1131 :     =over 4
1132 :    
1133 :     =item query
1134 :    
1135 :     A query object that will return the desired B<HasValueFor> records.
1136 :    
1137 :     =item values
1138 :    
1139 :     List of the desired attribute values, section by section. If C<undef>
1140 :     or an empty string is specified, all values in that section will match. A
1141 :     generic match can be requested by placing a percent sign (C<%>) at the end.
1142 :     In that case, all values that match up to and not including the percent sign
1143 :     will match. You may also specify a regular expression enclosed
1144 :     in slashes. All values that match the regular expression will be returned. For
1145 :     performance reasons, only values have this extra capability.
1146 :    
1147 :     =item RETURN
1148 :    
1149 :     Returns a list of tuples. The first element in the tuple is an object ID, the
1150 :     second is an attribute key, and the remaining elements are the sections of
1151 :     the attribute value. All of the tuples will match the criteria set forth in
1152 :     the parameter list.
1153 :    
1154 :     =back
1155 :    
1156 :     =cut
1157 :    
1158 :     sub _QueryResults {
1159 :     # Get the parameters.
1160 :     my ($self, $query, @values) = @_;
1161 :     # Declare the return value.
1162 :     my @retVal = ();
1163 :     # Get the number of value sections we have to match.
1164 :     my $sectionCount = scalar(@values);
1165 :     # Loop through the assignments found.
1166 :     while (my $row = $query->Fetch()) {
1167 :     # Get the current row's data.
1168 : parrello 1.20 my ($id, $realKey, $subKey, $valueString) = $row->Values(['HasValueFor(to-link)',
1169 :     'HasValueFor(from-link)',
1170 :     'HasValueFor(subkey)',
1171 :     'HasValueFor(value)'
1172 :     ]);
1173 :     # Form the key from the real key and the sub key.
1174 :     my $key = $self->JoinKey($realKey, $subKey);
1175 : parrello 1.15 # Break the value into sections.
1176 :     my @sections = split($self->{splitter}, $valueString);
1177 :     # Match each section against the incoming values. We'll assume we're
1178 :     # okay unless we learn otherwise.
1179 :     my $matching = 1;
1180 :     for (my $i = 0; $i < $sectionCount && $matching; $i++) {
1181 :     # We need to check to see if this section is generic.
1182 :     my $value = $values[$i];
1183 :     Trace("Current value pattern is \"$value\".") if T(4);
1184 :     if (substr($value, -1, 1) eq '%') {
1185 :     Trace("Generic match used.") if T(4);
1186 :     # Here we have a generic match.
1187 : parrello 1.20 my $matchLen = length($values[$i]) - 1;
1188 : parrello 1.15 $matching = substr($sections[$i], 0, $matchLen) eq
1189 :     substr($values[$i], 0, $matchLen);
1190 :     } elsif ($value =~ m#^/(.+)/[a-z]*$#) {
1191 :     Trace("Regular expression detected.") if T(4);
1192 :     # Here we have a regular expression match.
1193 :     my $section = $sections[$i];
1194 :     $matching = eval("\$section =~ $value");
1195 :     } else {
1196 :     # Here we have a strict match.
1197 :     Trace("Strict match used.") if T(4);
1198 :     $matching = ($sections[$i] eq $values[$i]);
1199 :     }
1200 :     }
1201 :     # If we match, output this row to the return list.
1202 :     if ($matching) {
1203 :     push @retVal, [$id, $key, @sections];
1204 :     }
1205 :     }
1206 :     # Return the rows found.
1207 :     return @retVal;
1208 :     }
1209 :    
1210 : parrello 1.3 =head2 FIG Method Replacements
1211 :    
1212 :     The following methods are used by B<FIG.pm> to replace the previous attribute functionality.
1213 : parrello 1.10 Some of the old functionality is no longer present: controlled vocabulary is no longer
1214 : parrello 1.3 supported and there is no longer any searching by URL. Fortunately, neither of these
1215 :     capabilities were used in the old system.
1216 :    
1217 : parrello 1.4 The methods here are the only ones supported by the B<RemoteCustomAttributes> object.
1218 :     The idea is that these methods represent attribute manipulation allowed by all users, while
1219 :     the others are only for privileged users with access to the attribute server.
1220 :    
1221 : parrello 1.20 In the previous implementation, an attribute had a value and a URL. In this implementation,
1222 :     each attribute has only a value. These methods will treat the value as a list with the individual
1223 :     elements separated by the value of the splitter parameter on the constructor (L</new>). The default
1224 :     is double colons C<::>.
1225 : parrello 1.3
1226 : parrello 1.10 So, for example, an old-style keyword with a value of C<essential> and a URL of
1227 : parrello 1.3 C<http://www.sciencemag.org/cgi/content/abstract/293/5538/2266> using the default
1228 :     splitter value would be stored as
1229 :    
1230 :     essential::http://www.sciencemag.org/cgi/content/abstract/293/5538/2266
1231 :    
1232 :     The best performance is achieved by searching for a particular key for a specified
1233 :     feature or genome.
1234 :    
1235 :     =head3 GetAttributes
1236 :    
1237 : parrello 1.10 C<< my @attributeList = $attrDB->GetAttributes($objectID, $key, @values); >>
1238 : parrello 1.3
1239 :     In the database, attribute values are sectioned into pieces using a splitter
1240 :     value specified in the constructor (L</new>). This is not a requirement of
1241 :     the attribute system as a whole, merely a convenience for the purpose of
1242 : parrello 1.10 these methods. If a value has multiple sections, each section
1243 :     is matched against the corresponding criterion in the I<@valuePatterns> list.
1244 : parrello 1.3
1245 :     This method returns a series of tuples that match the specified criteria. Each tuple
1246 :     will contain an object ID, a key, and one or more values. The parameters to this
1247 : parrello 1.10 method therefore correspond structurally to the values expected in each tuple. In
1248 :     addition, you can ask for a generic search by suffixing a percent sign (C<%>) to any
1249 :     of the parameters. So, for example,
1250 : parrello 1.3
1251 : parrello 1.10 my @attributeList = $attrDB->GetAttributes('fig|100226.1.peg.1004', 'structure%', 1, 2);
1252 : parrello 1.3
1253 :     would return something like
1254 :    
1255 :     ['fig}100226.1.peg.1004', 'structure', 1, 2]
1256 :     ['fig}100226.1.peg.1004', 'structure1', 1, 2]
1257 :     ['fig}100226.1.peg.1004', 'structure2', 1, 2]
1258 :     ['fig}100226.1.peg.1004', 'structureA', 1, 2]
1259 :    
1260 : parrello 1.10 Use of C<undef> in any position acts as a wild card (all values). You can also specify
1261 :     a list reference in the ID column. Thus,
1262 :    
1263 :     my @attributeList = $attrDB->GetAttributes(['100226.1', 'fig|100226.1.%'], 'PUBMED');
1264 :    
1265 :     would get the PUBMED attribute data for Streptomyces coelicolor A3(2) and all its
1266 :     features.
1267 : parrello 1.3
1268 :     In addition to values in multiple sections, a single attribute key can have multiple
1269 :     values, so even
1270 :    
1271 : parrello 1.10 my @attributeList = $attrDB->GetAttributes($peg, 'virulent');
1272 : parrello 1.3
1273 :     which has no wildcard in the key or the object ID, may return multiple tuples.
1274 :    
1275 : parrello 1.10 Value matching in this system works very poorly, because of the way multiple values are
1276 : parrello 1.20 stored. For the object ID, key name, and first value, we create queries that filter for the
1277 :     desired results. On any filtering by value, we must do a comparison after the attributes are
1278 :     retrieved from the database, since the database has no notion of the multiple values, which
1279 :     are stored in a single string. As a result, queries in which filter only on value end up
1280 :     reading a lot more than they need to.
1281 : parrello 1.3
1282 :     =over 4
1283 :    
1284 :     =item objectID
1285 :    
1286 : parrello 1.10 ID of object whose attributes are desired. If the attributes are desired for multiple
1287 :     objects, this parameter can be specified as a list reference. If the attributes are
1288 :     desired for all objects, specify C<undef> or an empty string. Finally, you can specify
1289 :     attributes for a range of object IDs by putting a percent sign (C<%>) at the end.
1290 : parrello 1.3
1291 :     =item key
1292 :    
1293 : parrello 1.10 Attribute key name. A value of C<undef> or an empty string will match all
1294 :     attribute keys. If the values are desired for multiple keys, this parameter can be
1295 :     specified as a list reference. Finally, you can specify attributes for a range of
1296 :     keys by putting a percent sign (C<%>) at the end.
1297 : parrello 1.3
1298 : parrello 1.10 =item values
1299 : parrello 1.3
1300 :     List of the desired attribute values, section by section. If C<undef>
1301 : parrello 1.10 or an empty string is specified, all values in that section will match. A
1302 :     generic match can be requested by placing a percent sign (C<%>) at the end.
1303 :     In that case, all values that match up to and not including the percent sign
1304 : parrello 1.14 will match. You may also specify a regular expression enclosed
1305 :     in slashes. All values that match the regular expression will be returned. For
1306 :     performance reasons, only values have this extra capability.
1307 : parrello 1.3
1308 :     =item RETURN
1309 :    
1310 :     Returns a list of tuples. The first element in the tuple is an object ID, the
1311 :     second is an attribute key, and the remaining elements are the sections of
1312 :     the attribute value. All of the tuples will match the criteria set forth in
1313 :     the parameter list.
1314 :    
1315 :     =back
1316 :    
1317 :     =cut
1318 :    
1319 :     sub GetAttributes {
1320 : parrello 1.4 # Get the parameters.
1321 : parrello 1.10 my ($self, $objectID, $key, @values) = @_;
1322 : parrello 1.20 # This hash will map "HasValueFor" fields to patterns. We use it to build the
1323 :     # SQL statement.
1324 :     my %data;
1325 :     # Before we do anything else, we must parse the key. The key is treated by the
1326 :     # user as a single field, but to us it's actually a real key and a subkey.
1327 :     # If the key has no splitter and is exact, the real key is the original key
1328 :     # and the subkey is an empty string. If the key has a splitter, it is
1329 :     # split into two pieces and each piece is processed separately. If the key has
1330 :     # no splitter and is generic, the real key is the incoming key and the subkey
1331 :     # is allowed to be wild. Of course, this only matters if an actual key has
1332 :     # been specified.
1333 :     if (defined $key) {
1334 :     if ($key =~ /$self->{splitter}/) {
1335 :     # Here we have a two-part key, so we split it normally.
1336 :     my ($realKey, $subKey) = $self->SplitKey($key);
1337 :     $data{'HasValueFor(from-link)'} = $realKey;
1338 :     $data{'HasValueFor(subkey)'} = $subKey;
1339 :     } elsif (substr($key, -1, 1) eq '%') {
1340 :     $data{'HasValueFor(from-link)'} = $key;
1341 :     } else {
1342 :     $data{'HasValueFor(from-link)'} = $key;
1343 :     $data{'HasValueFor(subkey)'} = '';
1344 :     }
1345 :     }
1346 :     # Add the object ID to the key information.
1347 :     $data{'HasValueFor(to-link)'} = $objectID;
1348 :     # The first value represents a problem, because we can search it using SQL, but not
1349 :     # in the normal way. If the user specifies a generic search or exact match for
1350 :     # every alternative value (remember, the values may be specified as a list),
1351 :     # then we can create SQL filtering for it. If any of the values are specified
1352 :     # as a regular expression, however, that's a problem, because we need to read
1353 :     # every value to verify a match.
1354 :     if (@values > 0) {
1355 :     # Get the first value and put its alternatives in an array.
1356 :     my $valueParm = $values[0];
1357 :     my @valueList;
1358 :     if (ref $valueParm eq 'ARRAY') {
1359 :     @valueList = @{$valueParm};
1360 :     } else {
1361 :     @valueList = ($valueParm);
1362 :     }
1363 :     # Okay, now we have all the possible criteria for the first value in the list
1364 :     # @valueList. We'll copy the values to a new array in which they have been
1365 :     # converted to generic requests. If we find a regular-expression match
1366 :     # anywhere in the list, we toss the whole thing.
1367 :     my @valuePatterns = ();
1368 :     my $okValues = 1;
1369 :     for my $valuePattern (@valueList) {
1370 :     # Check the pattern type.
1371 :     if (substr($valuePattern, 0, 1) eq '/') {
1372 :     # Regular expressions invalidate the entire process.
1373 :     $okValues = 0;
1374 :     } elsif (substr($valuePattern, -1, 1) eq '%') {
1375 :     # A Generic pattern is passed in unmodified.
1376 :     push @valuePatterns, $valuePattern;
1377 :     } else {
1378 :     # An exact match is converted to generic.
1379 :     push @valuePatterns, "$valuePattern%";
1380 :     }
1381 :     }
1382 :     # If everything works, add the value data to the filtering hash.
1383 :     if ($okValues) {
1384 :     $data{'HasValueFor(value)'} = \@valuePatterns;
1385 :     }
1386 :     }
1387 :     # Create some lists to contain the filter fragments and parameter values.
1388 : parrello 1.10 my @filter = ();
1389 :     my @parms = ();
1390 :     # This next loop goes through the different fields that can be specified in the
1391 : parrello 1.20 # parameter list and generates filters for each. The %data hash that we built above
1392 :     # contains all the necessary information to do this.
1393 : parrello 1.10 for my $field (keys %data) {
1394 :     # Accumulate filter information for this field. We will OR together all the
1395 :     # elements accumulated to create the final result.
1396 :     my @fieldFilter = ();
1397 :     # Get the specified data from the caller.
1398 :     my $fieldPattern = $data{$field};
1399 :     # Only proceed if the pattern is one that won't match everything.
1400 :     if (defined($fieldPattern) && $fieldPattern ne "" && $fieldPattern ne "%") {
1401 :     # Convert the pattern to an array.
1402 :     my @patterns = ();
1403 :     if (ref $fieldPattern eq 'ARRAY') {
1404 :     push @patterns, @{$fieldPattern};
1405 :     } else {
1406 :     push @patterns, $fieldPattern;
1407 :     }
1408 :     # Only proceed if the array is nonempty. The loop will work fine if the
1409 :     # array is empty, but when we build the filter string at the end we'll
1410 :     # get "()" in the filter list, which will result in an SQL syntax error.
1411 :     if (@patterns) {
1412 :     # Loop through the individual patterns.
1413 :     for my $pattern (@patterns) {
1414 :     # Check for a generic request.
1415 :     if (substr($pattern, -1, 1) ne '%') {
1416 :     # Here we have a normal request.
1417 :     push @fieldFilter, "$field = ?";
1418 :     push @parms, $pattern;
1419 :     } else {
1420 : parrello 1.20 # Here we have a generic request, so we will use the LIKE operator to
1421 : parrello 1.10 # filter the field to this value pattern.
1422 :     push @fieldFilter, "$field LIKE ?";
1423 :     # We must convert the pattern value to an SQL match pattern. First
1424 : parrello 1.11 # we get a copy of it.
1425 :     my $actualPattern = $pattern;
1426 : parrello 1.10 # Now we escape the underscores. Underscores are an SQL wild card
1427 :     # character, but they are used frequently in key names and object IDs.
1428 : parrello 1.11 $actualPattern =~ s/_/\\_/g;
1429 : parrello 1.10 # Add the escaped pattern to the bound parameter list.
1430 :     push @parms, $actualPattern;
1431 :     }
1432 :     }
1433 :     # Form the filter for this field.
1434 :     my $fieldFilterString = join(" OR ", @fieldFilter);
1435 :     push @filter, "($fieldFilterString)";
1436 :     }
1437 :     }
1438 :     }
1439 :     # Now @filter contains one or more filter strings and @parms contains the parameter
1440 :     # values to bind to them.
1441 :     my $actualFilter = join(" AND ", @filter);
1442 :     # Now we're ready to make our query.
1443 : parrello 1.11 my $query = $self->Get(['HasValueFor'], $actualFilter, \@parms);
1444 : parrello 1.15 # Format the results.
1445 :     my @retVal = $self->_QueryResults($query, @values);
1446 : parrello 1.10 # Return the rows found.
1447 : parrello 1.3 return @retVal;
1448 :     }
1449 :    
1450 :     =head3 AddAttribute
1451 :    
1452 :     C<< $attrDB->AddAttribute($objectID, $key, @values); >>
1453 :    
1454 :     Add an attribute key/value pair to an object. This method cannot add a new key, merely
1455 :     add a value to an existing key. Use L</StoreAttributeKey> to create a new key.
1456 :    
1457 :     =over 4
1458 :    
1459 :     =item objectID
1460 :    
1461 : parrello 1.10 ID of the object to which the attribute is to be added.
1462 : parrello 1.3
1463 :     =item key
1464 :    
1465 : parrello 1.10 Attribute key name.
1466 : parrello 1.3
1467 :     =item values
1468 :    
1469 :     One or more values to be associated with the key. The values are joined together with
1470 :     the splitter value before being stored as field values. This enables L</GetAttributes>
1471 :     to split them apart during retrieval. The splitter value defaults to double colons C<::>.
1472 :    
1473 :     =back
1474 :    
1475 :     =cut
1476 :    
1477 :     sub AddAttribute {
1478 :     # Get the parameters.
1479 : parrello 1.4 my ($self, $objectID, $key, @values) = @_;
1480 : parrello 1.3 # Don't allow undefs.
1481 :     if (! defined($objectID)) {
1482 :     Confess("No object ID specified for AddAttribute call.");
1483 :     } elsif (! defined($key)) {
1484 :     Confess("No attribute key specified for AddAttribute call.");
1485 :     } elsif (! @values) {
1486 :     Confess("No values specified in AddAttribute call for key $key.");
1487 :     } else {
1488 : parrello 1.11 # Okay, now we have some reason to believe we can do this. Form the values
1489 :     # into a scalar.
1490 : parrello 1.3 my $valueString = join($self->{splitter}, @values);
1491 : parrello 1.20 # Split up the key.
1492 :     my ($realKey, $subKey) = $self->SplitKey($key);
1493 : parrello 1.11 # Connect the object to the key.
1494 : parrello 1.20 $self->InsertObject('HasValueFor', { 'from-link' => $realKey,
1495 : parrello 1.11 'to-link' => $objectID,
1496 : parrello 1.20 'subkey' => $subKey,
1497 : parrello 1.11 'value' => $valueString,
1498 :     });
1499 : parrello 1.3 }
1500 : parrello 1.10 # Return a one, indicating success. We do this for backward compatability.
1501 : parrello 1.3 return 1;
1502 :     }
1503 :    
1504 :     =head3 DeleteAttribute
1505 :    
1506 :     C<< $attrDB->DeleteAttribute($objectID, $key, @values); >>
1507 :    
1508 :     Delete the specified attribute key/value combination from the database.
1509 :    
1510 :     =over 4
1511 :    
1512 :     =item objectID
1513 :    
1514 : parrello 1.10 ID of the object whose attribute is to be deleted.
1515 : parrello 1.3
1516 :     =item key
1517 :    
1518 : parrello 1.10 Attribute key name.
1519 : parrello 1.3
1520 :     =item values
1521 :    
1522 : parrello 1.10 One or more values associated with the key. If no values are specified, then all values
1523 :     will be deleted. Otherwise, only a matching value will be deleted.
1524 : parrello 1.3
1525 :     =back
1526 :    
1527 :     =cut
1528 :    
1529 :     sub DeleteAttribute {
1530 :     # Get the parameters.
1531 : parrello 1.4 my ($self, $objectID, $key, @values) = @_;
1532 : parrello 1.3 # Don't allow undefs.
1533 :     if (! defined($objectID)) {
1534 :     Confess("No object ID specified for DeleteAttribute call.");
1535 :     } elsif (! defined($key)) {
1536 :     Confess("No attribute key specified for DeleteAttribute call.");
1537 :     } else {
1538 : parrello 1.20 # Split the key into the real key and the subkey.
1539 :     my ($realKey, $subKey) = $self->SplitKey($key);
1540 :     if ($subKey eq '' && scalar(@values) == 0) {
1541 :     # Here we erase the entire key for this object.
1542 :     $self->DeleteRow('HasValueFor', $key, $objectID);
1543 :     } else {
1544 :     # Here we erase the matching values.
1545 :     my $valueString = join($self->{splitter}, @values);
1546 :     $self->DeleteRow('HasValueFor', $realKey, $objectID,
1547 :     { subkey => $subKey, value => $valueString });
1548 :     }
1549 : parrello 1.3 }
1550 :     # Return a one. This is for backward compatability.
1551 :     return 1;
1552 :     }
1553 :    
1554 : parrello 1.16 =head3 DeleteMatchingAttributes
1555 :    
1556 :     C<< my @deleted = $attrDB->DeleteMatchingAttributes($objectID, $key, @values); >>
1557 :    
1558 :     Delete all attributes that match the specified criteria. This is equivalent to
1559 :     calling L</GetAttributes> and then invoking L</DeleteAttribute> for each
1560 :     row found.
1561 :    
1562 :     =over 4
1563 :    
1564 :     =item objectID
1565 :    
1566 :     ID of object whose attributes are to be deleted. If the attributes for multiple
1567 :     objects are to be deleted, this parameter can be specified as a list reference. If
1568 :     attributes are to be deleted for all objects, specify C<undef> or an empty string.
1569 :     Finally, you can delete attributes for a range of object IDs by putting a percent
1570 :     sign (C<%>) at the end.
1571 :    
1572 :     =item key
1573 :    
1574 :     Attribute key name. A value of C<undef> or an empty string will match all
1575 :     attribute keys. If the values are to be deletedfor multiple keys, this parameter can be
1576 :     specified as a list reference. Finally, you can delete attributes for a range of
1577 :     keys by putting a percent sign (C<%>) at the end.
1578 :    
1579 :     =item values
1580 :    
1581 :     List of the desired attribute values, section by section. If C<undef>
1582 :     or an empty string is specified, all values in that section will match. A
1583 :     generic match can be requested by placing a percent sign (C<%>) at the end.
1584 :     In that case, all values that match up to and not including the percent sign
1585 :     will match. You may also specify a regular expression enclosed
1586 :     in slashes. All values that match the regular expression will be deleted. For
1587 :     performance reasons, only values have this extra capability.
1588 :    
1589 :     =item RETURN
1590 :    
1591 :     Returns a list of tuples for the attributes that were deleted, in the
1592 :     same form as L</GetAttributes>.
1593 :    
1594 :     =back
1595 :    
1596 :     =cut
1597 :    
1598 :     sub DeleteMatchingAttributes {
1599 :     # Get the parameters.
1600 :     my ($self, $objectID, $key, @values) = @_;
1601 :     # Get the matching attributes.
1602 :     my @retVal = $self->GetAttributes($objectID, $key, @values);
1603 :     # Loop through the attributes, deleting them.
1604 :     for my $tuple (@retVal) {
1605 :     $self->DeleteAttribute(@{$tuple});
1606 :     }
1607 : parrello 1.18 # Log this operation.
1608 :     my $count = @retVal;
1609 :     $self->LogOperation("Mass Delete", $key, "$count matching attributes deleted.");
1610 : parrello 1.16 # Return the deleted attributes.
1611 :     return @retVal;
1612 :     }
1613 :    
1614 : parrello 1.3 =head3 ChangeAttribute
1615 :    
1616 :     C<< $attrDB->ChangeAttribute($objectID, $key, \@oldValues, \@newValues); >>
1617 :    
1618 :     Change the value of an attribute key/value pair for an object.
1619 :    
1620 :     =over 4
1621 :    
1622 :     =item objectID
1623 :    
1624 :     ID of the genome or feature to which the attribute is to be changed. In general, an ID that
1625 :     starts with C<fig|> is treated as a feature ID, and an ID that is all digits and periods
1626 :     is treated as a genome ID. For IDs of other types, this parameter should be a reference
1627 :     to a 2-tuple consisting of the entity type name followed by the object ID.
1628 :    
1629 :     =item key
1630 :    
1631 :     Attribute key name. This corresponds to the name of a field in the database.
1632 :    
1633 :     =item oldValues
1634 :    
1635 :     One or more values identifying the key/value pair to change.
1636 :    
1637 :     =item newValues
1638 :    
1639 :     One or more values to be put in place of the old values.
1640 :    
1641 :     =back
1642 :    
1643 :     =cut
1644 :    
1645 :     sub ChangeAttribute {
1646 :     # Get the parameters.
1647 : parrello 1.4 my ($self, $objectID, $key, $oldValues, $newValues) = @_;
1648 : parrello 1.3 # Don't allow undefs.
1649 :     if (! defined($objectID)) {
1650 :     Confess("No object ID specified for ChangeAttribute call.");
1651 :     } elsif (! defined($key)) {
1652 :     Confess("No attribute key specified for ChangeAttribute call.");
1653 :     } elsif (! defined($oldValues) || ref $oldValues ne 'ARRAY') {
1654 :     Confess("No old values specified in ChangeAttribute call for key $key.");
1655 :     } elsif (! defined($newValues) || ref $newValues ne 'ARRAY') {
1656 :     Confess("No new values specified in ChangeAttribute call for key $key.");
1657 :     } else {
1658 : parrello 1.10 # We do the change as a delete/add.
1659 : parrello 1.3 $self->DeleteAttribute($objectID, $key, @{$oldValues});
1660 :     $self->AddAttribute($objectID, $key, @{$newValues});
1661 :     }
1662 :     # Return a one. We do this for backward compatability.
1663 :     return 1;
1664 :     }
1665 :    
1666 : parrello 1.7 =head3 EraseAttribute
1667 :    
1668 : parrello 1.11 C<< $attrDB->EraseAttribute($key); >>
1669 : parrello 1.7
1670 :     Erase all values for the specified attribute key. This does not remove the
1671 :     key from the database; it merely removes all the values.
1672 :    
1673 :     =over 4
1674 :    
1675 :     =item key
1676 :    
1677 : parrello 1.20 Key to erase. This must be a real key; that is, it cannot have a subkey
1678 :     component.
1679 : parrello 1.7
1680 :     =back
1681 :    
1682 :     =cut
1683 :    
1684 :     sub EraseAttribute {
1685 :     # Get the parameters.
1686 : parrello 1.10 my ($self, $key) = @_;
1687 : parrello 1.16 # Delete everything connected to the key.
1688 :     $self->Disconnect('HasValueFor', 'AttributeKey', $key);
1689 : parrello 1.18 # Log the operation.
1690 :     $self->LogOperation("Erase Data", $key);
1691 : parrello 1.7 # Return a 1, for backward compatability.
1692 :     return 1;
1693 :     }
1694 :    
1695 : parrello 1.9 =head3 GetAttributeKeys
1696 :    
1697 : parrello 1.10 C<< my @keyList = $attrDB->GetAttributeKeys($groupName); >>
1698 : parrello 1.9
1699 : parrello 1.10 Return a list of the attribute keys for a particular group.
1700 : parrello 1.9
1701 :     =over 4
1702 :    
1703 : parrello 1.10 =item groupName
1704 : parrello 1.9
1705 : parrello 1.10 Name of the group whose keys are desired.
1706 : parrello 1.9
1707 :     =item RETURN
1708 :    
1709 : parrello 1.10 Returns a list of the attribute keys for the specified group.
1710 : parrello 1.9
1711 :     =back
1712 :    
1713 :     =cut
1714 :    
1715 :     sub GetAttributeKeys {
1716 :     # Get the parameters.
1717 : parrello 1.10 my ($self, $groupName) = @_;
1718 :     # Get the attributes for the specified group.
1719 :     my @groups = $self->GetFlat(['IsInGroup'], "IsInGroup(to-link) = ?", [$groupName],
1720 :     'IsInGroup(from-link)');
1721 : parrello 1.9 # Return the keys.
1722 : parrello 1.10 return sort @groups;
1723 : parrello 1.9 }
1724 :    
1725 : parrello 1.20 =head2 Key and ID Manipulation Methods
1726 :    
1727 : parrello 1.19 =head3 ParseID
1728 :    
1729 :     C<< my ($type, $id) = CustomAttributes::ParseID($idValue); >>
1730 :    
1731 :     Determine the type and object ID corresponding to an ID value from the attribute database.
1732 :     Most ID values consist of a type name and an ID, separated by a colon (e.g. C<Family:aclame|cluster10>);
1733 :     however, Genomes, Features, and Subsystems are not stored with a type name, so we need to
1734 :     deduce the type from the ID value structure.
1735 :    
1736 :     The theory here is that you can plug the ID and type directly into a Sprout database method, as
1737 :     follows
1738 :    
1739 :     my ($type, $id) = CustomAttributes::ParseID($attrList[$num]->[0]);
1740 :     my $target = $sprout->GetEntity($type, $id);
1741 :    
1742 :     =over 4
1743 :    
1744 :     =item idValue
1745 :    
1746 :     ID value taken from the attribute database.
1747 :    
1748 :     =item RETURN
1749 :    
1750 :     Returns a two-element list. The first element is the type of object indicated by the ID value,
1751 :     and the second element is the actual object ID.
1752 :    
1753 :     =back
1754 :    
1755 :     =cut
1756 :    
1757 :     sub ParseID {
1758 :     # Get the parameters.
1759 :     my ($idValue) = @_;
1760 :     # Declare the return variables.
1761 :     my ($type, $id);
1762 :     # Parse the incoming ID. We first check for the presence of an entity name. Entity names
1763 :     # can only contain letters, which helps to insure typed object IDs don't collide with
1764 :     # subsystem names (which are untyped).
1765 :     if ($idValue =~ /^([A-Za-z]+):(.+)/) {
1766 :     # Here we have a typed ID.
1767 :     ($type, $id) = ($1, $2);
1768 :     } elsif ($idValue =~ /fig\|/) {
1769 :     # Here we have a feature ID.
1770 :     ($type, $id) = (Feature => $idValue);
1771 :     } elsif ($idValue =~ /\d+\.\d+/) {
1772 :     # Here we have a genome ID.
1773 :     ($type, $id) = (Genome => $idValue);
1774 :     } else {
1775 :     # The default is a subsystem ID.
1776 :     ($type, $id) = (Subsystem => $idValue);
1777 :     }
1778 :     # Return the results.
1779 :     return ($type, $id);
1780 :     }
1781 :    
1782 :     =head3 FormID
1783 :    
1784 :     C<< my $idValue = CustomAttributes::FormID($type, $id); >>
1785 :    
1786 :     Convert an object type and ID pair into an object ID string for the attribute system. Subsystems,
1787 :     genomes, and features are stored in the database without type information, but all other object IDs
1788 :     must be prefixed with the object type.
1789 :    
1790 :     =over 4
1791 :    
1792 :     =item type
1793 :    
1794 :     Relevant object type.
1795 :    
1796 :     =item id
1797 :    
1798 :     ID of the object in question.
1799 :    
1800 :     =item RETURN
1801 :    
1802 :     Returns a string that will be recognized as an object ID in the attribute database.
1803 :    
1804 :     =back
1805 :    
1806 :     =cut
1807 :    
1808 :     sub FormID {
1809 :     # Get the parameters.
1810 :     my ($type, $id) = @_;
1811 :     # Declare the return variable.
1812 :     my $retVal;
1813 :     # Compute the ID string from the type.
1814 :     if (grep { $type eq $_ } qw(Feature Genome Subsystem)) {
1815 :     $retVal = $id;
1816 :     } else {
1817 :     $retVal = "$type:$id";
1818 :     }
1819 :     # Return the result.
1820 :     return $retVal;
1821 :     }
1822 :    
1823 :     =head3 GetTargetObject
1824 :    
1825 :     C<< my $object = CustomAttributes::GetTargetObject($erdb, $idValue); >>
1826 :    
1827 :     Return the database object corresponding to the specified attribute object ID. The
1828 :     object type associated with the ID value must correspond to an entity name in the
1829 :     specified database.
1830 :    
1831 :     =over 4
1832 :    
1833 :     =item erdb
1834 :    
1835 :     B<ERDB> object for accessing the target database.
1836 :    
1837 :     =item idValue
1838 :    
1839 :     ID value retrieved from the attribute database.
1840 :    
1841 :     =item RETURN
1842 :    
1843 :     Returns a B<DBObject> for the attribute value's target object.
1844 :    
1845 :     =back
1846 :    
1847 :     =cut
1848 :    
1849 :     sub GetTargetObject {
1850 :     # Get the parameters.
1851 :     my ($erdb, $idValue) = @_;
1852 :     # Declare the return variable.
1853 :     my $retVal;
1854 :     # Get the type and ID for the target object.
1855 :     my ($type, $id) = ParseID($idValue);
1856 :     # Plug them into the GetEntity method.
1857 :     $retVal = $erdb->GetEntity($type, $id);
1858 :     # Return the resulting object.
1859 :     return $retVal;
1860 :     }
1861 :    
1862 : parrello 1.20 =head3 SplitKey
1863 :    
1864 :     C<< my ($realKey, $subKey) = $ca->SplitKey($key); >>
1865 :    
1866 :     Split an external key (that is, one passed in by a caller) into the real key and the sub key.
1867 :     The real and sub keys are separated by a splitter value (usually C<::>). If there is no splitter,
1868 :     then the sub key is presumed to be an empty string.
1869 :    
1870 :     =over 4
1871 :    
1872 :     =item key
1873 :    
1874 :     Incoming key to be split.
1875 :    
1876 :     =item RETURN
1877 :    
1878 :     Returns a two-element list, the first element of which is the real key and the second element of
1879 :     which is the sub key.
1880 :    
1881 :     =back
1882 :    
1883 :     =cut
1884 :    
1885 :     sub SplitKey {
1886 :     # Get the parameters.
1887 :     my ($self, $key) = @_;
1888 :     # Do the split.
1889 :     my ($realKey, $subKey) = split($self->{splitter}, $key, 2);
1890 :     # Insure the subkey has a value.
1891 :     if (! defined $subKey) {
1892 :     $subKey = '';
1893 :     }
1894 :     # Return the results.
1895 :     return ($realKey, $subKey);
1896 :     }
1897 :    
1898 :     =head3 JoinKey
1899 :    
1900 :     C<< my $key = $ca->JoinKey($realKey, $subKey); >>
1901 :    
1902 :     Join a real key and a subkey together to make an external key. The external key is the attribute key
1903 :     used by the caller. The real key and the subkey are how the keys are represented in the database. The
1904 :     real key is the key to the B<AttributeKey> entity. The subkey is an attribute of the B<HasValueFor>
1905 :     relationship.
1906 :    
1907 :     =over 4
1908 :    
1909 :     =item realKey
1910 :    
1911 :     The real attribute key.
1912 :    
1913 :     =item subKey
1914 :    
1915 :     The subordinate portion of the attribute key.
1916 :    
1917 :     =item RETURN
1918 :    
1919 :     Returns a single string representing both keys.
1920 :    
1921 :     =back
1922 :    
1923 :     =cut
1924 :    
1925 :     sub JoinKey {
1926 :     # Get the parameters.
1927 :     my ($self, $realKey, $subKey) = @_;
1928 :     # Declare the return variable.
1929 :     my $retVal;
1930 :     # Check for a subkey.
1931 :     if ($subKey eq '') {
1932 :     # No subkey, so the real key is the key.
1933 :     $retVal = $realKey;
1934 :     } else {
1935 :     # Subkey found, so the two pieces must be joined by a splitter.
1936 :     $retVal = "$realKey$self->{splitter}$subKey";
1937 :     }
1938 :     # Return the result.
1939 :     return $retVal;
1940 :     }
1941 :    
1942 : parrello 1.1 1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3