The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

MOOCOW / DDC-Concordance-0.24 / lib / DDC / Format / Raw.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
107
108
109
—
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
—
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
—
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
—
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

              
##-*- Mode: CPerl -*-
## File: DDC::Format::Raw.pm
## Author: Bryan Jurish <moocow@cpan.org>
## Description:
##  + DDC Query utilities: output formatting: Data::Raw
##======================================================================
package DDC::Format::Raw;
use IO::File;
use Carp;
use strict;
##======================================================================
## Globals
our @ISA = qw(DDC::Format);
##======================================================================
## Constructors, etc.
## $fmt = $CLASS_OR_OBJ->new(%args)
##  + %args:
##    (
##     hitSeparator => $sep,    ##-- raw hit separator (default="\n\n")
##    )
sub new {
  my $that = shift;
  my $fmt = bless {
                   hitSeparator => "\n\n",
                   @_
                  }, ref($that)||$that;
  return $fmt;
}
## $fmt = $fmt->reset()
##  + reset counters, etc.
#sub reset {
#  return $_[0]->SUPER::reset();
#}
##======================================================================
## Helper functions
## $hitStr = $fmt->hitString($hit)
##  + increments $fmt->{start}
sub hitString {
  return $_[1]{$_[0]{raw}};
}
##======================================================================
## API
## $str = $fmt->toString(\@hits)
sub toString {
  return join('',map {$_->{raw}.$_[0]{hitSeparator}} @{$_[1]->{hits_}});
}
1; ##-- be happy
__END__
##======================================================================
## Docs
=pod
=head1 NAME
DDC::Format::Raw - raw formatting for DDC hits
=head1 SYNOPSIS
 use DDC::Concordance;
 $hitList = DDC::Client::Distributed->new()->query('foo&&bar'); ##-- get some hits
 $fmt  = DDC::Format::Raw->new();
 $str = $fmt->toString($hitList);        ##-- conversion to string
 $fmt->toFile($hitList,$filename);       ##-- output to file
 $fmt->toFh($hitList,$fh);               ##-- output to filehandle
=cut
##======================================================================
## Description
=pod
=head1 DESCRIPTION
Class for null-formatting L<DDC::Hit|DDC::Hit> objects; just dumps raw hit data from C<$hit-E<gt>{raw}>.
=cut
##----------------------------------------------------------------
## DESCRIPTION: DDC::Format::Raw: Globals
=pod
=head2 Globals
=over 4
=item Variable: @ISA
DDC::Format::Raw inherits from L<DDC::Format|DDC::Format>.
=back
=cut
##----------------------------------------------------------------
## DESCRIPTION: DDC::Format::Raw: Constructors, etc.
=pod
=head2 Constructors, etc.
=over 4
=item new
 $fmt = $CLASS_OR_OBJ->new(%args);
Accepted keywords in %args:
 (
  hitSeparator => $str, ##-- raw hit separator (default="\n\n")
 )
=item reset
 $fmt = $fmt->reset();
Resets the formatting object.
=back
=cut
##----------------------------------------------------------------
## DESCRIPTION: DDC::Format::Raw: Helper functions
=pod
=head2 Helper functions
=over 4
=item hitString
 $hitStr = $fmt->hitString($hit);
Formats a single C<$hit> as a string.
=back
=cut
##----------------------------------------------------------------
## DESCRIPTION: DDC::Format::Raw: API
=pod
=head2 API
=over 4
=item toString
 $str = $fmt->toString($hitList);
Implements L<DDC::Format::toString()|DDC::Format/toString>.
=back
=cut
##========================================================================
## END POD DOCUMENTATION, auto-generated by podextract.perl
##======================================================================
## Footer
##======================================================================
=pod
=head1 AUTHOR
Bryan Jurish E<lt>moocow@cpan.orgE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2010-2016 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.
=cut