NAME

TectoMT::Bundle

DESCRIPTION

A bundle in TectoMT corresponds to one sentence in its various forms/representations (esp. its representations on various levels of language description, but also possibly including its counterpart sentence from a parallel corpus, or its automatically created translation, and their linguistic representations, be they created by analysis / transfer / synthesis). Attributes can be attached to a bundle as a whole.

METHODS

Constructor

my $new_bundle = TectoMT::Bundle->new();: Creates a new empty tree bundle.

Access to the underlying Fslib representation

$bundle->tie_with_fsroot($fsroot): Associates the given bundle with a FSNode object which is the root of a tree in the Fslib representation and will be used as the underlying represenatation of the bundle.
my $fsroot = $bundle->get_tied_fsroot();: Returns the associated FSNode object used as the bundle's underlying Fslib represenatation.
$bundle->untie_from_fsroot();: Unties the TectoMT::Bundle object from its underlying FSNode representation.

Access to attributes

my $value = $bundle->get_attr($name);: Returns the value of the bundle attribute of the given name.
$bundle->set_attr($name,$value);: Sets the given attribute of the bundle with the given value.

Access to the subsumed trees

my $root_node = $bundle->get_tree($tree_name);: Returns the TectoMT::Node object which is the root of the tree named $tree_name. Fatal error is caused if no tree of the given name is present in the bundle.
$bundle->set_tree($tree_name,$root_node);: Includes the tree rooted by $root_node into the bundle under the $tree_name name.
$bungle->contains_tree($tree_name);: Returns true if a tree of the given name is present in the budnle.
$bundle->get_tree_names();: Returns alphabetically sorted array of names of trees contained in the bundle.

Access to generic attributes and trees

Besides trees and bundle attributes with names statically predefined in the TectoMT pml schema (such as 'SCzechT' or 'czech_source_sentence'), one can use generic attributes and trees, which are parametrizable by language (using ISO 639 codes) and direction (S for source, T for target). Tree names then look e.g. like 'SarA' (source-side arabic analytical tree). Attribute names look like 'Sar sentence' (source-side arabic sentence).

my $value = $bundle->get_generic_attr($name);
$bundle->set_generic_attr($name,$value);
my $root_node = $bundle->get_generic_tree($tree_name);
$bundle->set_generic_tree($tree_name,$root_node);

Access to the bundle message board

Short unstructured pieces of information can be stored with bundles, e.g. because of special needs of inter-block communication. For example, a message can be left in a bundle that the contained sentece cannot be parsed by an ordinary parsing block and should be parsed later by a fallback-parser block.

$bundle->leave_message($message_text);
$bundle->get_messages();

Access to the containers

$document = $bundle->get_document();: Returns the TectoMT::Document object in which the bundle is contained.