| RDF-Trine documentation | Contained in the RDF-Trine distribution. |
RDF::Trine::Serializer - RDF Serializer class
This document describes RDF::Trine::Serializer version 0.135
use RDF::Trine::Serializer;
The RDF::Trine::Serializer class provides an API for serializing RDF graphs (via both model objects and graph iterators) to strings and files.
serializer_namesReturns a list of valid serializer names for use as arguments to the serializer constructor.
new ( $serializer_name, %options )Returns a new RDF::Trine::Serializer object for the serializer with the specified name (e.g. "rdfxml" or "turtle"). If no serializer with the specified name is found, throws a RDF::Trine::Error::SerializationError exception.
The valid key-values used in %options are specific to a particular
serializer implementation. For serializers that support namespace declarations
(to allow more concise serialization), use namespaces => \%namespaces in
%options, where the keys of %namespaces are namespace names and
the values are (partial) URIs. For serializers that support base URI declarations,
use base_uri => $base_uri .
negotiate ( request_headers => $request_headers, %options )Returns a two-element list containing an appropriate media type and
RDF::Trine::Serializer object as decided by HTTP::Negotiate.
If the 'request_headers' key-value is supplied, the
$request_headers is passed to HTTP::Negotiate::choose.
The option 'restrict', set to a list of serializer names, can be
used to limit the serializers to choose from. The rest of
%options is passed through to the serializer constructor.
media_typesReturns a list of media types appropriate for the format of the serializer.
serialize_model_to_file ( $fh, $model )Serializes the $model, printing the results to the supplied filehandle
<$fh>.
serialize_model_to_string ( $model )Serializes the $model, returning the result as a string.
serialize_iterator_to_file ( $file, $iterator )Serializes the statement objects produced by $iterator, printing the
results to the supplied filehandle <$fh>.
Note that some serializers may not support the use of this method, or may require the full materialization of the iterator in order to serialize it. If materialization is required, available memeory may constrain the iterators that can be serialized.
serialize_iterator_to_string ( $iterator )Serializes the statement objects produced by $iterator, returning the
result as a string. Note that the same constraints apply to this method as to
serialize_iterator_to_file.
Gregory Todd Williams <gwilliams@cpan.org>
Copyright (c) 2006-2010 Gregory Todd Williams. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| RDF-Trine documentation | Contained in the RDF-Trine distribution. |
# RDF::Trine::Serializer # -----------------------------------------------------------------------------
package RDF::Trine::Serializer; use strict; use warnings; no warnings 'redefine'; use Data::Dumper; use HTTP::Negotiate qw(choose); our ($VERSION); our %serializer_names; our %format_uris; our %media_types; BEGIN { $VERSION = '0.135'; } use LWP::UserAgent; use RDF::Trine::Serializer::NQuads; use RDF::Trine::Serializer::NTriples; use RDF::Trine::Serializer::NTriples::Canonical; use RDF::Trine::Serializer::RDFXML; use RDF::Trine::Serializer::RDFJSON; use RDF::Trine::Serializer::Turtle;
sub serializer_names { return keys %serializer_names; }
sub new { my $class = shift; my $name = shift; my $key = lc($name); $key =~ s/[^-a-z]//g; if (my $class = $serializer_names{ $key }) { return $class->new( @_ ); } else { throw RDF::Trine::Error::SerializationError -text => "No serializer known named $name"; } }
sub negotiate { my $class = shift; my %options = @_; my $headers = delete $options{ 'request_headers' }; my $restrict = delete $options{ 'restrict' }; my $extend = delete $options{ 'extend' } || {}; my %sclasses; if (ref($restrict) && ref($restrict) eq 'ARRAY') { $sclasses{ $serializer_names{$_} } = 1 for @$restrict; } else { %sclasses = reverse %serializer_names; } my @default_variants; while (my($type, $sclass) = each(%media_types)) { next unless $sclasses{$sclass}; my $qv; # slightly prefer turtle as a readable format to others # try hard to avoid using ntriples as 'text/plain' isn't very useful for conneg if ($type eq 'text/turtle') { $qv = 1.0; } elsif ($type eq 'text/plain') { $qv = 0.2; } else { $qv = 0.99; } $qv -= 0.01 if ($type =~ m#/x-#); # prefer non experimental media types $qv -= 0.01 if ($type =~ m#^application/(?!rdf[+]xml)#); # prefer standard rdf/xml to other application/* formats push(@default_variants, [$type, $qv, $type]); } my %custom_thunks; my @custom_variants; while (my($type,$thunk) = each(%$extend)) { push(@custom_variants, [$thunk, 1.0, $type]); $custom_thunks{ $thunk } = [$type, $thunk]; } # remove variants with media types that are in custom_variants from @variants my @variants = grep { not exists $extend->{ $_->[2] } } @default_variants; push(@variants, @custom_variants); my $stype = choose( \@variants, $headers ); if (defined($stype) and $custom_thunks{ $stype }) { my $thunk = $stype; my $type = $custom_thunks{ $stype }[0]; return ($type, $thunk); } if (defined($stype) and my $sclass = $media_types{ $stype }) { return ($stype, $sclass->new( %options )); } else { throw RDF::Trine::Error::SerializationError -text => "No appropriate serializer found for content-negotiation"; } }
sub media_types { my $self = shift; my $class = ref($self) || $self; my @list; while (my($type, $sclass) = each(%media_types)) { push(@list, $type) if ($sclass eq $class); } return sort @list; }
sub serialize_model_to_string { my $self = shift; my $model = shift; my $string = ''; open( my $fh, '>', \$string ); $self->serialize_model_to_file( $fh, $model ); close($fh); return $string; }
sub serialize_iterator_to_file { my $self = shift; my $fh = shift; my $iter = shift; my %args = @_; my $model = RDF::Trine::Model->temporary_model; while (my $st = $iter->next) { $model->add_statement( $st ); } return $self->serialize_model_to_file( $fh, $model ); }
sub serialize_iterator_to_string { my $self = shift; my $iter = shift; my $string = ''; open( my $fh, '>', \$string ); $self->serialize_iterator_to_file( $fh, $iter ); close($fh); return $string; } 1; __END__