root/gs2-extensions/tdb/trunk/perllib/DBDrivers/GDBM.pm @ 30342

Revision 30342, 3.2 KB (checked in by jmt12, 4 years ago)

GDBM now lets callers know it supports set_entry functionality

  • Property svn:executable set to *
Line 
1###############################################################################
2#
3# GDBM.pm -- utility functions for writing to gdbm databases
4#
5# A component of the Greenstone digital library software from the New Zealand
6# Digital Library Project at the University of Waikato, New Zealand.
7#
8# Copyright (C) 1999-2015 New Zealand Digital Library Project
9#
10# This program is free software; you can redistribute it and/or modify it under
11# the terms of the GNU General Public License as published by the Free Software
12# Foundation; either version 2 of the License, or (at your option) any later
13# version.
14#
15# This program is distributed in the hope that it will be useful, but WITHOUT
16# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
18# more details.
19#
20# You should have received a copy of the GNU General Public License along with
21# this program; if not, write to the Free Software Foundation, Inc., 675 Mass
22# Ave, Cambridge, MA 02139, USA.
23#
24###############################################################################
25
26package DBDrivers::GDBM;
27
28# Pragma
29use strict;
30
31# Libraries
32use util;
33use FileUtils;
34use parent 'DBDrivers::70HyphenFormat';
35
36
37## @function constructor
38#
39sub new
40{
41    my $class = shift(@_);
42    my $self = DBDrivers::70HyphenFormat->new(@_);
43    $self->{'default_file_extension'} = 'gdb';
44    # note: file separator agnostic
45    $self->{'executable_path'} = $ENV{'GSDLHOME'} . '/bin/' . $ENV{'GSDLOS'};
46    $self->{'read_executable'} = 'db2txt';
47    $self->{'keyread_executable'} = 'gdbmkeys';
48    $self->{'write_executable'} = 'txt2db';
49    $self->{'supports_set'} = 1;
50    bless($self, $class);
51    return $self;
52}
53## new(void) => GDBM ##
54
55
56# -----------------------------------------------------------------------------
57#   GDBM IMPLEMENTATION
58# -----------------------------------------------------------------------------
59
60# Handled by BaseDBDriver
61# sub get_infodb_file_path(string, string)
62
63# Handled by 70HyphenFormat
64# sub close_infodb_write_handle(filehandle) => void
65# sub delete_infodb_entry(filehandle, string) => void
66# sub read_infodb_entry(string, string) => hashmap
67# sub read_infodb_file(string, hashmap) => void
68# sub read_infodb_keys(string, hashmap) => void
69# sub read_infodb_rawentry(string, string) => string
70# sub set_infodb_entry(string, string, hashmap) => integer
71# sub write_infodb_entry(filehandle, string, hashmap) => void
72# sub write_infodb_rawentry(filehandle, string, string) => void
73
74
75## @function open_infodb_write_handle(string, string*) => filehandle
76#
77#  Handles legacy use of optional 'append' argument where '-append' is required
78#
79sub open_infodb_write_handle
80{
81    my $self = shift(@_);
82    my $infodb_file_path = shift(@_);
83    my $opt_append = shift(@_);
84    my $infodb_file_handle;
85    if (defined $opt_append) {
86    if ($opt_append eq 'append') {
87        $opt_append = '-append';
88    }
89    $infodb_file_handle = $self->SUPER::open_infodb_write_handle($infodb_file_path, $opt_append);
90    }
91    else
92    {
93    $infodb_file_handle = $self->SUPER::open_infodb_write_handle($infodb_file_path);
94    }
95    return $infodb_file_handle;
96}
97## open_infodb_write_handle(string, string*) => filehandle ##
98
991;
Note: See TracBrowser for help on using the browser.