apidoc/org/marc4j/package-summary.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:53 EDT 2008 -->\r
   6 <TITLE>\r
   7 org.marc4j (MARC4J API)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="org.marc4j package">\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="org.marc4j (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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
  39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.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 PACKAGE&nbsp;\r
  56 &nbsp;<A HREF="../../org/marc4j/converter/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58   <A HREF="../../index.html?org/marc4j/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="package-summary.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 </TABLE>\r
  75 <A NAME="skip-navbar_top"></A>\r
  76 <!-- ========= END OF TOP NAVBAR ========= -->\r
  77 \r
  78 <HR>\r
  79 <H2>\r
  80 Package org.marc4j\r
  81 </H2>\r
  82 Classes to read and write MARC and MARCXML records.\r
  83 <P>\r
  84 <B>See:</B>\r
  85 <BR>\r
  86 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>\r
  87 <P>\r
  88 \r
  89 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
  90 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
  91 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
  92 <B>Interface Summary</B></FONT></TH>\r
  93 </TR>\r
  94 <TR BGCOLOR="white" CLASS="TableRowColor">\r
  95 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcReader.html" title="interface in org.marc4j">MarcReader</A></B></TD>\r
  96 <TD>Implement this interface to provide an iterator over a collection of
  97  <code>Record</code> objects.</TD>\r
  98 </TR>\r
  99 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 100 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcWriter.html" title="interface in org.marc4j">MarcWriter</A></B></TD>\r
 101 <TD>Implement this interface to provide a writer for <code>Record</code>
 102  objects.</TD>\r
 103 </TR>\r
 104 </TABLE>\r
 105 &nbsp;\r
 106 \r
 107 <P>\r
 108 \r
 109 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 110 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 111 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 112 <B>Class Summary</B></FONT></TH>\r
 113 </TR>\r
 114 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 115 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/Constants.html" title="class in org.marc4j">Constants</A></B></TD>\r
 116 <TD>Defines constant values.</TD>\r
 117 </TR>\r
 118 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 119 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/ErrorHandler.html" title="class in org.marc4j">ErrorHandler</A></B></TD>\r
 120 <TD>Defines and describes errors encountered in the processing a given MARC record.</TD>\r
 121 </TR>\r
 122 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 123 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcDirStreamReader.html" title="class in org.marc4j">MarcDirStreamReader</A></B></TD>\r
 124 <TD>
 125  A Marc reader which instead of handling a single file of MARC records
 126  it handles a directory, which it will scan for all .mrc files, and
 127  iterate through all of them in turn.</TD>\r
 128 </TR>\r
 129 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 130 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcPermissiveStreamReader.html" title="class in org.marc4j">MarcPermissiveStreamReader</A></B></TD>\r
 131 <TD>An iterator over a collection of MARC records in ISO 2709 format, that is designed
 132  to be able to handle MARC records that have errors in their structure or their encoding.</TD>\r
 133 </TR>\r
 134 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 135 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcStreamReader.html" title="class in org.marc4j">MarcStreamReader</A></B></TD>\r
 136 <TD>An iterator over a collection of MARC records in ISO 2709 format.</TD>\r
 137 </TR>\r
 138 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 139 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcStreamWriter.html" title="class in org.marc4j">MarcStreamWriter</A></B></TD>\r
 140 <TD>Class for writing MARC record objects in ISO 2709 format.</TD>\r
 141 </TR>\r
 142 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 143 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcXmlHandler.html" title="class in org.marc4j">MarcXmlHandler</A></B></TD>\r
 144 <TD>Creates <code>Record</code> objects from SAX events and pushes each item
 145  onto the top of the <code>RecordStack</code>.</TD>\r
 146 </TR>\r
 147 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 148 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcXmlParser.html" title="class in org.marc4j">MarcXmlParser</A></B></TD>\r
 149 <TD>Creates <code>Record</code> objects from SAX events and pushes each item
 150  onto the top of the <code>RecordStack</code>.</TD>\r
 151 </TR>\r
 152 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 153 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcXmlParserThread.html" title="class in org.marc4j">MarcXmlParserThread</A></B></TD>\r
 154 <TD>Extends <code>Thread</code> to produce <code>Record</code> objects from
 155  MARCXML data.</TD>\r
 156 </TR>\r
 157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 158 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcXmlReader.html" title="class in org.marc4j">MarcXmlReader</A></B></TD>\r
 159 <TD>An iterator over a collection of MARC records in MARCXML format.</TD>\r
 160 </TR>\r
 161 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 162 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcXmlWriter.html" title="class in org.marc4j">MarcXmlWriter</A></B></TD>\r
 163 <TD>Class for writing MARC record objects in MARCXML format.</TD>\r
 164 </TR>\r
 165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 166 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/RecordStack.html" title="class in org.marc4j">RecordStack</A></B></TD>\r
 167 <TD>Provides <code>push</code> and <code>pop</code> operations for
 168  <code>Record</code> objects created by <code>MarcXmlParser</code>.</TD>\r
 169 </TR>\r
 170 </TABLE>\r
 171 &nbsp;\r
 172 \r
 173 <P>\r
 174 \r
 175 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 176 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 177 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 178 <B>Exception Summary</B></FONT></TH>\r
 179 </TR>\r
 180 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 181 <TD WIDTH="15%"><B><A HREF="../../org/marc4j/MarcException.html" title="class in org.marc4j">MarcException</A></B></TD>\r
 182 <TD>Thrown in various situations by MARC4J; may contain a nested exception.</TD>\r
 183 </TR>\r
 184 </TABLE>\r
 185 &nbsp;\r
 186 \r
 187 <P>\r
 188 <A NAME="package_description"><!-- --></A><H2>\r
 189 Package org.marc4j Description\r
 190 </H2>\r
 191 \r
 192 <P>\r
 193 <p>Classes to read and write MARC and MARCXML records. MARC4J should be able to process formats like MARC21 and UNIMARC.</p>\r
 194     <p>Use <code>MarcStreamReader</code> to read MARC records and <code>MarcStreamWriter</code> to write records in MARC format. Use <code>MarcXmlReader</code> to read MARCXML records and <code>MarcXmlWriter</code> to write records in MARCXML format.</p>\r
 195 <P>\r
 196 \r
 197 <P>\r
 198 <DL>\r
 199 </DL>\r
 200 <HR>\r
 201 \r
 202 \r
 203 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 204 <A NAME="navbar_bottom"><!-- --></A>\r
 205 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 206 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 207 <TR>\r
 208 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 209 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 210 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 211   <TR ALIGN="center" VALIGN="top">\r
 212   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 213   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
 214   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
 215   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 216   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 217   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 218   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 219   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 220   </TR>\r
 221 </TABLE>\r
 222 </TD>\r
 223 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 224 </EM>\r
 225 </TD>\r
 226 </TR>\r
 227 \r
 228 <TR>\r
 229 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 230 &nbsp;PREV PACKAGE&nbsp;\r
 231 &nbsp;<A HREF="../../org/marc4j/converter/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
 232 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 233   <A HREF="../../index.html?org/marc4j/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 234 &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 235 &nbsp;<SCRIPT type="text/javascript">\r
 236   <!--\r
 237   if(window==top) {\r
 238     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 239   }\r
 240   //-->\r
 241 </SCRIPT>\r
 242 <NOSCRIPT>\r
 243   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 244 </NOSCRIPT>\r
 245 \r
 246 \r
 247 </FONT></TD>\r
 248 </TR>\r
 249 </TABLE>\r
 250 <A NAME="skip-navbar_bottom"></A>\r
 251 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 252 \r
 253 <HR>\r
 254 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
 255 </BODY>\r
 256 </HTML>\r