| 3 |
|
# |
| 4 |
|
# Originally Written by Christopher Williams |
| 5 |
|
# |
| 6 |
– |
# Description |
| 7 |
– |
# |
| 8 |
– |
# Interface |
| 9 |
– |
# --------- |
| 10 |
– |
# new() : A new HashDB object |
| 11 |
– |
# setdata(data, @keys) : set a data item to the given keys |
| 12 |
– |
# getdata(@keys) : return all data items that match the given keys |
| 13 |
– |
# deletedata(@keys) : detete all data items that match the given keys |
| 14 |
– |
# match(@keys) : return the full DataItem object refs that match keys |
| 15 |
– |
# items() : return the number of seperate items in the store |
| 16 |
– |
# store(filename) : dump to file |
| 17 |
– |
# restore(filename) : restore from file |
| 18 |
– |
# alias(\@refofkeys,\@aliaskeys) : attatch another set of keys to items that |
| 19 |
– |
# match the refopfkeys |
| 20 |
– |
# note that these are references to the arrays |
| 21 |
– |
# unalias(@aliaskeys) :remove an alias |
| 6 |
|
|
| 7 |
+ |
=head1 NAME |
| 8 |
+ |
|
| 9 |
+ |
Utilities::HashDB - A type of database object. |
| 10 |
+ |
|
| 11 |
+ |
=head1 SYNOPSIS |
| 12 |
+ |
|
| 13 |
+ |
my $obj = Utilities::HashDB->new(); |
| 14 |
+ |
|
| 15 |
+ |
=head1 METHODS |
| 16 |
+ |
|
| 17 |
+ |
=over |
| 18 |
+ |
|
| 19 |
+ |
=cut |
| 20 |
+ |
|
| 21 |
+ |
=item C<new()> |
| 22 |
+ |
|
| 23 |
+ |
Create a new HashDB object. |
| 24 |
+ |
|
| 25 |
+ |
=item C<setdata(data, @keys)> |
| 26 |
+ |
|
| 27 |
+ |
set a data item to the given keys. |
| 28 |
+ |
|
| 29 |
+ |
=item C<getdata(@keys)> |
| 30 |
+ |
|
| 31 |
+ |
return all data items that match the given keys. |
| 32 |
+ |
|
| 33 |
+ |
=item C<deletedata(@keys)> |
| 34 |
+ |
|
| 35 |
+ |
detete all data items that match the given keys. |
| 36 |
+ |
|
| 37 |
+ |
=item C<match(@keys)> |
| 38 |
+ |
|
| 39 |
+ |
return the full DataItem object refs that match keys. |
| 40 |
+ |
|
| 41 |
+ |
=item C<items()> |
| 42 |
+ |
|
| 43 |
+ |
return the number of seperate items in the store. |
| 44 |
+ |
|
| 45 |
+ |
=item C<store(filename)> |
| 46 |
+ |
|
| 47 |
+ |
dump to file. |
| 48 |
+ |
|
| 49 |
+ |
=item C<restore(filename)> |
| 50 |
+ |
|
| 51 |
+ |
restore from file. |
| 52 |
+ |
|
| 53 |
+ |
=item C<alias(\@refofkeys,\@aliaskeys)> |
| 54 |
+ |
|
| 55 |
+ |
attatch another set of keys to items that |
| 56 |
+ |
match the refopfkeys (note that these are |
| 57 |
+ |
references to the arrays). |
| 58 |
+ |
|
| 59 |
+ |
=item unalias(@aliaskeys) |
| 60 |
+ |
|
| 61 |
+ |
remove an alias. |
| 62 |
+ |
|
| 63 |
+ |
=back |
| 64 |
+ |
|
| 65 |
+ |
=head1 AUTHOR |
| 66 |
+ |
|
| 67 |
+ |
Originally Written by Christopher Williams. |
| 68 |
+ |
|
| 69 |
+ |
=head1 MAINTAINER |
| 70 |
+ |
|
| 71 |
+ |
Shaun ASHBY L<mailTo:Shaun.Ashby@cern.ch> |
| 72 |
+ |
|
| 73 |
+ |
=cut |
| 74 |
+ |
|
| 75 |
|
package Utilities::HashDB; |
| 76 |
|
use Utilities::DataItem; |
| 77 |
|
use FileHandle; |
