Original 2.4. With additional eclipse .project/classpath and git ignore
[marc4j.git] / apidoc / org / marc4j / util / XmlMarcDriver.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.5.0_06) on Fri Oct 17 16:04:52 EDT 2008 -->\r
6 <TITLE>\r
7 XmlMarcDriver (MARC4J API)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="org.marc4j.util.XmlMarcDriver class">\r
11 \r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
13 \r
14 <SCRIPT type="text/javascript">\r
15 function windowTitle()\r
16 {\r
17     parent.document.title="XmlMarcDriver (MARC4J API)";\r
18 }\r
19 </SCRIPT>\r
20 <NOSCRIPT>\r
21 </NOSCRIPT>\r
22 \r
23 </HEAD>\r
24 \r
25 <BODY BGCOLOR="white" onload="windowTitle();">\r
26 \r
27 \r
28 <!-- ========= START OF TOP NAVBAR ======= -->\r
29 <A NAME="navbar_top"><!-- --></A>\r
30 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
31 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
32 <TR>\r
33 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
34 <A NAME="navbar_top_firstrow"><!-- --></A>\r
35 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
36   <TR ALIGN="center" VALIGN="top">\r
37   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/XmlMarcDriver.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
45   </TR>\r
46 </TABLE>\r
47 </TD>\r
48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
49 </EM>\r
50 </TD>\r
51 </TR>\r
52 \r
53 <TR>\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
55 &nbsp;<A HREF="../../../org/marc4j/util/MarcXmlDriver.html" title="class in org.marc4j.util"><B>PREV CLASS</B></A>&nbsp;\r
56 &nbsp;NEXT CLASS</FONT></TD>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58   <A HREF="../../../index.html?org/marc4j/util/XmlMarcDriver.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="XmlMarcDriver.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
60 &nbsp;<SCRIPT type="text/javascript">\r
61   <!--\r
62   if(window==top) {\r
63     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
64   }\r
65   //-->\r
66 </SCRIPT>\r
67 <NOSCRIPT>\r
68   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
69 </NOSCRIPT>\r
70 \r
71 \r
72 </FONT></TD>\r
73 </TR>\r
74 <TR>\r
75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
76   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
78 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
79 </TR>\r
80 </TABLE>\r
81 <A NAME="skip-navbar_top"></A>\r
82 <!-- ========= END OF TOP NAVBAR ========= -->\r
83 \r
84 <HR>\r
85 <!-- ======== START OF CLASS DATA ======== -->\r
86 <H2>\r
87 <FONT SIZE="-1">\r
88 org.marc4j.util</FONT>\r
89 <BR>\r
90 Class XmlMarcDriver</H2>\r
91 <PRE>\r
92 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>\r
93   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.marc4j.util.XmlMarcDriver</B>\r
94 </PRE>\r
95 <HR>\r
96 <DL>\r
97 <DT><PRE>public class <B>XmlMarcDriver</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL>\r
98 </PRE>\r
99 \r
100 <P>\r
101 Provides a driver to convert MARCXML records to MARC format.
102  
103  <p>
104  The following example reads input.xml and writes output to the console:
105  </p>
106  
107  <pre>
108        java org.marc4j.util.XmlMarcDriver input.xml
109  </pre>
110  
111  <p>
112  The following example reads input.xml, converts UTF-8 and writes output in
113  MARC-8 to output.mrc:
114  </p>
115  
116  <pre>
117        java org.marc4j.util.XmlMarcDriver -convert MARC8 -out output.mrc input.xml
118  </pre>
119  
120  <p>
121  It is possible to pre-process the input file using an XSLT stylesheet. The
122  transformation should produce valid MARCXML. The following example transforms
123  a MODS file to MARCXML and outputs MARC records.
124  </p>
125  
126  <pre>
127        java org.marc4j.util.XmlMarcDriver -convert MARC8 -out output.mrc -xsl http://www.loc.gov/standards/marcxml/xslt/MODS2MARC21slim.xsl modsfile.xml
128  </pre>
129  
130  <p>
131  For usage, run from the command-line with the following command:
132  </p>
133  
134  <pre>
135        java org.marc4j.util.XmlMarcDriver -usage
136  </pre>
137  
138  <p>
139  Check the home page for <a href="http://www.loc.gov/standards/marcxml/">
140  MARCXML </a> for more information about the MARCXML format.
141  </p>\r
142 <P>\r
143 \r
144 <P>\r
145 <DL>\r
146 <DT><B>Version:</B></DT>\r
147   <DD>$Revision: 1.4 $</DD>\r
148 <DT><B>Author:</B></DT>\r
149   <DD>Bas Peters</DD>\r
150 </DL>\r
151 <HR>\r
152 \r
153 <P>\r
154 \r
155 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
156 \r
157 <A NAME="constructor_summary"><!-- --></A>\r
158 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
159 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
160 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
161 <B>Constructor Summary</B></FONT></TH>\r
162 </TR>\r
163 <TR BGCOLOR="white" CLASS="TableRowColor">\r
164 <TD><CODE><B><A HREF="../../../org/marc4j/util/XmlMarcDriver.html#XmlMarcDriver()">XmlMarcDriver</A></B>()</CODE>\r
165 \r
166 <BR>\r
167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
168 </TR>\r
169 </TABLE>\r
170 &nbsp;\r
171 <!-- ========== METHOD SUMMARY =========== -->\r
172 \r
173 <A NAME="method_summary"><!-- --></A>\r
174 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
175 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
176 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
177 <B>Method Summary</B></FONT></TH>\r
178 </TR>\r
179 <TR BGCOLOR="white" CLASS="TableRowColor">\r
180 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
181 <CODE>static&nbsp;void</CODE></FONT></TD>\r
182 <TD><CODE><B><A HREF="../../../org/marc4j/util/XmlMarcDriver.html#main(java.lang.String[])">main</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]&nbsp;args)</CODE>\r
183 \r
184 <BR>\r
185 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Provides a static entry point.</TD>\r
186 </TR>\r
187 </TABLE>\r
188 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
189 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
190 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
191 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>\r
192 </TR>\r
193 <TR BGCOLOR="white" CLASS="TableRowColor">\r
194 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
195 </TR>\r
196 </TABLE>\r
197 &nbsp;\r
198 <P>\r
199 \r
200 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
201 \r
202 <A NAME="constructor_detail"><!-- --></A>\r
203 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
204 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
205 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
206 <B>Constructor Detail</B></FONT></TH>\r
207 </TR>\r
208 </TABLE>\r
209 \r
210 <A NAME="XmlMarcDriver()"><!-- --></A><H3>\r
211 XmlMarcDriver</H3>\r
212 <PRE>\r
213 public <B>XmlMarcDriver</B>()</PRE>\r
214 <DL>\r
215 </DL>\r
216 \r
217 <!-- ============ METHOD DETAIL ========== -->\r
218 \r
219 <A NAME="method_detail"><!-- --></A>\r
220 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
221 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
222 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
223 <B>Method Detail</B></FONT></TH>\r
224 </TR>\r
225 </TABLE>\r
226 \r
227 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
228 main</H3>\r
229 <PRE>\r
230 public static void <B>main</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]&nbsp;args)</PRE>\r
231 <DL>\r
232 <DD>Provides a static entry point.
233  
234  <p>
235  Arguments:
236  </p>
237  <ul>
238  <li>-xsl &lt;stylesheet URL&gt; - pre-process using XSLT-stylesheet</li>
239  <li>-out &lt;output file&gt; - write to output file</li>
240  <li>-convert &lt;encoding&gt; - convert UTF-8 to &lt;encoding&gt;
241  (Supported encodings: MARC8, ISO5426, ISO6937)</li>
242  <li>-encoding &lt;encoding&gt; - Output using specified Java character
243  encoding</li>
244  <li>-usage - show usage</li>
245  <li>&lt;input file&gt; - input file with MARCXML records or a
246  transformation source
247  </ul>\r
248 <P>\r
249 <DD><DL>\r
250 </DL>\r
251 </DD>\r
252 </DL>\r
253 <!-- ========= END OF CLASS DATA ========= -->\r
254 <HR>\r
255 \r
256 \r
257 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
258 <A NAME="navbar_bottom"><!-- --></A>\r
259 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
260 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
261 <TR>\r
262 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
263 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
264 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
265   <TR ALIGN="center" VALIGN="top">\r
266   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
267   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
268   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
269   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/XmlMarcDriver.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
270   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
271   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
272   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
273   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
274   </TR>\r
275 </TABLE>\r
276 </TD>\r
277 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
278 </EM>\r
279 </TD>\r
280 </TR>\r
281 \r
282 <TR>\r
283 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
284 &nbsp;<A HREF="../../../org/marc4j/util/MarcXmlDriver.html" title="class in org.marc4j.util"><B>PREV CLASS</B></A>&nbsp;\r
285 &nbsp;NEXT CLASS</FONT></TD>\r
286 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
287   <A HREF="../../../index.html?org/marc4j/util/XmlMarcDriver.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
288 &nbsp;<A HREF="XmlMarcDriver.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
289 &nbsp;<SCRIPT type="text/javascript">\r
290   <!--\r
291   if(window==top) {\r
292     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
293   }\r
294   //-->\r
295 </SCRIPT>\r
296 <NOSCRIPT>\r
297   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
298 </NOSCRIPT>\r
299 \r
300 \r
301 </FONT></TD>\r
302 </TR>\r
303 <TR>\r
304 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
305   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
306 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
307 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
308 </TR>\r
309 </TABLE>\r
310 <A NAME="skip-navbar_bottom"></A>\r
311 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
312 \r
313 <HR>\r
314 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
315 </BODY>\r
316 </HTML>\r