apidoc/org/marc4j/MarcWriter.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 MarcWriter (MARC4J API)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="org.marc4j.MarcWriter interface">\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="MarcWriter (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/MarcWriter.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/MarcStreamWriter.html" title="class in org.marc4j"><B>PREV CLASS</B></A>&nbsp;\r
  56 &nbsp;<A HREF="../../org/marc4j/MarcXmlHandler.html" title="class in org.marc4j"><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/MarcWriter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="MarcWriter.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;CONSTR&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;CONSTR&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</FONT>\r
  89 <BR>\r
  90 Interface MarcWriter</H2>\r
  91 <DL>\r
  92 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../org/marc4j/MarcStreamWriter.html" title="class in org.marc4j">MarcStreamWriter</A>, <A HREF="../../org/marc4j/MarcXmlWriter.html" title="class in org.marc4j">MarcXmlWriter</A></DD>\r
  93 </DL>\r
  94 <HR>\r
  95 <DL>\r
  96 <DT><PRE>public interface <B>MarcWriter</B></DL>\r
  97 </PRE>\r
  98 \r
  99 <P>\r
 100 Implement this interface to provide a writer for <code>Record</code>
 101  objects.
 102
 103  <p>See the <A HREF="../../org/marc4j/marc/package-summary.html"><CODE>org.marc4j.marc</CODE></A> package Javadoc for more information
 104  about the <A HREF="../../org/marc4j/marc/Record.html" title="interface in org.marc4j.marc"><CODE>Record</CODE></A> object model.</p>\r
 105 <P>\r
 106 \r
 107 <P>\r
 108 <DL>\r
 109 <DT><B>Version:</B></DT>\r
 110   <DD>$Revision: 1.2 $</DD>\r
 111 <DT><B>Author:</B></DT>\r
 112   <DD>Bas Peters</DD>\r
 113 </DL>\r
 114 <HR>\r
 115 \r
 116 <P>\r
 117 \r
 118 <!-- ========== METHOD SUMMARY =========== -->\r
 119 \r
 120 <A NAME="method_summary"><!-- --></A>\r
 121 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 122 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 123 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 124 <B>Method Summary</B></FONT></TH>\r
 125 </TR>\r
 126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 127 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 128 <CODE>&nbsp;void</CODE></FONT></TD>\r
 129 <TD><CODE><B><A HREF="../../org/marc4j/MarcWriter.html#close()">close</A></B>()</CODE>\r
 130 \r
 131 <BR>\r
 132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the writer.</TD>\r
 133 </TR>\r
 134 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 136 <CODE>&nbsp;<A HREF="../../org/marc4j/converter/CharConverter.html" title="class in org.marc4j.converter">CharConverter</A></CODE></FONT></TD>\r
 137 <TD><CODE><B><A HREF="../../org/marc4j/MarcWriter.html#getConverter()">getConverter</A></B>()</CODE>\r
 138 \r
 139 <BR>\r
 140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the character converter.</TD>\r
 141 </TR>\r
 142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 144 <CODE>&nbsp;void</CODE></FONT></TD>\r
 145 <TD><CODE><B><A HREF="../../org/marc4j/MarcWriter.html#setConverter(org.marc4j.converter.CharConverter)">setConverter</A></B>(<A HREF="../../org/marc4j/converter/CharConverter.html" title="class in org.marc4j.converter">CharConverter</A>&nbsp;converter)</CODE>\r
 146 \r
 147 <BR>\r
 148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the character converter.</TD>\r
 149 </TR>\r
 150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 152 <CODE>&nbsp;void</CODE></FONT></TD>\r
 153 <TD><CODE><B><A HREF="../../org/marc4j/MarcWriter.html#write(org.marc4j.marc.Record)">write</A></B>(<A HREF="../../org/marc4j/marc/Record.html" title="interface in org.marc4j.marc">Record</A>&nbsp;record)</CODE>\r
 154 \r
 155 <BR>\r
 156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes a single <code>Record</code> to the output stream.</TD>\r
 157 </TR>\r
 158 </TABLE>\r
 159 &nbsp;\r
 160 <P>\r
 161 \r
 162 <!-- ============ METHOD DETAIL ========== -->\r
 163 \r
 164 <A NAME="method_detail"><!-- --></A>\r
 165 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 166 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 167 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 168 <B>Method Detail</B></FONT></TH>\r
 169 </TR>\r
 170 </TABLE>\r
 171 \r
 172 <A NAME="write(org.marc4j.marc.Record)"><!-- --></A><H3>\r
 173 write</H3>\r
 174 <PRE>\r
 175 void <B>write</B>(<A HREF="../../org/marc4j/marc/Record.html" title="interface in org.marc4j.marc">Record</A>&nbsp;record)</PRE>\r
 176 <DL>\r
 177 <DD>Writes a single <code>Record</code> to the output stream.\r
 178 <P>\r
 179 <DD><DL>\r
 180 <DT><B>Parameters:</B><DD><CODE>record</CODE> - the Record object</DL>\r
 181 </DD>\r
 182 </DL>\r
 183 <HR>\r
 184 \r
 185 <A NAME="setConverter(org.marc4j.converter.CharConverter)"><!-- --></A><H3>\r
 186 setConverter</H3>\r
 187 <PRE>\r
 188 void <B>setConverter</B>(<A HREF="../../org/marc4j/converter/CharConverter.html" title="class in org.marc4j.converter">CharConverter</A>&nbsp;converter)</PRE>\r
 189 <DL>\r
 190 <DD>Sets the character converter.\r
 191 <P>\r
 192 <DD><DL>\r
 193 <DT><B>Parameters:</B><DD><CODE>converter</CODE> - the character converter</DL>\r
 194 </DD>\r
 195 </DL>\r
 196 <HR>\r
 197 \r
 198 <A NAME="getConverter()"><!-- --></A><H3>\r
 199 getConverter</H3>\r
 200 <PRE>\r
 201 <A HREF="../../org/marc4j/converter/CharConverter.html" title="class in org.marc4j.converter">CharConverter</A> <B>getConverter</B>()</PRE>\r
 202 <DL>\r
 203 <DD>Returns the character converter.\r
 204 <P>\r
 205 <DD><DL>\r
 206 \r
 207 <DT><B>Returns:</B><DD>CharConverter the character converter</DL>\r
 208 </DD>\r
 209 </DL>\r
 210 <HR>\r
 211 \r
 212 <A NAME="close()"><!-- --></A><H3>\r
 213 close</H3>\r
 214 <PRE>\r
 215 void <B>close</B>()</PRE>\r
 216 <DL>\r
 217 <DD>Closes the writer.\r
 218 <P>\r
 219 <DD><DL>\r
 220 </DL>\r
 221 </DD>\r
 222 </DL>\r
 223 <!-- ========= END OF CLASS DATA ========= -->\r
 224 <HR>\r
 225 \r
 226 \r
 227 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 228 <A NAME="navbar_bottom"><!-- --></A>\r
 229 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 230 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 231 <TR>\r
 232 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 233 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 234 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 235   <TR ALIGN="center" VALIGN="top">\r
 236   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 237   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 238   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 239   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MarcWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 240   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 241   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 242   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 243   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 244   </TR>\r
 245 </TABLE>\r
 246 </TD>\r
 247 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 248 </EM>\r
 249 </TD>\r
 250 </TR>\r
 251 \r
 252 <TR>\r
 253 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 254 &nbsp;<A HREF="../../org/marc4j/MarcStreamWriter.html" title="class in org.marc4j"><B>PREV CLASS</B></A>&nbsp;\r
 255 &nbsp;<A HREF="../../org/marc4j/MarcXmlHandler.html" title="class in org.marc4j"><B>NEXT CLASS</B></A></FONT></TD>\r
 256 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 257   <A HREF="../../index.html?org/marc4j/MarcWriter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 258 &nbsp;<A HREF="MarcWriter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 259 &nbsp;<SCRIPT type="text/javascript">\r
 260   <!--\r
 261   if(window==top) {\r
 262     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 263   }\r
 264   //-->\r
 265 </SCRIPT>\r
 266 <NOSCRIPT>\r
 267   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 268 </NOSCRIPT>\r
 269 \r
 270 \r
 271 </FONT></TD>\r
 272 </TR>\r
 273 <TR>\r
 274 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 275   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 276 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 277 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 278 </TR>\r
 279 </TABLE>\r
 280 <A NAME="skip-navbar_bottom"></A>\r
 281 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 282 \r
 283 <HR>\r
 284 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
 285 </BODY>\r
 286 </HTML>\r