trunk/MWS/Indexer.pm

#!/usr/bin/perl -w

package MWS::Indexer;
use base 'MWS';
use strict;
use warnings;

use MWS;

our @ISA = qw(MWS);

our $VERSION = '1.00';

=head1 NAME

MWS::Indexer - index your data

=head1 DESCRIPTION

This is class which defines couple of methods which don't have to
be implemented for all indexers.

=head1 METHODS

=cut

=head2 open_index

This will open index in directory C<index_dir> in configuration file
with name which is same as name of configuration.

 my $index = $self->open_index;

It saves index handle into $self->{index} and returns it.

=cut

=head2 create_index

This method will be called before index creation. If indexes support
on-the-fly adding to index (as Plucene does) this function is dummy.
However, for swish-e it will do magic (see L<MWS::SWISH>).

=cut

sub create_index {
        my $self = shift;

}

=head2 close_index

Dummy method.

=cut

sub close_index {
        my $self = shift;

        print STDERR "dummy close_index called\n";

}

=head2 apropos_index

Dummy method.

=cut

sub apropos_index {
        my $self = shift;

        print STDERR "dummy apropos_index called\n";

}

1;
1	#!/usr/bin/perl -w
2
3	package MWS::Indexer;
4	use base 'MWS';
5	use strict;
6	use warnings;
7
8	use MWS;
9
10	our @ISA = qw(MWS);
11
12	our $VERSION = '1.00';
13
14	=head1 NAME
15
16	MWS::Indexer - index your data
17
18	=head1 DESCRIPTION
19
20	This is class which defines couple of methods which don't have to
21	be implemented for all indexers.
22
23	=head1 METHODS
24
25	=cut
26
27	=head2 open_index
28
29	This will open index in directory C<index_dir> in configuration file
30	with name which is same as name of configuration.
31
32	my $index = $self->open_index;
33
34	It saves index handle into $self->{index} and returns it.
35
36	=cut
37
38	=head2 create_index
39
40	This method will be called before index creation. If indexes support
41	on-the-fly adding to index (as Plucene does) this function is dummy.
42	However, for swish-e it will do magic (see L<MWS::SWISH>).
43
44	=cut
45
46	sub create_index {
47	my $self = shift;
48
49	}
50
51	=head2 close_index
52
53	Dummy method.
54
55	=cut
56
57	sub close_index {
58	my $self = shift;
59
60	print STDERR "dummy close_index called\n";
61
62	}
63
64	=head2 apropos_index
65
66	Dummy method.
67
68	=cut
69
70	sub apropos_index {
71	my $self = shift;
72
73	print STDERR "dummy apropos_index called\n";
74
75	}
76
77	1;