Use field variable with qualified field name. FIX namespace!
[marc4j.git] / apidoc / org / marc4j / ErrorHandler.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 ErrorHandler (MARC4J API)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="org.marc4j.ErrorHandler 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="ErrorHandler (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/ErrorHandler.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/Constants.html" title="class in org.marc4j"><B>PREV CLASS</B></A>&nbsp;\r
56 &nbsp;<A HREF="../../org/marc4j/ErrorHandler.Error.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/ErrorHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="ErrorHandler.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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</FONT>\r
89 <BR>\r
90 Class ErrorHandler</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.ErrorHandler</B>\r
94 </PRE>\r
95 <HR>\r
96 <DL>\r
97 <DT><PRE>public class <B>ErrorHandler</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 Defines and describes errors encountered in the processing a given MARC record.
102  Used in conjunction with the MarcPermissiveReader class.\r
103 <P>\r
104 \r
105 <P>\r
106 <DL>\r
107 <DT><B>Version:</B></DT>\r
108   <DD>$Revision: 1.8 $</DD>\r
109 <DT><B>Author:</B></DT>\r
110   <DD>Robert Haschart</DD>\r
111 </DL>\r
112 <HR>\r
113 \r
114 <P>\r
115 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
116 \r
117 <A NAME="nested_class_summary"><!-- --></A>\r
118 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
119 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
120 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
121 <B>Nested Class Summary</B></FONT></TH>\r
122 </TR>\r
123 <TR BGCOLOR="white" CLASS="TableRowColor">\r
124 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
125 <CODE>&nbsp;class</CODE></FONT></TD>\r
126 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.Error.html" title="class in org.marc4j">ErrorHandler.Error</A></B></CODE>\r
127 \r
128 <BR>\r
129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
130 </TR>\r
131 </TABLE>\r
132 &nbsp;<!-- =========== FIELD SUMMARY =========== -->\r
133 \r
134 <A NAME="field_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>Field Summary</B></FONT></TH>\r
139 </TR>\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
142 <CODE>static&nbsp;int</CODE></FONT></TD>\r
143 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#ERROR_TYPO">ERROR_TYPO</A></B></CODE>\r
144 \r
145 <BR>\r
146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ERROR_TYPO indicates that an even less severe problem was found with the record,
147  such as the record leader ends with characters other than "4500" or a field tag 
148  contains non-numeric characters the record contains a html-style entity reference 
149  such as &amp; or &quote; which was replaced with the unescaped version.</TD>\r
150 </TR>\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
153 <CODE>static&nbsp;int</CODE></FONT></TD>\r
154 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#FATAL">FATAL</A></B></CODE>\r
155 \r
156 <BR>\r
157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;FATAL is the most severe error, it is usually set in conjunction with throwing an
158  exception, generally no record is returned when a FATAL error occurs.</TD>\r
159 </TR>\r
160 <TR BGCOLOR="white" CLASS="TableRowColor">\r
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
162 <CODE>static&nbsp;int</CODE></FONT></TD>\r
163 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#INFO">INFO</A></B></CODE>\r
164 \r
165 <BR>\r
166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;INFO is used to pass information about the record translation process.</TD>\r
167 </TR>\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
170 <CODE>static&nbsp;int</CODE></FONT></TD>\r
171 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#MAJOR_ERROR">MAJOR_ERROR</A></B></CODE>\r
172 \r
173 <BR>\r
174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;MAJOR_ERROR indicates that a serious problem existed with the record, such as a 
175  malformed directory or an invalid subfield tag, or an encoding error where missing 
176  data had to be inferred through some heuristic process.</TD>\r
177 </TR>\r
178 <TR BGCOLOR="white" CLASS="TableRowColor">\r
179 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
180 <CODE>static&nbsp;int</CODE></FONT></TD>\r
181 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#MINOR_ERROR">MINOR_ERROR</A></B></CODE>\r
182 \r
183 <BR>\r
184 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;MINOR_ERROR indicates that a less serious problem existed with the record, such as 
185  a mismatch between the directory stated field sizes and the actual field sizes, 
186  or an encoding error where extraneous data had to be discarded to correctly 
187  interpret the data.</TD>\r
188 </TR>\r
189 </TABLE>\r
190 &nbsp;\r
191 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
192 \r
193 <A NAME="constructor_summary"><!-- --></A>\r
194 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
195 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
196 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
197 <B>Constructor Summary</B></FONT></TH>\r
198 </TR>\r
199 <TR BGCOLOR="white" CLASS="TableRowColor">\r
200 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#ErrorHandler()">ErrorHandler</A></B>()</CODE>\r
201 \r
202 <BR>\r
203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
204 </TR>\r
205 </TABLE>\r
206 &nbsp;\r
207 <!-- ========== METHOD SUMMARY =========== -->\r
208 \r
209 <A NAME="method_summary"><!-- --></A>\r
210 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
211 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
212 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
213 <B>Method Summary</B></FONT></TH>\r
214 </TR>\r
215 <TR BGCOLOR="white" CLASS="TableRowColor">\r
216 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
217 <CODE>&nbsp;void</CODE></FONT></TD>\r
218 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#addError(int, java.lang.String)">addError</A></B>(int&nbsp;severity,\r
219          <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;message)</CODE>\r
220 \r
221 <BR>\r
222 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs an error message using the stated severity level.</TD>\r
223 </TR>\r
224 <TR BGCOLOR="white" CLASS="TableRowColor">\r
225 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
226 <CODE>&nbsp;void</CODE></FONT></TD>\r
227 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#addError(java.lang.String, java.lang.String, java.lang.String, int, java.lang.String)">addError</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;id,\r
228          <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;field,\r
229          <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;subfield,\r
230          int&nbsp;severity,\r
231          <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;message)</CODE>\r
232 \r
233 <BR>\r
234 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Logs an error message using the stated severity level.</TD>\r
235 </TR>\r
236 <TR BGCOLOR="white" CLASS="TableRowColor">\r
237 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
238 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/List.html" title="class or interface in java.util">List</A></CODE></FONT></TD>\r
239 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#getErrors()">getErrors</A></B>()</CODE>\r
240 \r
241 <BR>\r
242 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of all of the errors encountered in processing the current record.</TD>\r
243 </TR>\r
244 <TR BGCOLOR="white" CLASS="TableRowColor">\r
245 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
246 <CODE>&nbsp;int</CODE></FONT></TD>\r
247 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#getMaxSeverity()">getMaxSeverity</A></B>()</CODE>\r
248 \r
249 <BR>\r
250 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the highest error severity level encountered in processing the current record.</TD>\r
251 </TR>\r
252 <TR BGCOLOR="white" CLASS="TableRowColor">\r
253 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
254 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
255 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#hasErrors()">hasErrors</A></B>()</CODE>\r
256 \r
257 <BR>\r
258 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if any errors (or warnings) were encountered in processing the 
259   current record.</TD>\r
260 </TR>\r
261 <TR BGCOLOR="white" CLASS="TableRowColor">\r
262 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
263 <CODE>&nbsp;void</CODE></FONT></TD>\r
264 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#reset()">reset</A></B>()</CODE>\r
265 \r
266 <BR>\r
267 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resets the list of errors to empty.</TD>\r
268 </TR>\r
269 <TR BGCOLOR="white" CLASS="TableRowColor">\r
270 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
271 <CODE>&nbsp;void</CODE></FONT></TD>\r
272 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#setCurrentField(java.lang.String)">setCurrentField</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;curField)</CODE>\r
273 \r
274 <BR>\r
275 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the field tag to be stored for subsequent error messages that are logged</TD>\r
276 </TR>\r
277 <TR BGCOLOR="white" CLASS="TableRowColor">\r
278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
279 <CODE>&nbsp;void</CODE></FONT></TD>\r
280 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#setCurrentSubfield(java.lang.String)">setCurrentSubfield</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;curSubfield)</CODE>\r
281 \r
282 <BR>\r
283 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the subfield tag to be stored for subsequent error messages that are logged</TD>\r
284 </TR>\r
285 <TR BGCOLOR="white" CLASS="TableRowColor">\r
286 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
287 <CODE>&nbsp;void</CODE></FONT></TD>\r
288 <TD><CODE><B><A HREF="../../org/marc4j/ErrorHandler.html#setRecordID(java.lang.String)">setRecordID</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;recordID)</CODE>\r
289 \r
290 <BR>\r
291 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the record ID to be stored for subsequent error messages that are logged
292   If any previous messages are stored for the current record that don't have a 
293   stored record ID, set the value for those entries to this value also.</TD>\r
294 </TR>\r
295 </TABLE>\r
296 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
297 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
298 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
299 <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
300 </TR>\r
301 <TR BGCOLOR="white" CLASS="TableRowColor">\r
302 <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
303 </TR>\r
304 </TABLE>\r
305 &nbsp;\r
306 <P>\r
307 \r
308 <!-- ============ FIELD DETAIL =========== -->\r
309 \r
310 <A NAME="field_detail"><!-- --></A>\r
311 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
312 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
313 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
314 <B>Field Detail</B></FONT></TH>\r
315 </TR>\r
316 </TABLE>\r
317 \r
318 <A NAME="FATAL"><!-- --></A><H3>\r
319 FATAL</H3>\r
320 <PRE>\r
321 public static final int <B>FATAL</B></PRE>\r
322 <DL>\r
323 <DD>FATAL is the most severe error, it is usually set in conjunction with throwing an
324  exception, generally no record is returned when a FATAL error occurs.  Although in 
325  some instances (a record with a field > 9999 bytes long) a record will be returned 
326  that can be used, but it cannot be written back out without causing an error.\r
327 <P>\r
328 <DL>\r
329 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#org.marc4j.ErrorHandler.FATAL">Constant Field Values</A></DL>\r
330 </DL>\r
331 <HR>\r
332 \r
333 <A NAME="MAJOR_ERROR"><!-- --></A><H3>\r
334 MAJOR_ERROR</H3>\r
335 <PRE>\r
336 public static final int <B>MAJOR_ERROR</B></PRE>\r
337 <DL>\r
338 <DD>MAJOR_ERROR indicates that a serious problem existed with the record, such as a 
339  malformed directory or an invalid subfield tag, or an encoding error where missing 
340  data had to be inferred through some heuristic process.  This indicates that 
341  although a record is returned, you cannot be sure that the record is not corrupted.\r
342 <P>\r
343 <DL>\r
344 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#org.marc4j.ErrorHandler.MAJOR_ERROR">Constant Field Values</A></DL>\r
345 </DL>\r
346 <HR>\r
347 \r
348 <A NAME="MINOR_ERROR"><!-- --></A><H3>\r
349 MINOR_ERROR</H3>\r
350 <PRE>\r
351 public static final int <B>MINOR_ERROR</B></PRE>\r
352 <DL>\r
353 <DD>MINOR_ERROR indicates that a less serious problem existed with the record, such as 
354  a mismatch between the directory stated field sizes and the actual field sizes, 
355  or an encoding error where extraneous data had to be discarded to correctly 
356  interpret the data.\r
357 <P>\r
358 <DL>\r
359 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#org.marc4j.ErrorHandler.MINOR_ERROR">Constant Field Values</A></DL>\r
360 </DL>\r
361 <HR>\r
362 \r
363 <A NAME="ERROR_TYPO"><!-- --></A><H3>\r
364 ERROR_TYPO</H3>\r
365 <PRE>\r
366 public static final int <B>ERROR_TYPO</B></PRE>\r
367 <DL>\r
368 <DD>ERROR_TYPO indicates that an even less severe problem was found with the record,
369  such as the record leader ends with characters other than "4500" or a field tag 
370  contains non-numeric characters the record contains a html-style entity reference 
371  such as &amp; or &quote; which was replaced with the unescaped version.\r
372 <P>\r
373 <DL>\r
374 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#org.marc4j.ErrorHandler.ERROR_TYPO">Constant Field Values</A></DL>\r
375 </DL>\r
376 <HR>\r
377 \r
378 <A NAME="INFO"><!-- --></A><H3>\r
379 INFO</H3>\r
380 <PRE>\r
381 public static final int <B>INFO</B></PRE>\r
382 <DL>\r
383 <DD>INFO is used to pass information about the record translation process.  It does 
384  not indicate an error.  It usually will occur when a defaultEncoding value of "BESTGUESS"
385  is passed in.  INFO statements are generated to indicate which character encoding was 
386  determined to be the best fit for the data, and why.\r
387 <P>\r
388 <DL>\r
389 <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#org.marc4j.ErrorHandler.INFO">Constant Field Values</A></DL>\r
390 </DL>\r
391 \r
392 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
393 \r
394 <A NAME="constructor_detail"><!-- --></A>\r
395 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
396 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
397 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
398 <B>Constructor Detail</B></FONT></TH>\r
399 </TR>\r
400 </TABLE>\r
401 \r
402 <A NAME="ErrorHandler()"><!-- --></A><H3>\r
403 ErrorHandler</H3>\r
404 <PRE>\r
405 public <B>ErrorHandler</B>()</PRE>\r
406 <DL>\r
407 </DL>\r
408 \r
409 <!-- ============ METHOD DETAIL ========== -->\r
410 \r
411 <A NAME="method_detail"><!-- --></A>\r
412 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
413 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
414 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
415 <B>Method Detail</B></FONT></TH>\r
416 </TR>\r
417 </TABLE>\r
418 \r
419 <A NAME="hasErrors()"><!-- --></A><H3>\r
420 hasErrors</H3>\r
421 <PRE>\r
422 public boolean <B>hasErrors</B>()</PRE>\r
423 <DL>\r
424 <DD>Returns true if any errors (or warnings) were encountered in processing the 
425   current record.  Note that if only INFO level messages are encountered for a 
426   given record, this method will return false.\r
427 <P>\r
428 <DD><DL>\r
429 \r
430 <DT><B>Returns:</B><DD>boolean - The highest error severity level encountered for the current record.</DL>\r
431 </DD>\r
432 </DL>\r
433 <HR>\r
434 \r
435 <A NAME="getMaxSeverity()"><!-- --></A><H3>\r
436 getMaxSeverity</H3>\r
437 <PRE>\r
438 public int <B>getMaxSeverity</B>()</PRE>\r
439 <DL>\r
440 <DD>Returns the highest error severity level encountered in processing the current record.\r
441 <P>\r
442 <DD><DL>\r
443 \r
444 <DT><B>Returns:</B><DD>int - The highest error severity level encountered for the current record.</DL>\r
445 </DD>\r
446 </DL>\r
447 <HR>\r
448 \r
449 <A NAME="getErrors()"><!-- --></A><H3>\r
450 getErrors</H3>\r
451 <PRE>\r
452 public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/List.html" title="class or interface in java.util">List</A> <B>getErrors</B>()</PRE>\r
453 <DL>\r
454 <DD>Returns a list of all of the errors encountered in processing the current record.\r
455 <P>\r
456 <DD><DL>\r
457 \r
458 <DT><B>Returns:</B><DD>List - A list of all of the errors encountered for the current record.</DL>\r
459 </DD>\r
460 </DL>\r
461 <HR>\r
462 \r
463 <A NAME="reset()"><!-- --></A><H3>\r
464 reset</H3>\r
465 <PRE>\r
466 public void <B>reset</B>()</PRE>\r
467 <DL>\r
468 <DD>Resets the list of errors to empty. This should be called at the beginning of 
469   processing of each record.\r
470 <P>\r
471 <DD><DL>\r
472 </DL>\r
473 </DD>\r
474 </DL>\r
475 <HR>\r
476 \r
477 <A NAME="addError(java.lang.String, java.lang.String, java.lang.String, int, java.lang.String)"><!-- --></A><H3>\r
478 addError</H3>\r
479 <PRE>\r
480 public void <B>addError</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;id,\r
481                      <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;field,\r
482                      <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;subfield,\r
483                      int&nbsp;severity,\r
484                      <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;message)</PRE>\r
485 <DL>\r
486 <DD>Logs an error message using the stated severity level.  Uses the values passed  
487   in id, field, and subfield to note the location of the error.\r
488 <P>\r
489 <DD><DL>\r
490 <DT><B>Parameters:</B><DD><CODE>id</CODE> - - the record ID of the record currently being processed<DD><CODE>field</CODE> - - the tag of the field currently being processed<DD><CODE>subfield</CODE> - - the subfield tag of the subfield currently being processed<DD><CODE>severity</CODE> - - An indication of the relative severity of the error that was 
491                                                 encountered.<DD><CODE>message</CODE> - - A descriptive message about the error that was encountered.</DL>\r
492 </DD>\r
493 </DL>\r
494 <HR>\r
495 \r
496 <A NAME="addError(int, java.lang.String)"><!-- --></A><H3>\r
497 addError</H3>\r
498 <PRE>\r
499 public void <B>addError</B>(int&nbsp;severity,\r
500                      <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;message)</PRE>\r
501 <DL>\r
502 <DD>Logs an error message using the stated severity level.  Uses the values stored 
503   in curRecordID, curField, and curSubfield to note the location of the error.\r
504 <P>\r
505 <DD><DL>\r
506 <DT><B>Parameters:</B><DD><CODE>severity</CODE> - - An indication of the relative severity of the error that was 
507                                                 encountered.<DD><CODE>message</CODE> - - A descriptive message about the error that was encountered.</DL>\r
508 </DD>\r
509 </DL>\r
510 <HR>\r
511 \r
512 <A NAME="setRecordID(java.lang.String)"><!-- --></A><H3>\r
513 setRecordID</H3>\r
514 <PRE>\r
515 public void <B>setRecordID</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;recordID)</PRE>\r
516 <DL>\r
517 <DD>Sets the record ID to be stored for subsequent error messages that are logged
518   If any previous messages are stored for the current record that don't have a 
519   stored record ID, set the value for those entries to this value also.\r
520 <P>\r
521 <DD><DL>\r
522 <DT><B>Parameters:</B><DD><CODE>recordID</CODE> - - the record ID of the record currently being processed</DL>\r
523 </DD>\r
524 </DL>\r
525 <HR>\r
526 \r
527 <A NAME="setCurrentField(java.lang.String)"><!-- --></A><H3>\r
528 setCurrentField</H3>\r
529 <PRE>\r
530 public void <B>setCurrentField</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;curField)</PRE>\r
531 <DL>\r
532 <DD>Sets the field tag to be stored for subsequent error messages that are logged\r
533 <P>\r
534 <DD><DL>\r
535 <DT><B>Parameters:</B><DD><CODE>curField</CODE> - - the tag of the field currently being processed</DL>\r
536 </DD>\r
537 </DL>\r
538 <HR>\r
539 \r
540 <A NAME="setCurrentSubfield(java.lang.String)"><!-- --></A><H3>\r
541 setCurrentSubfield</H3>\r
542 <PRE>\r
543 public void <B>setCurrentSubfield</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;curSubfield)</PRE>\r
544 <DL>\r
545 <DD>Sets the subfield tag to be stored for subsequent error messages that are logged\r
546 <P>\r
547 <DD><DL>\r
548 <DT><B>Parameters:</B><DD><CODE>curSubfield</CODE> - - the subfield tag of the subfield currently being processed</DL>\r
549 </DD>\r
550 </DL>\r
551 <!-- ========= END OF CLASS DATA ========= -->\r
552 <HR>\r
553 \r
554 \r
555 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
556 <A NAME="navbar_bottom"><!-- --></A>\r
557 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
558 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
559 <TR>\r
560 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
561 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
562 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
563   <TR ALIGN="center" VALIGN="top">\r
564   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
565   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
566   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
567   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ErrorHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
568   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
569   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
570   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
571   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
572   </TR>\r
573 </TABLE>\r
574 </TD>\r
575 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
576 </EM>\r
577 </TD>\r
578 </TR>\r
579 \r
580 <TR>\r
581 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
582 &nbsp;<A HREF="../../org/marc4j/Constants.html" title="class in org.marc4j"><B>PREV CLASS</B></A>&nbsp;\r
583 &nbsp;<A HREF="../../org/marc4j/ErrorHandler.Error.html" title="class in org.marc4j"><B>NEXT CLASS</B></A></FONT></TD>\r
584 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
585   <A HREF="../../index.html?org/marc4j/ErrorHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
586 &nbsp;<A HREF="ErrorHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
587 &nbsp;<SCRIPT type="text/javascript">\r
588   <!--\r
589   if(window==top) {\r
590     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
591   }\r
592   //-->\r
593 </SCRIPT>\r
594 <NOSCRIPT>\r
595   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
596 </NOSCRIPT>\r
597 \r
598 \r
599 </FONT></TD>\r
600 </TR>\r
601 <TR>\r
602 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
603   SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
604 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
605 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
606 </TR>\r
607 </TABLE>\r
608 <A NAME="skip-navbar_bottom"></A>\r
609 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
610 \r
611 <HR>\r
612 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
613 </BODY>\r
614 </HTML>\r