Original 2.4. With additional eclipse .project/classpath and git ignore
[marc4j.git] / apidoc / org / marc4j / util / MarcXmlDriver.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 MarcXmlDriver (MARC4J API)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="org.marc4j.util.MarcXmlDriver 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="MarcXmlDriver (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/MarcXmlDriver.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;PREV CLASS&nbsp;\r
56 &nbsp;<A HREF="../../../org/marc4j/util/XmlMarcDriver.html" title="class in org.marc4j.util"><B>NEXT CLASS</B></A></FONT></TD>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58   <A HREF="../../../index.html?org/marc4j/util/MarcXmlDriver.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="MarcXmlDriver.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 MarcXmlDriver</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.MarcXmlDriver</B>\r
94 </PRE>\r
95 <HR>\r
96 <DL>\r
97 <DT><PRE>public class <B>MarcXmlDriver</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 basic driver to convert MARC records to MARCXML. Output is encoded in UTF-8.
102  <p>
103  The following example reads input.mrc and writes output to the console:
104  
105  <pre>
106      java org.marc4j.util.MarcXmlDriver input.mrc
107  </pre>
108  
109  <p>
110  The following example reads input.mrc, converts MARC-8 and writes output in
111  UTF-8 to output.xml:
112  
113  <pre>
114      java org.marc4j.util.MarcXmlDriver -convert MARC8 -out output.xml input.mrc
115  </pre>
116  
117  <p>
118  It is possible to post-process the result using an XSLT stylesheet. The
119  following example converts MARC to MODS:
120  
121  <pre>
122      java org.marc4j.util.MarcXmlDriver -convert MARC8 -xsl http://www.loc.gov/standards/mods/v3/MARC21slim2MODS3.xsl -out modsoutput.xml input.mrc
123  </pre>
124  
125  <p>
126  For usage, run from the command-line with the following command:
127  
128  <pre>
129      java org.marc4j.util.MarcXmlDriver -usage
130  </pre>
131  
132  <p>
133  Check the home page for <a href="http://www.loc.gov/standards/marcxml/">
134  MARCXML </a> for more information about the MARCXML format.\r
135 <P>\r
136 \r
137 <P>\r
138 <DL>\r
139 <DT><B>Version:</B></DT>\r
140   <DD>$Revision: 1.5 $</DD>\r
141 <DT><B>Author:</B></DT>\r
142   <DD>Bas Peters</DD>\r
143 </DL>\r
144 <HR>\r
145 \r
146 <P>\r
147 \r
148 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
149 \r
150 <A NAME="constructor_summary"><!-- --></A>\r
151 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
152 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
153 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
154 <B>Constructor Summary</B></FONT></TH>\r
155 </TR>\r
156 <TR BGCOLOR="white" CLASS="TableRowColor">\r
157 <TD><CODE><B><A HREF="../../../org/marc4j/util/MarcXmlDriver.html#MarcXmlDriver()">MarcXmlDriver</A></B>()</CODE>\r
158 \r
159 <BR>\r
160 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
161 </TR>\r
162 </TABLE>\r
163 &nbsp;\r
164 <!-- ========== METHOD SUMMARY =========== -->\r
165 \r
166 <A NAME="method_summary"><!-- --></A>\r
167 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
168 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
169 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
170 <B>Method Summary</B></FONT></TH>\r
171 </TR>\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">\r
173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
174 <CODE>static&nbsp;void</CODE></FONT></TD>\r
175 <TD><CODE><B><A HREF="../../../org/marc4j/util/MarcXmlDriver.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
176 \r
177 <BR>\r
178 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Provides a static entry point.</TD>\r
179 </TR>\r
180 </TABLE>\r
181 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
182 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
183 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
184 <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
185 </TR>\r
186 <TR BGCOLOR="white" CLASS="TableRowColor">\r
187 <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
188 </TR>\r
189 </TABLE>\r
190 &nbsp;\r
191 <P>\r
192 \r
193 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
194 \r
195 <A NAME="constructor_detail"><!-- --></A>\r
196 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
197 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
198 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
199 <B>Constructor Detail</B></FONT></TH>\r
200 </TR>\r
201 </TABLE>\r
202 \r
203 <A NAME="MarcXmlDriver()"><!-- --></A><H3>\r
204 MarcXmlDriver</H3>\r
205 <PRE>\r
206 public <B>MarcXmlDriver</B>()</PRE>\r
207 <DL>\r
208 </DL>\r
209 \r
210 <!-- ============ METHOD DETAIL ========== -->\r
211 \r
212 <A NAME="method_detail"><!-- --></A>\r
213 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
214 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
215 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
216 <B>Method Detail</B></FONT></TH>\r
217 </TR>\r
218 </TABLE>\r
219 \r
220 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
221 main</H3>\r
222 <PRE>\r
223 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
224 <DL>\r
225 <DD>Provides a static entry point.
226  
227  <p>
228  Arguments:
229  </p>
230  <ul>
231  <li>-xsl &lt;stylesheet URL&gt; - post-process using XSLT-stylesheet
232  </li>
233  <li>-out &lt;output file&gt; - write to output file</li>
234  <li>-convert &lt;encoding&gt; - convert &lt;encoding&gt; to UTF-8 (Supported encodings: MARC8, ISO5426, ISO6937)</li>
235  <li>-encode &lt;encoding&gt; - read data using encoding &lt;encoding&gt;</li>
236  <li>-normalize - perform Unicode normalization</li>
237  <li>-usage - show usage</li>
238  <li>&lt;input file&gt; - input file with MARC records
239  </ul>\r
240 <P>\r
241 <DD><DL>\r
242 </DL>\r
243 </DD>\r
244 </DL>\r
245 <!-- ========= END OF CLASS DATA ========= -->\r
246 <HR>\r
247 \r
248 \r
249 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
250 <A NAME="navbar_bottom"><!-- --></A>\r
251 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
252 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
253 <TR>\r
254 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
255 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
256 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
257   <TR ALIGN="center" VALIGN="top">\r
258   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
259   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
260   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
261   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MarcXmlDriver.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
262   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
263   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
264   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
265   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
266   </TR>\r
267 </TABLE>\r
268 </TD>\r
269 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
270 </EM>\r
271 </TD>\r
272 </TR>\r
273 \r
274 <TR>\r
275 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
276 &nbsp;PREV CLASS&nbsp;\r
277 &nbsp;<A HREF="../../../org/marc4j/util/XmlMarcDriver.html" title="class in org.marc4j.util"><B>NEXT CLASS</B></A></FONT></TD>\r
278 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
279   <A HREF="../../../index.html?org/marc4j/util/MarcXmlDriver.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
280 &nbsp;<A HREF="MarcXmlDriver.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
281 &nbsp;<SCRIPT type="text/javascript">\r
282   <!--\r
283   if(window==top) {\r
284     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
285   }\r
286   //-->\r
287 </SCRIPT>\r
288 <NOSCRIPT>\r
289   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
290 </NOSCRIPT>\r
291 \r
292 \r
293 </FONT></TD>\r
294 </TR>\r
295 <TR>\r
296 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
297   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
298 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
299 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
300 </TR>\r
301 </TABLE>\r
302 <A NAME="skip-navbar_bottom"></A>\r
303 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
304 \r
305 <HR>\r
306 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
307 </BODY>\r
308 </HTML>\r