/usr/share/perl5/RDF/Trine/Iterator.pm is in librdf-trine-perl 1.014-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 | # RDF::Trine::Iterator
# -----------------------------------------------------------------------------
=head1 NAME
RDF::Trine::Iterator - Iterator class for SPARQL query results
=head1 VERSION
This document describes RDF::Trine::Iterator version 1.014.
=head1 SYNOPSIS
use RDF::Trine::Iterator;
my $iterator = RDF::Trine::Iterator->new( \&data, 'bindings', \@names );
while (my $row = $iterator->next) {
my @vars = keys %$row;
# do something with @vars
}
=head1 METHODS
=over 4
=cut
package RDF::Trine::Iterator;
use strict;
use warnings;
no warnings 'redefine';
use Encode;
use Data::Dumper;
use Log::Log4perl;
use Carp qw(carp);
use Scalar::Util qw(blessed reftype refaddr);
use XML::SAX;
use RDF::Trine::Node;
use RDF::Trine::Iterator::SAXHandler;
use RDF::Trine::Iterator::JSONHandler;
our ($VERSION, @ISA, @EXPORT_OK);
BEGIN {
$VERSION = '1.014';
require Exporter;
@ISA = qw(Exporter);
@EXPORT_OK = qw(sgrep smap swatch);
use overload 'bool' => sub { $_[0] };
use overload '&{}' => sub {
my $self = shift;
return sub {
return $self->next;
};
};
}
use RDF::Trine::Iterator::Bindings;
use RDF::Trine::Iterator::Boolean;
use RDF::Trine::Iterator::Graph;
=item C<new ( \@results, $type, \@names, %args )>
=item C<new ( \&results, $type, \@names, %args )>
Returns a new SPARQL Result interator object. Results must be either
an reference to an array containing results or a CODE reference that
acts as an iterator, returning successive items when called, and
returning undef when the iterator is exhausted.
$type should be one of: bindings, boolean, graph.
=cut
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my $stream = shift || sub { undef };
my $type = shift || 'bindings';
my $names = shift || [];
my %args = @_;
if (ref($stream) and ref($stream) eq 'ARRAY') {
my $array = $stream;
$stream = sub {
return shift(@$array);
}
}
my $open = 0;
my $finished = 0;
my $row;
my $data = {
_open => 0,
_finished => 0,
_type => $type,
_names => $names,
_stream => $stream,
_args => \%args,
_count => 0,
_row => undef,
_peek => [],
# _source => Carp::longmess(),
};
my $self = bless($data, $class);
return $self;
}
=item C<type>
Returns the underlying result type (boolean, graph, bindings).
=cut
sub type {
my $self = shift;
return $self->{_type};
}
=item C<is_boolean>
Returns true if the underlying result is a boolean value.
=item C<is_bindings>
Returns true if the underlying result is a set of variable bindings.
=item C<is_graph>
Returns true if the underlying result is an RDF graph.
=cut
sub is_boolean { 0 }
sub is_bindings { 0 }
sub is_graph { 0 }
=item C<to_string ( $format )>
Returns a string representation of the stream data in the specified
C<$format>. If C<$format> is missing, defaults to XML serialization.
Other options are:
http://www.w3.org/2001/sw/DataAccess/json-sparql/
=cut
sub to_string {
my $self = shift;
my $format = shift || 'http://www.w3.org/2005/sparql-results#';
if (ref($format) and $format->isa('RDF::Redland::URI')) {
$format = $format->as_string;
}
if ($format eq 'http://www.w3.org/2001/sw/DataAccess/json-sparql/') {
return $self->as_json;
} else {
return $self->as_xml;
}
}
=item C<< from_string ( $xml ) >>
Returns a new iterator using the supplied XML string in the SPARQL XML Results format.
=cut
sub from_string {
my $class = shift;
my $string = shift;
my $bytes = encode('UTF-8', $string);
return $class->from_bytes($bytes);
}
=item C<< from_bytes ( $xml ) >>
Returns a new iterator using the supplied XML byte sequence (note: not character data)
in the SPARQL XML Results format.
=cut
sub from_bytes {
my $class = shift;
my $string = shift;
unless (ref($string)) {
my $data = $string;
open( my $fh, '<', \$data );
$string = $fh;
}
my $handler = RDF::Trine::Iterator::SAXHandler->new();
my $p = XML::SAX::ParserFactory->parser(Handler => $handler);
$p->parse_file( $string );
my $iter = $handler->iterator;
return $iter;
}
=item C<< from_json ( $json ) >>
=cut
sub from_json {
my $class = shift;
my $json = shift;
my $p = RDF::Trine::Iterator::JSONHandler->new( @_ );
return $p->parse( $json );
}
=item C<< next_result >>
=item C<< next >>
Returns the next item in the stream.
=cut
sub next_result { $_[0]->next }
sub next {
my $self = shift;
return if ($self->{_finished});
if (scalar(@{ $self->{_peek} })) {
return shift(@{ $self->{_peek} });
}
my $stream = $self->{_stream};
my $value = $stream->();
unless (defined($value)) {
$self->{_finished} = 1;
}
$self->{_open} = 1;
$self->{_row} = $value;
$self->{_count}++ if defined($value);
return $value;
}
=item C<< peek >>
Returns the next value from the iterator without consuming it. The value will
remain in queue until the next call to C<< next >>.
=cut
sub peek {
my $self = shift;
return if ($self->{_finished});
my $value = $self->next;
push( @{ $self->{_peek} }, $value );
return $value;
}
=item C<< current >>
Returns the current item in the stream.
=cut
sub current {
my $self = shift;
if ($self->open) {
return $self->_row;
} else {
return $self->next;
}
}
=item C<< end >>
=item C<< finished >>
Returns true if the end of the stream has been reached, false otherwise.
=cut
sub end { $_[0]->finished }
sub finished {
my $self = shift;
my $v = $self->peek;
return 0 if (defined($v));
return $self->{_finished};
}
=item C<< open >>
Returns true if the first element of the stream has been retrieved, false otherwise.
=cut
sub open {
my $self = shift;
return $self->{_open};
}
=item C<< close >>
Closes the stream. Future attempts to retrieve data from the stream will act as
if the stream had been exhausted.
=cut
sub close {
my $self = shift;
$self->{_finished} = 1;
undef( $self->{ _stream } );
return;
}
=item C<< concat ( $stream ) >>
Returns a new stream resulting from the concatenation of the referant and the
argument streams. The new stream uses the stream type, and optional binding
names and C<<%args>> from the referant stream.
=cut
sub concat {
my $self = shift;
my $stream = shift;
my @args = $stream->construct_args();
my $class = ref($self);
my @streams = ($self, $stream);
my $next = sub {
while (@streams) {
my $data = $streams[0]->next;
unless (defined($data)) {
shift(@streams);
next;
}
return $data;
}
return;
};
my $s = $stream->_new( $next, @args );
return $s;
}
=item C<< seen_count >>
Returns the count of elements that have been returned by this iterator at the
point of invocation.
=cut
sub seen_count {
my $self = shift;
return $self->{_count};
}
=item C<get_boolean>
Returns the boolean value of the first item in the stream.
=cut
sub get_boolean {
my $self = shift;
my $data = $self->next;
return +$data;
}
=item C<get_all>
Returns an array containing all the items in the stream.
=cut
sub get_all {
my $self = shift;
my @data;
while (my $data = $self->next) {
push(@data, $data);
}
return @data;
}
=begin private
=item C<format_node_xml ( $node, $name )>
Returns a string representation of C<$node> for use in an XML serialization.
=end private
=cut
sub format_node_xml {
my $self = shift;
# my $bridge = shift;
# return unless ($bridge);
my $node = shift;
my $name = shift;
my $node_label;
if (!defined $node) {
return '';
} elsif ($node->is_resource) {
$node_label = $node->uri_value;
$node_label =~ s/&/&/g;
$node_label =~ s/</</g;
$node_label =~ s/"/"/g;
$node_label = qq(<uri>${node_label}</uri>);
} elsif ($node->isa('RDF::Trine::Node::Literal')) {
$node_label = $node->literal_value;
$node_label =~ s/&/&/g;
$node_label =~ s/</</g;
$node_label =~ s/"/"/g;
if ($node->has_language) {
my $lang = $node->literal_value_language;
$node_label = qq(<literal xml:lang="${lang}">${node_label}</literal>);
} elsif ($node->has_datatype) {
my $dt = $node->literal_datatype;
$node_label = qq(<literal datatype="${dt}">${node_label}</literal>);
} else {
$node_label = qq(<literal>${node_label}</literal>);
}
} elsif ($node->isa('RDF::Trine::Node::Blank')) {
$node_label = $node->blank_identifier;
$node_label =~ s/&/&/g;
$node_label =~ s/</</g;
$node_label =~ s/"/"/g;
$node_label = qq(<bnode>${node_label}</bnode>);
} else {
$node_label = "<unbound/>";
}
return qq(<binding name="${name}">${node_label}</binding>);
}
=item C<< construct_args >>
Returns the arguments necessary to pass to a stream constructor
to re-create this stream (assuming the same closure as the first
argument).
=cut
sub construct_args {
my $self = shift;
my $type = $self->type;
my $args = $self->_args || {};
return ($type, [], %$args);
}
=item C<< each ( \&callback ) >>
Calls the callback function once for each item in the iterator, passing the
item as an argument to the function. Any arguments to C<< each >> beyond the
callback function will be passed as supplemental arguments to the callback
function.
=cut
sub each {
my ($self, $coderef) = (shift, shift);
while (my $row = $self->next) {
$coderef->($row, @_);
}
}
=begin private
=item C<< debug >>
Prints debugging information about the stream.
=end private
=cut
sub debug {
my $self = shift;
my $stream = $self->{_stream};
RDF::Query::_debug_closure( $stream );
}
sub _args {
my $self = shift;
return $self->{_args};
}
sub _row {
my $self = shift;
return $self->{_row};
}
sub _names {
my $self = shift;
return $self->{_names};
}
sub _stream {
my $self = shift;
return $self->{_stream};
}
=back
=head1 FUNCTIONS
=over 4
=item C<sgrep { COND } $stream>
=cut
sub sgrep (&$) { ## no critic (ProhibitSubroutinePrototypes)
my $block = shift;
my $stream = shift;
my @args = $stream->construct_args();
my $class = ref($stream);
my $open = 1;
my $next;
$next = sub {
return unless ($open);
my $data = $stream->next;
unless ($data) {
$open = 0;
return;
}
local($_) = $data;
my $bool = $block->( $data );
if ($bool) {
# warn "[SGREP] TRUE with: " . $data->as_string;
if (@_ and $_[0]) {
$stream->close;
$open = 0;
}
return $data;
} else {
# warn "[SGREP] FALSE with: " . $data->as_string;
goto &$next;
}
};
Carp::confess "not a stream: " . Dumper($stream) unless (blessed($stream));
Carp::confess unless ($stream->can('_new'));
my $s = $stream->_new( $next, @args );
return $s;
}
=item C<smap { EXPR } $stream>
=cut
sub smap (&$;$$$) { ## no critic (ProhibitSubroutinePrototypes)
my $block = shift;
my $stream = shift;
my @args = $stream->construct_args();
foreach my $i (0 .. $#args) {
last unless (scalar(@_));
my $new = shift;
if (defined($new)) {
$args[ $i ] = $new;
}
}
my $class = ref($stream);
my $open = 1;
my $next = sub {
return unless ($open);
if (@_ and $_[0]) {
$stream->close;
$open = 0;
}
my $data = $stream->next;
unless ($data) {
$open = 0;
return;
}
local($_) = $data;
my ($item) = $block->( $data );
return $item;
};
return $stream->_new( $next, @args );
}
=item C<swatch { EXPR } $stream>
=cut
sub swatch (&$) { ## no critic (ProhibitSubroutinePrototypes)
my $block = shift;
my $stream = shift;
my @args = $stream->construct_args();
my $class = ref($stream);
my $open = 1;
my $next = sub {
return unless ($open);
if (@_ and $_[0]) {
$stream->close;
$open = 0;
}
my $data = $stream->next;
unless ($data) {
$open = 0;
return;
}
local($_) = $data;
$block->( $data );
return $data;
};
my $s = $stream->_new( $next, @args );
return $s;
}
1;
__END__
=back
=head1 DEPENDENCIES
L<JSON|JSON>
L<Scalar::Util|Scalar::Util>
L<XML::SAX|XML::SAX>
=head1 BUGS
Please report any bugs or feature requests to through the GitHub web interface
at L<https://github.com/kasei/perlrdf/issues>.
=head1 AUTHOR
Gregory Todd Williams C<< <gwilliams@cpan.org> >>
=head1 COPYRIGHT
Copyright (c) 2006-2012 Gregory Todd Williams. This
program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut
|