marc4j4r 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. data/.document +5 -0
  2. data/.gitignore +21 -0
  3. data/LICENSE +20 -0
  4. data/README.markdown +41 -0
  5. data/Rakefile +53 -0
  6. data/VERSION +1 -0
  7. data/doc/ControlFieldImpl.html +255 -0
  8. data/doc/DataFieldImpl.html +798 -0
  9. data/doc/Java/OrgMarc4j/MarcReader.html +184 -0
  10. data/doc/MARC4J4R/Reader.html +245 -0
  11. data/doc/MARC4J4R.html +279 -0
  12. data/doc/RecordImpl.html +690 -0
  13. data/doc/SubfieldImpl.html +252 -0
  14. data/doc/_index.html +153 -0
  15. data/doc/class_list.html +36 -0
  16. data/doc/css/common.css +1 -0
  17. data/doc/css/full_list.css +50 -0
  18. data/doc/css/style.css +268 -0
  19. data/doc/file.README.html +91 -0
  20. data/doc/file_list.html +38 -0
  21. data/doc/frames.html +13 -0
  22. data/doc/index.html +91 -0
  23. data/doc/js/app.js +99 -0
  24. data/doc/js/full_list.js +106 -0
  25. data/doc/js/jquery.js +19 -0
  26. data/doc/method_list.html +203 -0
  27. data/doc/top-level-namespace.html +87 -0
  28. data/jars/marc4j.jar +0 -0
  29. data/lib/marc4j4r.rb +345 -0
  30. data/test/helper.rb +10 -0
  31. data/test/one.dat +1 -0
  32. data/test/one.xml +55 -0
  33. data/test/test_marc4j4r.rb +76 -0
  34. metadata +108 -0
data/doc/MARC4J4R.html ADDED
@@ -0,0 +1,279 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta name="Content-Type" content="text/html; charset=UTF-8" />
6
+ <title>Module: MARC4J4R</title>
7
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
8
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+
10
+ <script type="text/javascript" charset="utf-8">
11
+ relpath = '';
12
+ if (relpath != '') relpath += '/';
13
+ </script>
14
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
15
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
16
+
17
+ </head>
18
+ <body>
19
+ <script type="text/javascript" charset="utf-8">
20
+ if (window.top.frames.main) document.body.className = 'frames';
21
+ </script>
22
+
23
+ <div id="header">
24
+ <div id="menu">
25
+
26
+ <a href="_index.html">Index (M)</a> &raquo;
27
+
28
+
29
+ <span class="title">MARC4J4R</span>
30
+
31
+
32
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
33
+ </div>
34
+
35
+ <div id="search">
36
+ <a id="class_list_link" href="#">Class List</a>
37
+ <a id="method_list_link" href="#">Method List</a>
38
+ <a id ="file_list_link" href="#">File List</a>
39
+ </div>
40
+
41
+ <div class="clear"></div>
42
+ </div>
43
+
44
+ <iframe id="search_frame"></iframe>
45
+
46
+ <div id="content"><h1>Module: MARC4J4R
47
+
48
+
49
+ </h1>
50
+
51
+ <dl class="box">
52
+
53
+
54
+
55
+
56
+
57
+
58
+
59
+ <dt class="r1 last">Defined in:</dt>
60
+ <dd class="r1 last">lib/marc4j4r.rb</dd>
61
+
62
+ </dl>
63
+ <div class="clear"></div>
64
+
65
+
66
+ <h2>Constant Summary</h2>
67
+
68
+ <dl class="constants">
69
+
70
+ <dt id="NEWINIT-constant" class="">NEWINIT =
71
+ <span class="summary_desc">
72
+ Add some sugar to the MarcReader interface.
73
+
74
+ </span>
75
+ </dt>
76
+ <dd><pre class="code"><span class='string val'>&quot;alias_method :oldinit, :initialize\ndef initialize(fromwhere)\nstream = nil\nif fromwhere.is_a? Java::JavaIO::InputStream\nstream = fromwhere\nelsif fromwhere.is_a? IO\nstream = fromwhere.to_inputstream\nelse\nstream = java.io.FileInputStream.new(fromwhere.to_java_string)\nend\nif self.class == Java::org.marc4j.MarcPermissiveStreamReader\nself.oldinit(stream, true, true)\nelse\nself.oldinit(stream)\nend\nend\n&quot;</span>
77
+ </pre></dd>
78
+
79
+ </dl>
80
+
81
+
82
+
83
+
84
+ <h2>Instance Method Summary</h2>
85
+
86
+ <ul class="summary">
87
+
88
+ <li class="public ">
89
+ <span class="summary_signature">
90
+
91
+ <a href="#reader-instance_method" title="#reader (instance method)">- (MarcReader) <strong>reader</strong>(input, type = :strictmarc) </a>
92
+
93
+
94
+
95
+ </span>
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+ <span class="summary_desc">
104
+ Get a marc reader of the appropriate type.
105
+
106
+ </span>
107
+
108
+ </li>
109
+
110
+
111
+ </ul>
112
+
113
+
114
+ <div id="instance_method_details" class="method_details_list">
115
+ <h2>Instance Method Details</h2>
116
+
117
+
118
+ <div class="method_details first">
119
+ <p class="signature first" id="reader-instance_method">
120
+
121
+ - (<tt>MarcReader</tt>) <strong>reader</strong>(input, type = :strictmarc)
122
+
123
+
124
+
125
+ </p><div class="docstring">
126
+ <div class="discussion">
127
+ <p>
128
+ Get a marc reader of the appropriate type
129
+ </p>
130
+
131
+
132
+ </div>
133
+ </div>
134
+ <div class="tags">
135
+
136
+ <div class="examples">
137
+ <h3>Examples:</h3>
138
+
139
+ <h4>
140
+ Get a strict binary MARC reader for the file &#8216;test.mrc&#8217;
141
+
142
+ </h4>
143
+ <pre class="example code"> <span class='reader identifier id'>reader</span> <span class='assign token'>=</span> <span class='MARC4J4R constant id'>MARC4J4R</span><span class='dot token'>.</span><span class='reader identifier id'>reader</span><span class='lparen token'>(</span><span class='string val'>'test.mrc'</span><span class='rparen token'>)</span>
144
+ </pre>
145
+
146
+ <h4>
147
+ Get a permissive binary MARC reader
148
+
149
+ </h4>
150
+ <pre class="example code"> <span class='reader identifier id'>reader</span> <span class='assign token'>=</span> <span class='MARC4J4R constant id'>MARC4J4R</span><span class='dot token'>.</span><span class='reader identifier id'>reader</span><span class='lparen token'>(</span><span class='string val'>'test.mrc'</span><span class='comma token'>,</span> <span class='symbol val'>:permissivemarc</span><span class='rparen token'>)</span>
151
+ </pre>
152
+
153
+ <h4>
154
+ Get a reader for an xml file
155
+
156
+ </h4>
157
+ <pre class="example code"> <span class='reader identifier id'>reader</span> <span class='assign token'>=</span> <span class='MARC4J4R constant id'>MARC4J4R</span><span class='dot token'>.</span><span class='reader identifier id'>reader</span><span class='lparen token'>(</span><span class='string val'>'test.xml'</span><span class='comma token'>,</span> <span class='symbol val'>:marcxml</span><span class='rparen token'>)</span>
158
+ </pre>
159
+
160
+ <h4>
161
+ Get a reader based on an existing IO object
162
+
163
+ </h4>
164
+ <pre class="example code"> <span class='require identifier id'>require</span> <span class='string val'>'open-uri'</span>
165
+ <span class='infile identifier id'>infile</span> <span class='assign token'>=</span> <span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'http://my.machine.com/test.mrc'</span><span class='rparen token'>)</span>
166
+ <span class='reader identifier id'>reader</span> <span class='assign token'>=</span> <span class='MARC4J4R constant id'>MARC4J4R</span><span class='dot token'>.</span><span class='reader identifier id'>reader</span><span class='lparen token'>(</span><span class='infile identifier id'>infile</span><span class='rparen token'>)</span>
167
+ </pre>
168
+
169
+ </div>
170
+ <h3>Parameters:</h3>
171
+ <ul class="param">
172
+
173
+ <li>
174
+
175
+ <span class='type'>(<tt>String</tt>, <tt>IO</tt>, <tt>java.io.InputStream</tt>)</span>
176
+
177
+
178
+ <span class='name'>input</span>
179
+
180
+
181
+
182
+ &mdash;
183
+
184
+ The IO stream (or filename) from which you want to read
185
+
186
+
187
+
188
+ </li>
189
+
190
+ <li>
191
+
192
+ <span class='type'>(<tt>:strictmarc</tt>, <tt>:permissivemarc</tt>, <tt>:marcxml</tt>)</span>
193
+
194
+
195
+ <span class='name'>The</span>
196
+
197
+
198
+
199
+ &mdash;
200
+
201
+ type of MARC reader you want.
202
+
203
+
204
+
205
+ </li>
206
+
207
+ </ul>
208
+ <h3>Returns:</h3>
209
+ <ul class="return">
210
+
211
+ <li>
212
+
213
+ <span class='type'>(<tt>MarcReader</tt>)</span>
214
+
215
+
216
+
217
+
218
+ &mdash;
219
+
220
+ A MarcReader object with the syntactic sugar added in this file (e.g, each)
221
+
222
+
223
+
224
+ </li>
225
+
226
+ </ul>
227
+
228
+ </div><table class="source_code">
229
+ <tr>
230
+ <td>
231
+ <pre class="lines">
232
+
233
+
234
+ 77
235
+ 78
236
+ 79
237
+ 80
238
+ 81
239
+ 82
240
+ 83
241
+ 84
242
+ 85
243
+ 86
244
+ 87
245
+ 88</pre>
246
+ </td>
247
+ <td>
248
+ <pre class="code"><span class="info file"># File 'lib/marc4j4r.rb', line 77</span>
249
+
250
+ <span class='def def kw'>def</span> <span class='reader identifier id'>reader</span><span class='lparen token'>(</span><span class='input identifier id'>input</span><span class='comma token'>,</span> <span class='type identifier id'>type</span> <span class='assign token'>=</span> <span class='symbol val'>:strictmarc</span><span class='rparen token'>)</span>
251
+ <span class='case case kw'>case</span> <span class='type identifier id'>type</span>
252
+ <span class='when when kw'>when</span> <span class='symbol val'>:strictmarc</span>
253
+ <span class='return return kw'>return</span> <span class='Java constant id'>Java</span><span class='colon2 op'>::</span><span class='org identifier id'>org</span><span class='dot token'>.</span><span class='marc4j identifier id'>marc4j</span><span class='dot token'>.</span><span class='MarcStreamReader constant id'>MarcStreamReader</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='input identifier id'>input</span><span class='rparen token'>)</span>
254
+ <span class='when when kw'>when</span> <span class='symbol val'>:permissivemarc</span>
255
+ <span class='return return kw'>return</span> <span class='Java constant id'>Java</span><span class='colon2 op'>::</span><span class='org identifier id'>org</span><span class='dot token'>.</span><span class='marc4j identifier id'>marc4j</span><span class='dot token'>.</span><span class='MarcPermissiveStreamReader constant id'>MarcPermissiveStreamReader</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='input identifier id'>input</span><span class='rparen token'>)</span>
256
+ <span class='when when kw'>when</span> <span class='symbol val'>:marcxml</span>
257
+ <span class='return return kw'>return</span> <span class='Java constant id'>Java</span><span class='colon2 op'>::</span><span class='org identifier id'>org</span><span class='dot token'>.</span><span class='marc4j identifier id'>marc4j</span><span class='dot token'>.</span><span class='MarcXmlReader constant id'>MarcXmlReader</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='input identifier id'>input</span><span class='rparen token'>)</span>
258
+ <span class='else else kw'>else</span>
259
+ <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>&quot;Reader type must be :strictmarc, :permissivemarc, or :marcxml&quot;</span>
260
+ <span class='end end kw'>end</span>
261
+ <span class='end end kw'>end</span>
262
+ </pre>
263
+ </td>
264
+ </tr>
265
+ </table>
266
+ </div>
267
+
268
+ </div>
269
+
270
+ </div>
271
+
272
+ <div id="footer">
273
+ Generated on Sun Feb 14 22:11:53 2010 by
274
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
275
+ 0.5.3 (ruby-1.8.7).
276
+ </div>
277
+
278
+ </body>
279
+ </html>