NAME

DTA::TokWrap::Processor::mkindex - DTA tokenizer wrappers: dtatw-mkindex

SYNOPSIS

 use DTA::TokWrap::Processor::mkindex;
 
 $mi = DTA::TokWrap::Processor::mkindex->new(%opts);
 $doc_or_undef = $mi->mkindex($doc);

DESCRIPTION

DTA::TokWrap::Processor::mkindex provides an object-oriented DTA::TokWrap::Processor wrapper around the dtatw-mkindex C program for DTA::TokWrap::Document objects.

Most users should use the high-level DTA::TokWrap wrapper class instead of using this module directly.

Constants

@ISA: DTA::TokWrap::Processor::mkindex inherits from DTA::TokWrap::Processor.

Constructors etc.

new

 $obj = $CLASS_OR_OBJECT->new(%args);

Constructor.

%args, %$obj:

 mkindex => $path_to_dtatw_mkindex, ##-- default: search
 inplace => $bool,                  ##-- prefer in-place programs for search?

defaults

 %defaults = $CLASS->defaults();

Static class-dependent defaults.

init

 $mi = $mi->init();

Dynamic object-dependent defaults.

Methods

mkindex

 $doc_or_undef = $CLASS_OR_OBJECT->mkindex($doc);

Runs the dtatw-mkindex program on the DTA::TokWrap::Document object $doc.

Relevant %$doc keys:

 xmlfile => $xmlfile,  ##-- (input) source base-format XML file
 cxfile  => $cxfile,   ##-- (output) character index filename
 sxfile  => $sxfile,   ##-- (output) structure index filename
 txfile  => $txfile,   ##-- (output) structure index filename
 ##
 mkindex_stamp0 => $f, ##-- (output) timestamp of operation begin
 mkindex_stamp  => $f, ##-- (output) timestamp of operation end
 cxfile_stamp   => $f, ##-- (output) timetamp of operation end
 sxfile_stamp   => $f, ##-- (output) timetamp of operation end
 txfile_stamp   => $f, ##-- (output) timetamp of operation end

AUTHOR

Bryan Jurish <jurish@bbaw.de>

COPYRIGHT AND LICENSE

This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.2 or, at your option, any later version of Perl 5 you may have available.