.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "RDF::Trine::Serializer 3pm" .TH RDF::Trine::Serializer 3pm "2014-10-24" "perl v5.20.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" RDF::Trine::Serializer \- RDF Serializer class .SH "VERSION" .IX Header "VERSION" This document describes RDF::Trine::Serializer version 1.011 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use RDF::Trine::Serializer; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The RDF::Trine::Serializer class provides an \s-1API\s0 for serializing \s-1RDF\s0 graphs (via both model objects and graph iterators) to strings and files. .SH "METHODS" .IX Header "METHODS" .ie n .IP """serializer_names""" 4 .el .IP "\f(CWserializer_names\fR" 4 .IX Item "serializer_names" Returns a list of valid serializer names for use as arguments to the serializer constructor. .ie n .IP """new ( $serializer_name, %options )""" 4 .el .IP "\f(CWnew ( $serializer_name, %options )\fR" 4 .IX Item "new ( $serializer_name, %options )" Returns a new RDF::Trine::Serializer object for the serializer with the specified name (e.g. \*(L"rdfxml\*(R" or \*(L"turtle\*(R"). If no serializer with the specified name is found, throws a RDF::Trine::Error::SerializationError exception. .Sp The valid key-values used in \f(CW%options\fR are specific to a particular serializer implementation. For serializers that support namespace declarations (to allow more concise serialization), use \f(CW\*(C`namespaces => \e%namespaces\*(C'\fR in \&\f(CW%options\fR, where the keys of \f(CW%namespaces\fR are namespace names and the values are (partial) URIs. For serializers that support base \s-1URI\s0 declarations, use \f(CW\*(C`base_uri => $base_uri\*(C'\fR . .ie n .IP """negotiate ( request_headers => $request_headers, %options )""" 4 .el .IP "\f(CWnegotiate ( request_headers => $request_headers, %options )\fR" 4 .IX Item "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 \f(CW\*(Aqrequest_headers\*(Aq\fR key-value is supplied, the \f(CW$request_headers\fR is passed to \f(CW\*(C`HTTP::Negotiate::choose\*(C'\fR. The option \f(CW\*(Aqrestrict\*(Aq\fR, set to a list of serializer names, can be used to limit the serializers to choose from. Finally, an \f(CW\*(C`<\*(Aqextend\*(Aq \*(C'\fR> option can be set to a hashref that contains MIME-types as keys and a custom variant as value. This will enable the user to use this negotiator to return a type that isn't supported by any serializers. The subsequent code will have to find out how to return a representation. The rest of \f(CW%options\fR is passed through to the serializer constructor. .ie n .IP """media_types""" 4 .el .IP "\f(CWmedia_types\fR" 4 .IX Item "media_types" Returns a list of media types appropriate for the format of the serializer. .ie n .IP """serialize_model_to_file ( $fh, $model )""" 4 .el .IP "\f(CWserialize_model_to_file ( $fh, $model )\fR" 4 .IX Item "serialize_model_to_file ( $fh, $model )" Serializes the \f(CW$model\fR, printing the results to the supplied filehandle \&\f(CW\*(C`<$fh\*(C'\fR>. .ie n .IP """serialize_model_to_string ( $model )""" 4 .el .IP "\f(CWserialize_model_to_string ( $model )\fR" 4 .IX Item "serialize_model_to_string ( $model )" Serializes the \f(CW$model\fR, returning the result as a string. .ie n .IP """serialize_iterator_to_file ( $file, $iterator )""" 4 .el .IP "\f(CWserialize_iterator_to_file ( $file, $iterator )\fR" 4 .IX Item "serialize_iterator_to_file ( $file, $iterator )" Serializes the statement objects produced by \f(CW$iterator\fR, printing the results to the supplied filehandle \f(CW\*(C`<$fh\*(C'\fR>. .Sp 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. .ie n .IP """serialize_iterator_to_string ( $iterator )""" 4 .el .IP "\f(CWserialize_iterator_to_string ( $iterator )\fR" 4 .IX Item "serialize_iterator_to_string ( $iterator )" Serializes the statement objects produced by \f(CW$iterator\fR, returning the result as a string. Note that the same constraints apply to this method as to \&\f(CW\*(C`serialize_iterator_to_file\*(C'\fR. .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to through the GitHub web interface at . .SH "AUTHOR" .IX Header "AUTHOR" Gregory Todd Williams \f(CW\*(C`\*(C'\fR .SH "COPYRIGHT" .IX Header "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.