1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.5.0_06) on Fri Oct 17 16:04:52 EDT 2008 -->
\r
7 RecordStack (MARC4J API)
\r
10 <META NAME="keywords" CONTENT="org.marc4j.RecordStack class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="RecordStack (MARC4J API)";
\r
25 <BODY BGCOLOR="white" onload="windowTitle();">
\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
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> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RecordStack.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
55 <A HREF="../../org/marc4j/MarcXmlWriter.html" title="class in org.marc4j"><B>PREV CLASS</B></A>
\r
56 NEXT CLASS</FONT></TD>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../index.html?org/marc4j/RecordStack.html" target="_top"><B>FRAMES</B></A>
\r
59 <A HREF="RecordStack.html" target="_top"><B>NO FRAMES</B></A>
\r
60 <SCRIPT type="text/javascript">
\r
63 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
68 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
76 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
78 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
81 <A NAME="skip-navbar_top"></A>
\r
82 <!-- ========= END OF TOP NAVBAR ========= -->
\r
85 <!-- ======== START OF CLASS DATA ======== -->
\r
90 Class RecordStack</H2>
\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.RecordStack</B>
\r
97 <DT><PRE>public class <B>RecordStack</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
101 Provides <code>push</code> and <code>pop</code> operations for
102 <code>Record</code> objects created by <code>MarcXmlParser</code>.
\r
107 <DT><B>Version:</B></DT>
\r
108 <DD>$Revision: 1.2 $</DD>
\r
109 <DT><B>Author:</B></DT>
\r
110 <DD>Bas Peters</DD>
\r
116 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
118 <A NAME="constructor_summary"><!-- --></A>
\r
119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
121 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
122 <B>Constructor Summary</B></FONT></TH>
\r
124 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
125 <TD><CODE><B><A HREF="../../org/marc4j/RecordStack.html#RecordStack()">RecordStack</A></B>()</CODE>
\r
128 Default constuctor.</TD>
\r
132 <!-- ========== METHOD SUMMARY =========== -->
\r
134 <A NAME="method_summary"><!-- --></A>
\r
135 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
136 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
137 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
138 <B>Method Summary</B></FONT></TH>
\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
142 <CODE> void</CODE></FONT></TD>
\r
143 <TD><CODE><B><A HREF="../../org/marc4j/RecordStack.html#end()">end</A></B>()</CODE>
\r
146 Called when the end of the document is reached.</TD>
\r
148 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
150 <CODE> boolean</CODE></FONT></TD>
\r
151 <TD><CODE><B><A HREF="../../org/marc4j/RecordStack.html#hasNext()">hasNext</A></B>()</CODE>
\r
154 Returns true if there are more <code>Record</code> objects to expect,
155 false otherwise.</TD>
\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
159 <CODE> void</CODE></FONT></TD>
\r
160 <TD><CODE><B><A HREF="../../org/marc4j/RecordStack.html#passException(java.lang.RuntimeException)">passException</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/RuntimeException.html" title="class or interface in java.lang">RuntimeException</A> e)</CODE>
\r
163 Passes the exception to the thread where the MarcXMLReader is running, so that the next() call
164 that is blocked waiting for this thread, will receive the exception.</TD>
\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
168 <CODE> <A HREF="../../org/marc4j/marc/Record.html" title="interface in org.marc4j.marc">Record</A></CODE></FONT></TD>
\r
169 <TD><CODE><B><A HREF="../../org/marc4j/RecordStack.html#pop()">pop</A></B>()</CODE>
\r
172 Removes the <code>Record</code> object from the stack and returns that
175 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
177 <CODE> void</CODE></FONT></TD>
\r
178 <TD><CODE><B><A HREF="../../org/marc4j/RecordStack.html#push(org.marc4j.marc.Record)">push</A></B>(<A HREF="../../org/marc4j/marc/Record.html" title="interface in org.marc4j.marc">Record</A> record)</CODE>
\r
181 Pushes a <code>Record</code> object on the stack.</TD>
\r
184 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
185 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
186 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
187 <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
189 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
190 <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
196 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
198 <A NAME="constructor_detail"><!-- --></A>
\r
199 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
200 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
201 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
202 <B>Constructor Detail</B></FONT></TH>
\r
206 <A NAME="RecordStack()"><!-- --></A><H3>
\r
209 public <B>RecordStack</B>()</PRE>
\r
211 <DD>Default constuctor.
\r
215 <!-- ============ METHOD DETAIL ========== -->
\r
217 <A NAME="method_detail"><!-- --></A>
\r
218 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
219 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
220 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
221 <B>Method Detail</B></FONT></TH>
\r
225 <A NAME="push(org.marc4j.marc.Record)"><!-- --></A><H3>
\r
228 public void <B>push</B>(<A HREF="../../org/marc4j/marc/Record.html" title="interface in org.marc4j.marc">Record</A> record)</PRE>
\r
230 <DD>Pushes a <code>Record</code> object on the stack.
\r
233 <DT><B>Parameters:</B><DD><CODE>record</CODE> - the record object</DL>
\r
238 <A NAME="pop()"><!-- --></A><H3>
\r
241 public <A HREF="../../org/marc4j/marc/Record.html" title="interface in org.marc4j.marc">Record</A> <B>pop</B>()</PRE>
\r
243 <DD>Removes the <code>Record</code> object from the stack and returns that
248 <DT><B>Returns:</B><DD>Record - the record object</DL>
\r
253 <A NAME="hasNext()"><!-- --></A><H3>
\r
256 public boolean <B>hasNext</B>()</PRE>
\r
258 <DD>Returns true if there are more <code>Record</code> objects to expect,
263 <DT><B>Returns:</B><DD>boolean</DL>
\r
268 <A NAME="passException(java.lang.RuntimeException)"><!-- --></A><H3>
\r
271 public void <B>passException</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/RuntimeException.html" title="class or interface in java.lang">RuntimeException</A> e)</PRE>
\r
273 <DD>Passes the exception to the thread where the MarcXMLReader is running, so that the next() call
274 that is blocked waiting for this thread, will receive the exception.
\r
282 <A NAME="end()"><!-- --></A><H3>
\r
285 public void <B>end</B>()</PRE>
\r
287 <DD>Called when the end of the document is reached.
\r
293 <!-- ========= END OF CLASS DATA ========= -->
\r
297 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
298 <A NAME="navbar_bottom"><!-- --></A>
\r
299 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
300 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
302 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
303 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
304 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
305 <TR ALIGN="center" VALIGN="top">
\r
306 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
307 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
308 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
309 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RecordStack.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
310 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
311 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
312 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
317 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
323 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
324 <A HREF="../../org/marc4j/MarcXmlWriter.html" title="class in org.marc4j"><B>PREV CLASS</B></A>
\r
325 NEXT CLASS</FONT></TD>
\r
326 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
327 <A HREF="../../index.html?org/marc4j/RecordStack.html" target="_top"><B>FRAMES</B></A>
\r
328 <A HREF="RecordStack.html" target="_top"><B>NO FRAMES</B></A>
\r
329 <SCRIPT type="text/javascript">
\r
332 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
337 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
344 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
345 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
346 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
347 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
350 <A NAME="skip-navbar_bottom"></A>
\r
351 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
354 Copyright © 2002-2006 Bas Peters. All Rights Reserved.
\r