.\" 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 "MARC::Record::MiJ 3pm" .TH MARC::Record::MiJ 3pm "2013-07-23" "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" MARC::Record::MiJ \- Convert MARC::Record to/from marc\-in\-json structure .SH "VERSION" .IX Header "VERSION" Version 0.04 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use MARC::Record; \& use MARC::Record::MIJ \& \& my $str = get_marc_in_json_from_somewhere; \& \& # The most common use will be to use methods monkeypatched into MARC::Record \& my $r = MARC::Record\->new_from_mij($str); \& my $json = $r\->to_mij; \& \& # You can also work with the underlying hash/array structure if you\*(Aqre dealing with \& # json serialization/deserialization on your own \& \& my $mij_structure = $r\->to_mij_structure; \& my $r = MARC::Record\->new_from_mij_structure($mij_structure); \& \& # You can also call things on MARC::Record::MiJ \& \& my $r = MARC::Record::MiJ\->new($str); \& my $json = MARC::Record::MiJ\->to_mij($r); \& my $mij_structure = MARC::Record::MiJ\->to_mij_structure($r); \& my $r = MARC::Record::MiJ\->new_from_mij_structure($mij_structure); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Reads and writes MARC-in-JSON structures and strings as supported by pymarc/ruby\-marc/marc4j and described at http://dilettantes.code4lib.org/blog/2010/09/a\-proposal\-to\-serialize\-marc\-in\-json/ .PP Don't confuse with another (incompatible) \s-1JSON\s0 encoding in the module \f(CW\*(C`MARC::File::JSON\*(C'\fR, which to the best of my knowledge isn't supported by other readers/writers. .PP For reading, you probably don't need to use this directly; take a look at \f(CW\*(C`MARC::File::MiJ\*(C'\fR for reading in newline-delimited marc-in-json files by itself or in conjunction with \f(CW\*(C`MARC::Batch\*(C'\fR. .PP The MARC::Record distribution doesn't so much do do writing out files. You can do something like this: .PP .Vb 9 \& # convert file from marc binary to marc\-in\-json \& use MARC::Batch; \& use MARC::Record::MiJ; \& my $batch = MARC::Batch\->new(\*(AqUSMARC\*(Aq, \*(Aqfile.mrc\*(Aq); \& open(my $jsonfile, \*(Aq>\*(Aq, \*(Aqfile.ndj\*(Aq ); \& while (my $r = $batch\->next) { \& print $jsonfile MARC::Record::MiJ\->to_mij($r), "\en"; \& } \& close $jsonfile; .Ve .PP \&...to produce newline-delimited marc-in-json from a binary file. .SH "SUBROUTINES/METHODS" .IX Header "SUBROUTINES/METHODS" .SS "json" .IX Subsection "json" Get a json object to work with (memoized). We want to control it so we make sure it's not doing anything pretty (like, say, putting newlines in, which woudl make it harder to produce newline-delimited json file). .SS "new($str)" .IX Subsection "new($str)" Take a \s-1JSON\s0 string and turn it into a MARC::Record object .SS "to_mij($r)" .IX Subsection "to_mij($r)" Take a record; return a \s-1JSON\s0 string .SS "MARC::Record::JSON\->to_mij_structure($r)" .IX Subsection "MARC::Record::JSON->to_mij_structure($r)" Turn a record into a marc-in-json compatible hash; return the hash pointer .SS "controlfield_to_mij_structure($field)" .IX Subsection "controlfield_to_mij_structure($field)" Turn a MARC::Record controlfield into an appropriate hash .SS "valuefield_to_mij_structure($field)" .IX Subsection "valuefield_to_mij_structure($field)" Turn a MARC::Record valuefield into an appropriate hash .SS "subfield_to_mij_structure($sf)" .IX Subsection "subfield_to_mij_structure($sf)" Turn a MARC::Record subfield pair (arrayref duple of code/value) into an appropriate hash .ie n .SS "my $r = MARC::Record::JSON\->new_from_mij_structure($mij_structure)" .el .SS "my \f(CW$r\fP = MARC::Record::JSON\->new_from_mij_structure($mij_structure)" .IX Subsection "my $r = MARC::Record::JSON->new_from_mij_structure($mij_structure)" Given a marc-in-json structure, return a MARC::Record object .SS "new_field_from_mij_structure($f)" .IX Subsection "new_field_from_mij_structure($f)" Given a field structure, create an appropriate (control or variable) field .SS "new_datafield_from_mij_structure" .IX Subsection "new_datafield_from_mij_structure" Support for new_field_from_mij_structure; do the more complex work of creating a datafield .SH "Monkeypatching MARC::Record" .IX Header "Monkeypatching MARC::Record" Add \f(CW\*(C`new_from_mij_structure($mij_structure) and \f(CW\*(C`to_mij_structure()\*(C'\f(CW to MARC::Record\*(C'\fR .PP .Vb 2 \& my $r = MARC::Record\->new_from_mij_structure($mij_structure); \& $mij_structure = $r\->to_mij_structure; .Ve .SH "AUTHOR" .IX Header "AUTHOR" Bill Dueber, \f(CW\*(C`\*(C'\fR .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \f(CW\*(C`bug\-MARC\-File\-MiJ at rt.cpan.org\*(C'\fR, or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "SUPPORT" .IX Header "SUPPORT" You can find documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc MARC::Record::MiJ .Ve .PP You can also look for information at: .IP "\(bu" 4 \&\s-1RT: CPAN\s0's request tracker (report bugs here) .Sp .IP "\(bu" 4 AnnoCPAN: Annotated \s-1CPAN\s0 documentation .Sp .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp .SH "ACKNOWLEDGEMENTS" .IX Header "ACKNOWLEDGEMENTS" .SH "LICENSE AND COPYRIGHT" .IX Header "LICENSE AND COPYRIGHT" Copyright 2013 Bill Dueber. .PP This software is free software and may be distributed under the same terms as Perl itself. .SH "POD ERRORS" .IX Header "POD ERRORS" Hey! \fBThe above document had some coding errors, which are explained below:\fR .IP "Around line 252:" 4 .IX Item "Around line 252:" Unterminated C<...> sequence