NAME
SYNOPSIS
DESCRIPTION
CONSTRUCTOR
METHODS FOR BLOCK EXECUTION
BLOCK PARAMETRIZATION
MISCEL
SEE ALSO
AUTHOR
COPYRIGHT

NAME

TectoMT::Block

SYNOPSIS

 package BlockGroup::My_Block;
 
 use strict; use warnings; use utf8;
 
 use base qw(TectoMT::Block);
 
 sub process_bundle {
    my ($self, $bundle) = @_;
    
    # processing
    
 }

DESCRIPTION

TectoMT::Block is a base class serving as a common ancestor of all TectoMT blocks. TectoMT::Block can't be used directly in any scenario. Use it's descendants which implement method process_bundle() (or process_document()) instead.

CONSTRUCTOR

my $block = BlockGroup::My_Block->new();: Instance of a block derived from TectoMT::Block can be created by the constructor (optionally, a reference to a hash of block parameters can be specified as the constructor's argument, see BLOCK PARAMETRIZATION). However, it is not likely to appear in your code since block initialization is usually invoked automatically when initializing a scenario.

METHODS FOR BLOCK EXECUTION

$block->process_document($document);: Applies the block instance on the given instance of TectoMT::Document. The default implementation iterates over all bundles in a document and calls process_bundle(). So in most cases you don't need to override this method.
$block->process_bundle($bundle);: Applies the block instance on the given bundle (TectoMT::Bundle). This is the method you must implement to make your block working (unless you override process_document()).

BLOCK PARAMETRIZATION

my $block = BlockGroup::My_Block->new({$name1=>$value1,$name2=>$value2...});: Block instances can be parametrized by a hash containing parameter name/value pairs.
my $param_value = $block->get_param($param_name): Parameter values used in block construction can be revealed by get_param method (but cannot be changed).

MISCEL

my $block_name = $block->get_block_name();: It returns the name of the block module.

AUTHOR

Zdenek Zabokrtsky <zabokrtsky@ufal.mff.cuni.cz>