The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

TKR / Treex-Core-0.08590_1 / lib / Treex / Block / Write / Treex.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
—
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

              
package Treex::Block::Write::Treex;
{
  $Treex::Block::Write::Treex::VERSION = '0.08590_1';
}
use Moose;
use Treex::Core::Common;
extends 'Treex::Block::Write::BaseWriter';
has '+extension' => ( default => '.treex' );
has '+compress' => ( default => 1 );
has storable => (
    is            => 'rw',
    isa           => 'Bool',
    documentation => 'Use the Storable module (instead of Treex::PML) for storing into .streex files. Defaults to document->compress, or 0.'
);
# HACKS: Treex::PML::Document->save() cannot take filehandle
# Allow writing to STDOUT
override '_get_filename' => sub {
    my $filename = super();
    if ( $filename eq '-' ) {
        $filename = '/dev/stdout';
    }
    return $filename;
};
# If a gzipped file is opened first, the header won't be correct
override '_open_file_handle' => sub {
    return;
};
override '_document_extension' => sub {
    my ( $self, $document ) = @_;
    my $storable = $self->storable;
    if ( not defined $storable ) {
        $storable = $document->storable;
    }
    if ($storable) {
        return '.streex';
    }
    else {
        return super;
    }
};
sub process_document {
    my ( $self, $document ) = @_;
    # prepare the correct file name
    $self->_prepare_file_handle( $document );
    my $filename = $self->_last_filename;
    $document->set_filename($filename);
    $document->save($filename);
    return 1;
}
1;
__END__
=head1 NAME
Treex::Block::Write::Treex
=head1 VERSION
version 0.08590_1
=head1 DESCRIPTION
Document writer for the Treex file format (C<*.treex>),
which is actually a PML instance which is an XML-based format.
For a list of possible attributes, see 
L<BaseWriter|Treex::Block::Write::BaseWriter>.
=head1 METHODS
=over
=item process_document
Saves the document.
=back
=head1 AUTHORS
Martin Popel <popel@ufal.mff.cuni.cz>
Ondřej Dušek <odusek@ufal.mff.cuni.cz>
=head1 COPYRIGHT AND LICENSE
Copyright © 2011-2012 by Institute of Formal and Applied Linguistics, Charles University in Prague
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.