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

Annotation of /Sprout/CustomAttributes.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3