NAME

DTA::TokWrap - DTA tokenizer wrappers: top level

SYNOPSIS

            

              
              
use DTA::TokWrap;
##========================================================================
## Constructors etc.
$tw = DTA::TokWrap->new(%options);       ##-- constructor
%defaults = DTA::TokWrap->defaults();    ##-- static default options
$tw = $tw->init();                       ##-- dynamic default options
##========================================================================
## Methods: Document pseudo-I/O
$doc = $CLASS_OR_OBJECT->open($xmlfile,%docNewOptions);
$bool = $tw->close($doc);
##========================================================================
## Methods: Profiling
$tw->logProfile($logLevel);
            
          

DESCRIPTION

This manpage describes the DTA::TokWrap module. For an introduction to the DTA::TokWrap distribution, see DTA::TokWrap::Intro.

The DTA::TokWrap package provides top-level object-oriented wrappers for (batch) tokenization of DTA "base-format" XML documents.

Constants

Variable: @ISA

The DTA::TokWrap class inherits from DTA::TokWrap::Base.

Constructors etc.

defaults

            

              
              
%defaults = CLASS->defaults();
            
          

Static default options; see DTA::TokWrap::Base.

init

            

              
              
$tw = $tw->init();
            
          

Set dynamic default object structure; see DTA::TokWrap::Base.

Methods: Document pseudo-I/O

open

            

              
              
$doc = $CLASS_OR_OBJECT->open($xmlfile,%docNewOptions);
            
          

Wrapper for DTA::TokWrap::Document->open($xmlfile,tw=>$tw,%docNewOptions)

close

            

              
              
$bool = $tw->close($doc);
            
          

Wrapper for $doc->close()

Methods: Profiling

logProfile

            

              
              
undef = $tw->logProfile($logLevel);
            
          

Logs profiling information (throughput) at $logLevel using the Log::Log4perl mechanism via DTA::TokWrap::Logger. See DTA::TokWrap::Logger.

SEE ALSO

DTA::TokWrap::Intro(3pm), dta-tokwrap.perl(1), ...

SEE ALSO

DTA::TokWrap::Intro(3pm), dta-tokwrap.perl(1), ...

SEE ALSO

DTA::TokWrap::Intro(3pm), dta-tokwrap.perl(1), ...

AUTHOR

Bryan Jurish <moocow@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2009-2018 by Bryan Jurish

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.