apidoc/org/marc4j/MarcReader.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 MarcReader (MARC4J API)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="org.marc4j.MarcReader 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="MarcReader (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/MarcReader.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/MarcPermissiveStreamReader.html" title="class in org.marc4j"><B>PREV CLASS</B></A>&nbsp;\r
  56 &nbsp;<A HREF="../../org/marc4j/MarcStreamReader.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/MarcReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="MarcReader.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 MarcReader</H2>\r
  91 <DL>\r
  92 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../org/marc4j/MarcDirStreamReader.html" title="class in org.marc4j">MarcDirStreamReader</A>, <A HREF="../../org/marc4j/MarcPermissiveStreamReader.html" title="class in org.marc4j">MarcPermissiveStreamReader</A>, <A HREF="../../org/marc4j/MarcStreamReader.html" title="class in org.marc4j">MarcStreamReader</A>, <A HREF="../../org/marc4j/MarcXmlReader.html" title="class in org.marc4j">MarcXmlReader</A></DD>\r
  93 </DL>\r
  94 <HR>\r
  95 <DL>\r
  96 <DT><PRE>public interface <B>MarcReader</B></DL>\r
  97 </PRE>\r
  98 \r
  99 <P>\r
 100 Implement this interface to provide an iterator over a collection of
 101  <code>Record</code> 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.19 $</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;boolean</CODE></FONT></TD>\r
 129 <TD><CODE><B><A HREF="../../org/marc4j/MarcReader.html#hasNext()">hasNext</A></B>()</CODE>\r
 130 \r
 131 <BR>\r
 132 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the iteration has more records, false otherwise.</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/marc/Record.html" title="interface in org.marc4j.marc">Record</A></CODE></FONT></TD>\r
 137 <TD><CODE><B><A HREF="../../org/marc4j/MarcReader.html#next()">next</A></B>()</CODE>\r
 138 \r
 139 <BR>\r
 140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the next record in the iteration.</TD>\r
 141 </TR>\r
 142 </TABLE>\r
 143 &nbsp;\r
 144 <P>\r
 145 \r
 146 <!-- ============ METHOD DETAIL ========== -->\r
 147 \r
 148 <A NAME="method_detail"><!-- --></A>\r
 149 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 150 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 151 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 152 <B>Method Detail</B></FONT></TH>\r
 153 </TR>\r
 154 </TABLE>\r
 155 \r
 156 <A NAME="hasNext()"><!-- --></A><H3>\r
 157 hasNext</H3>\r
 158 <PRE>\r
 159 boolean <B>hasNext</B>()</PRE>\r
 160 <DL>\r
 161 <DD>Returns true if the iteration has more records, false otherwise.\r
 162 <P>\r
 163 <DD><DL>\r
 164 </DL>\r
 165 </DD>\r
 166 </DL>\r
 167 <HR>\r
 168 \r
 169 <A NAME="next()"><!-- --></A><H3>\r
 170 next</H3>\r
 171 <PRE>\r
 172 <A HREF="../../org/marc4j/marc/Record.html" title="interface in org.marc4j.marc">Record</A> <B>next</B>()</PRE>\r
 173 <DL>\r
 174 <DD>Returns the next record in the iteration.\r
 175 <P>\r
 176 <DD><DL>\r
 177 \r
 178 <DT><B>Returns:</B><DD>Record - the record object</DL>\r
 179 </DD>\r
 180 </DL>\r
 181 <!-- ========= END OF CLASS DATA ========= -->\r
 182 <HR>\r
 183 \r
 184 \r
 185 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 186 <A NAME="navbar_bottom"><!-- --></A>\r
 187 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 188 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 189 <TR>\r
 190 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 191 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 192 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 193   <TR ALIGN="center" VALIGN="top">\r
 194   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 195   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 196   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 197   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MarcReader.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 198   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 199   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 200   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 201   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 202   </TR>\r
 203 </TABLE>\r
 204 </TD>\r
 205 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 206 </EM>\r
 207 </TD>\r
 208 </TR>\r
 209 \r
 210 <TR>\r
 211 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 212 &nbsp;<A HREF="../../org/marc4j/MarcPermissiveStreamReader.html" title="class in org.marc4j"><B>PREV CLASS</B></A>&nbsp;\r
 213 &nbsp;<A HREF="../../org/marc4j/MarcStreamReader.html" title="class in org.marc4j"><B>NEXT CLASS</B></A></FONT></TD>\r
 214 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 215   <A HREF="../../index.html?org/marc4j/MarcReader.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 216 &nbsp;<A HREF="MarcReader.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 217 &nbsp;<SCRIPT type="text/javascript">\r
 218   <!--\r
 219   if(window==top) {\r
 220     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 221   }\r
 222   //-->\r
 223 </SCRIPT>\r
 224 <NOSCRIPT>\r
 225   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 226 </NOSCRIPT>\r
 227 \r
 228 \r
 229 </FONT></TD>\r
 230 </TR>\r
 231 <TR>\r
 232 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 233   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 234 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 235 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 236 </TR>\r
 237 </TABLE>\r
 238 <A NAME="skip-navbar_bottom"></A>\r
 239 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 240 \r
 241 <HR>\r
 242 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
 243 </BODY>\r
 244 </HTML>\r