Original 2.4. With additional eclipse .project/classpath and git ignore
[marc4j.git] / apidoc / org / marc4j / marc / Record.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 Record (MARC4J API)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="org.marc4j.marc.Record 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="Record (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/Record.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/marc/MarcFactory.html" title="class in org.marc4j.marc"><B>PREV CLASS</B></A>&nbsp;\r
56 &nbsp;<A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc"><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/marc/Record.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="Record.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.marc</FONT>\r
89 <BR>\r
90 Interface Record</H2>\r
91 <DL>\r
92 <DT><B>All Superinterfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DD>\r
93 </DL>\r
94 <DL>\r
95 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/marc4j/marc/impl/RecordImpl.html" title="class in org.marc4j.marc.impl">RecordImpl</A></DD>\r
96 </DL>\r
97 <HR>\r
98 <DL>\r
99 <DT><PRE>public interface <B>Record</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DL>\r
100 </PRE>\r
101 \r
102 <P>\r
103 Represents a MARC record.\r
104 <P>\r
105 \r
106 <P>\r
107 <DL>\r
108 <DT><B>Version:</B></DT>\r
109   <DD>$Revision: 1.12 $</DD>\r
110 <DT><B>Author:</B></DT>\r
111   <DD>Bas Peters</DD>\r
112 </DL>\r
113 <HR>\r
114 \r
115 <P>\r
116 \r
117 <!-- ========== METHOD SUMMARY =========== -->\r
118 \r
119 <A NAME="method_summary"><!-- --></A>\r
120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
122 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
123 <B>Method Summary</B></FONT></TH>\r
124 </TR>\r
125 <TR BGCOLOR="white" CLASS="TableRowColor">\r
126 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
127 <CODE>&nbsp;void</CODE></FONT></TD>\r
128 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#addVariableField(org.marc4j.marc.VariableField)">addVariableField</A></B>(<A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A>&nbsp;field)</CODE>\r
129 \r
130 <BR>\r
131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a <code>VariableField</code>.</TD>\r
132 </TR>\r
133 <TR BGCOLOR="white" CLASS="TableRowColor">\r
134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
135 <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
136 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#find(java.lang.String)">find</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;pattern)</CODE>\r
137 \r
138 <BR>\r
139 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a List of VariableField objects that have a data element that
140  matches the given regular expression.</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;<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
145 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#find(java.lang.String[], java.lang.String)">find</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;tag,\r
146      <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;pattern)</CODE>\r
147 \r
148 <BR>\r
149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a List of VariableField objects with the given tags that have a
150  data element that matches the given regular expression.</TD>\r
151 </TR>\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">\r
153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
154 <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
155 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#find(java.lang.String, java.lang.String)">find</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;tag,\r
156      <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;pattern)</CODE>\r
157 \r
158 <BR>\r
159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a List of VariableField objects with the given tag that have a
160  data element that matches the given regular expression.</TD>\r
161 </TR>\r
162 <TR BGCOLOR="white" CLASS="TableRowColor">\r
163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
164 <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
165 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#getControlFields()">getControlFields</A></B>()</CODE>\r
166 \r
167 <BR>\r
168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of control fields</TD>\r
169 </TR>\r
170 <TR BGCOLOR="white" CLASS="TableRowColor">\r
171 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
172 <CODE>&nbsp;<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></CODE></FONT></TD>\r
173 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#getControlNumber()">getControlNumber</A></B>()</CODE>\r
174 \r
175 <BR>\r
176 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the control number or <code>null</code> if no control number is
177  available.</TD>\r
178 </TR>\r
179 <TR BGCOLOR="white" CLASS="TableRowColor">\r
180 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
181 <CODE>&nbsp;<A HREF="../../../org/marc4j/marc/ControlField.html" title="interface in org.marc4j.marc">ControlField</A></CODE></FONT></TD>\r
182 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#getControlNumberField()">getControlNumberField</A></B>()</CODE>\r
183 \r
184 <BR>\r
185 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the control number field or <code>null</code> if no control
186  number field is available.</TD>\r
187 </TR>\r
188 <TR BGCOLOR="white" CLASS="TableRowColor">\r
189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
190 <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
191 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#getDataFields()">getDataFields</A></B>()</CODE>\r
192 \r
193 <BR>\r
194 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of data fields</TD>\r
195 </TR>\r
196 <TR BGCOLOR="white" CLASS="TableRowColor">\r
197 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
198 <CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A></CODE></FONT></TD>\r
199 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#getId()">getId</A></B>()</CODE>\r
200 \r
201 <BR>\r
202 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the identifier.</TD>\r
203 </TR>\r
204 <TR BGCOLOR="white" CLASS="TableRowColor">\r
205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
206 <CODE>&nbsp;<A HREF="../../../org/marc4j/marc/Leader.html" title="interface in org.marc4j.marc">Leader</A></CODE></FONT></TD>\r
207 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#getLeader()">getLeader</A></B>()</CODE>\r
208 \r
209 <BR>\r
210 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the <code>Leader</code>.</TD>\r
211 </TR>\r
212 <TR BGCOLOR="white" CLASS="TableRowColor">\r
213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
214 <CODE>&nbsp;<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></CODE></FONT></TD>\r
215 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#getType()">getType</A></B>()</CODE>\r
216 \r
217 <BR>\r
218 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the type of record.</TD>\r
219 </TR>\r
220 <TR BGCOLOR="white" CLASS="TableRowColor">\r
221 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
222 <CODE>&nbsp;<A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A></CODE></FONT></TD>\r
223 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#getVariableField(java.lang.String)">getVariableField</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;tag)</CODE>\r
224 \r
225 <BR>\r
226 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the first instance of the variable field with the given tag.</TD>\r
227 </TR>\r
228 <TR BGCOLOR="white" CLASS="TableRowColor">\r
229 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
230 <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
231 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#getVariableFields()">getVariableFields</A></B>()</CODE>\r
232 \r
233 <BR>\r
234 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of variable fields</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/marc/Record.html#getVariableFields(java.lang.String)">getVariableFields</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;tag)</CODE>\r
240 \r
241 <BR>\r
242 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of variable fields with the given tag.</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;<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
247 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#getVariableFields(java.lang.String[])">getVariableFields</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;tag)</CODE>\r
248 \r
249 <BR>\r
250 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a list of variable fields for the given tags.</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;void</CODE></FONT></TD>\r
255 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#removeVariableField(org.marc4j.marc.VariableField)">removeVariableField</A></B>(<A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A>&nbsp;field)</CODE>\r
256 \r
257 <BR>\r
258 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a variable field from the collection.</TD>\r
259 </TR>\r
260 <TR BGCOLOR="white" CLASS="TableRowColor">\r
261 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
262 <CODE>&nbsp;void</CODE></FONT></TD>\r
263 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#setId(java.lang.Long)">setId</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A>&nbsp;id)</CODE>\r
264 \r
265 <BR>\r
266 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the identifier.</TD>\r
267 </TR>\r
268 <TR BGCOLOR="white" CLASS="TableRowColor">\r
269 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
270 <CODE>&nbsp;void</CODE></FONT></TD>\r
271 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#setLeader(org.marc4j.marc.Leader)">setLeader</A></B>(<A HREF="../../../org/marc4j/marc/Leader.html" title="interface in org.marc4j.marc">Leader</A>&nbsp;leader)</CODE>\r
272 \r
273 <BR>\r
274 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the <code>Leader</code>.</TD>\r
275 </TR>\r
276 <TR BGCOLOR="white" CLASS="TableRowColor">\r
277 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
278 <CODE>&nbsp;void</CODE></FONT></TD>\r
279 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Record.html#setType(java.lang.String)">setType</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;type)</CODE>\r
280 \r
281 <BR>\r
282 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the type of record.</TD>\r
283 </TR>\r
284 </TABLE>\r
285 &nbsp;\r
286 <P>\r
287 \r
288 <!-- ============ METHOD DETAIL ========== -->\r
289 \r
290 <A NAME="method_detail"><!-- --></A>\r
291 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
292 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
293 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
294 <B>Method Detail</B></FONT></TH>\r
295 </TR>\r
296 </TABLE>\r
297 \r
298 <A NAME="setId(java.lang.Long)"><!-- --></A><H3>\r
299 setId</H3>\r
300 <PRE>\r
301 void <B>setId</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A>&nbsp;id)</PRE>\r
302 <DL>\r
303 <DD>Sets the identifier.
304  
305  <p>
306  The purpose of this identifier is to provide an identifier for
307  persistency.\r
308 <P>\r
309 <DD><DL>\r
310 </DL>\r
311 </DD>\r
312 <DD><DL>\r
313 <DT><B>Parameters:</B><DD><CODE>id</CODE> - the identifier</DL>\r
314 </DD>\r
315 </DL>\r
316 <HR>\r
317 \r
318 <A NAME="getId()"><!-- --></A><H3>\r
319 getId</H3>\r
320 <PRE>\r
321 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A> <B>getId</B>()</PRE>\r
322 <DL>\r
323 <DD>Returns the identifier.\r
324 <P>\r
325 <DD><DL>\r
326 </DL>\r
327 </DD>\r
328 <DD><DL>\r
329 \r
330 <DT><B>Returns:</B><DD>Long - the identifier</DL>\r
331 </DD>\r
332 </DL>\r
333 <HR>\r
334 \r
335 <A NAME="setType(java.lang.String)"><!-- --></A><H3>\r
336 setType</H3>\r
337 <PRE>\r
338 void <B>setType</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;type)</PRE>\r
339 <DL>\r
340 <DD>Sets the type of record.\r
341 <P>\r
342 <DD><DL>\r
343 </DL>\r
344 </DD>\r
345 <DD><DL>\r
346 <DT><B>Parameters:</B><DD><CODE>type</CODE> - the type of record</DL>\r
347 </DD>\r
348 </DL>\r
349 <HR>\r
350 \r
351 <A NAME="getType()"><!-- --></A><H3>\r
352 getType</H3>\r
353 <PRE>\r
354 <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> <B>getType</B>()</PRE>\r
355 <DL>\r
356 <DD>Returns the type of record.\r
357 <P>\r
358 <DD><DL>\r
359 </DL>\r
360 </DD>\r
361 <DD><DL>\r
362 \r
363 <DT><B>Returns:</B><DD>String - the type of record</DL>\r
364 </DD>\r
365 </DL>\r
366 <HR>\r
367 \r
368 <A NAME="addVariableField(org.marc4j.marc.VariableField)"><!-- --></A><H3>\r
369 addVariableField</H3>\r
370 <PRE>\r
371 void <B>addVariableField</B>(<A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A>&nbsp;field)</PRE>\r
372 <DL>\r
373 <DD>Adds a <code>VariableField</code>.\r
374 <P>\r
375 <DD><DL>\r
376 </DL>\r
377 </DD>\r
378 <DD><DL>\r
379 <DT><B>Parameters:</B><DD><CODE>field</CODE> - the <code>VariableField</code>\r
380 <DT><B>Throws:</B>\r
381 <DD><CODE><A HREF="../../../org/marc4j/marc/IllegalAddException.html" title="class in org.marc4j.marc">IllegalAddException</A></CODE> - when the parameter is not a <code>VariableField</code>
382              instance</DL>\r
383 </DD>\r
384 </DL>\r
385 <HR>\r
386 \r
387 <A NAME="removeVariableField(org.marc4j.marc.VariableField)"><!-- --></A><H3>\r
388 removeVariableField</H3>\r
389 <PRE>\r
390 void <B>removeVariableField</B>(<A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A>&nbsp;field)</PRE>\r
391 <DL>\r
392 <DD>Removes a variable field from the collection.\r
393 <P>\r
394 <DD><DL>\r
395 </DL>\r
396 </DD>\r
397 <DD><DL>\r
398 <DT><B>Parameters:</B><DD><CODE>field</CODE> - the variable field</DL>\r
399 </DD>\r
400 </DL>\r
401 <HR>\r
402 \r
403 <A NAME="getVariableFields()"><!-- --></A><H3>\r
404 getVariableFields</H3>\r
405 <PRE>\r
406 <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>getVariableFields</B>()</PRE>\r
407 <DL>\r
408 <DD>Returns a list of variable fields\r
409 <P>\r
410 <DD><DL>\r
411 </DL>\r
412 </DD>\r
413 <DD><DL>\r
414 \r
415 <DT><B>Returns:</B><DD>List - the variable fields</DL>\r
416 </DD>\r
417 </DL>\r
418 <HR>\r
419 \r
420 <A NAME="getControlFields()"><!-- --></A><H3>\r
421 getControlFields</H3>\r
422 <PRE>\r
423 <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>getControlFields</B>()</PRE>\r
424 <DL>\r
425 <DD>Returns a list of control fields\r
426 <P>\r
427 <DD><DL>\r
428 </DL>\r
429 </DD>\r
430 <DD><DL>\r
431 \r
432 <DT><B>Returns:</B><DD>List - the control fields</DL>\r
433 </DD>\r
434 </DL>\r
435 <HR>\r
436 \r
437 <A NAME="getDataFields()"><!-- --></A><H3>\r
438 getDataFields</H3>\r
439 <PRE>\r
440 <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>getDataFields</B>()</PRE>\r
441 <DL>\r
442 <DD>Returns a list of data fields\r
443 <P>\r
444 <DD><DL>\r
445 </DL>\r
446 </DD>\r
447 <DD><DL>\r
448 \r
449 <DT><B>Returns:</B><DD>List - the data fields</DL>\r
450 </DD>\r
451 </DL>\r
452 <HR>\r
453 \r
454 <A NAME="getControlNumberField()"><!-- --></A><H3>\r
455 getControlNumberField</H3>\r
456 <PRE>\r
457 <A HREF="../../../org/marc4j/marc/ControlField.html" title="interface in org.marc4j.marc">ControlField</A> <B>getControlNumberField</B>()</PRE>\r
458 <DL>\r
459 <DD>Returns the control number field or <code>null</code> if no control
460  number field is available.\r
461 <P>\r
462 <DD><DL>\r
463 </DL>\r
464 </DD>\r
465 <DD><DL>\r
466 \r
467 <DT><B>Returns:</B><DD>ControlField - the control number field</DL>\r
468 </DD>\r
469 </DL>\r
470 <HR>\r
471 \r
472 <A NAME="getControlNumber()"><!-- --></A><H3>\r
473 getControlNumber</H3>\r
474 <PRE>\r
475 <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> <B>getControlNumber</B>()</PRE>\r
476 <DL>\r
477 <DD>Returns the control number or <code>null</code> if no control number is
478  available.
479  
480  This method returns the data for a <code>ControlField</code> with tag
481  001.\r
482 <P>\r
483 <DD><DL>\r
484 </DL>\r
485 </DD>\r
486 <DD><DL>\r
487 \r
488 <DT><B>Returns:</B><DD>String - the control number</DL>\r
489 </DD>\r
490 </DL>\r
491 <HR>\r
492 \r
493 <A NAME="getVariableField(java.lang.String)"><!-- --></A><H3>\r
494 getVariableField</H3>\r
495 <PRE>\r
496 <A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A> <B>getVariableField</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;tag)</PRE>\r
497 <DL>\r
498 <DD>Returns the first instance of the variable field with the given tag.\r
499 <P>\r
500 <DD><DL>\r
501 </DL>\r
502 </DD>\r
503 <DD><DL>\r
504 \r
505 <DT><B>Returns:</B><DD>VariableField - the variable field</DL>\r
506 </DD>\r
507 </DL>\r
508 <HR>\r
509 \r
510 <A NAME="getVariableFields(java.lang.String)"><!-- --></A><H3>\r
511 getVariableFields</H3>\r
512 <PRE>\r
513 <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>getVariableFields</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;tag)</PRE>\r
514 <DL>\r
515 <DD>Returns a list of variable fields with the given tag.\r
516 <P>\r
517 <DD><DL>\r
518 </DL>\r
519 </DD>\r
520 <DD><DL>\r
521 \r
522 <DT><B>Returns:</B><DD>List - the variable fields</DL>\r
523 </DD>\r
524 </DL>\r
525 <HR>\r
526 \r
527 <A NAME="getVariableFields(java.lang.String[])"><!-- --></A><H3>\r
528 getVariableFields</H3>\r
529 <PRE>\r
530 <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>getVariableFields</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;tag)</PRE>\r
531 <DL>\r
532 <DD>Returns a list of variable fields for the given tags.
533  
534  <p>
535  For example:
536  
537  <pre>
538  String tags = { &quot;100&quot;, &quot;245&quot;, &quot;260&quot;, &quot;300&quot; };
539  
540  List fields = record.getVariableFields(tags);
541  </pre>\r
542 <P>\r
543 <DD><DL>\r
544 </DL>\r
545 </DD>\r
546 <DD><DL>\r
547 \r
548 <DT><B>Returns:</B><DD>List - the variable fields</DL>\r
549 </DD>\r
550 </DL>\r
551 <HR>\r
552 \r
553 <A NAME="getLeader()"><!-- --></A><H3>\r
554 getLeader</H3>\r
555 <PRE>\r
556 <A HREF="../../../org/marc4j/marc/Leader.html" title="interface in org.marc4j.marc">Leader</A> <B>getLeader</B>()</PRE>\r
557 <DL>\r
558 <DD>Returns the <code>Leader</code>.\r
559 <P>\r
560 <DD><DL>\r
561 </DL>\r
562 </DD>\r
563 <DD><DL>\r
564 \r
565 <DT><B>Returns:</B><DD>Leader - the <code>Leader</code></DL>\r
566 </DD>\r
567 </DL>\r
568 <HR>\r
569 \r
570 <A NAME="setLeader(org.marc4j.marc.Leader)"><!-- --></A><H3>\r
571 setLeader</H3>\r
572 <PRE>\r
573 void <B>setLeader</B>(<A HREF="../../../org/marc4j/marc/Leader.html" title="interface in org.marc4j.marc">Leader</A>&nbsp;leader)</PRE>\r
574 <DL>\r
575 <DD>Sets the <code>Leader</code>.\r
576 <P>\r
577 <DD><DL>\r
578 </DL>\r
579 </DD>\r
580 <DD><DL>\r
581 <DT><B>Parameters:</B><DD><CODE>leader</CODE> - the <code>Leader</code></DL>\r
582 </DD>\r
583 </DL>\r
584 <HR>\r
585 \r
586 <A NAME="find(java.lang.String)"><!-- --></A><H3>\r
587 find</H3>\r
588 <PRE>\r
589 <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>find</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;pattern)</PRE>\r
590 <DL>\r
591 <DD>Returns a List of VariableField objects that have a data element that
592  matches the given regular expression.
593  
594  <p>
595  See <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html" title="class or interface in java.util.regex"><CODE>Pattern</CODE></A> for more information about Java
596  regular expressions.
597  </p>\r
598 <P>\r
599 <DD><DL>\r
600 </DL>\r
601 </DD>\r
602 <DD><DL>\r
603 <DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the regular expression\r
604 <DT><B>Returns:</B><DD>List - the result list</DL>\r
605 </DD>\r
606 </DL>\r
607 <HR>\r
608 \r
609 <A NAME="find(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
610 find</H3>\r
611 <PRE>\r
612 <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>find</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;tag,\r
613           <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;pattern)</PRE>\r
614 <DL>\r
615 <DD>Returns a List of VariableField objects with the given tag that have a
616  data element that matches the given regular expression.
617  
618  <p>
619  See <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html" title="class or interface in java.util.regex"><CODE>Pattern</CODE></A> for more information about Java
620  regular expressions.
621  </p>\r
622 <P>\r
623 <DD><DL>\r
624 </DL>\r
625 </DD>\r
626 <DD><DL>\r
627 <DT><B>Parameters:</B><DD><CODE>tag</CODE> - the tag value<DD><CODE>pattern</CODE> - the regular expression\r
628 <DT><B>Returns:</B><DD>List - the result list</DL>\r
629 </DD>\r
630 </DL>\r
631 <HR>\r
632 \r
633 <A NAME="find(java.lang.String[], java.lang.String)"><!-- --></A><H3>\r
634 find</H3>\r
635 <PRE>\r
636 <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>find</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;tag,\r
637           <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;pattern)</PRE>\r
638 <DL>\r
639 <DD>Returns a List of VariableField objects with the given tags that have a
640  data element that matches the given regular expression.
641  
642  <p>
643  See <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html" title="class or interface in java.util.regex"><CODE>Pattern</CODE></A> for more information about Java
644  regular expressions.
645  </p>\r
646 <P>\r
647 <DD><DL>\r
648 </DL>\r
649 </DD>\r
650 <DD><DL>\r
651 <DT><B>Parameters:</B><DD><CODE>tag</CODE> - the tag values<DD><CODE>pattern</CODE> - the regular expression\r
652 <DT><B>Returns:</B><DD>List - the result list</DL>\r
653 </DD>\r
654 </DL>\r
655 <!-- ========= END OF CLASS DATA ========= -->\r
656 <HR>\r
657 \r
658 \r
659 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
660 <A NAME="navbar_bottom"><!-- --></A>\r
661 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
662 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
663 <TR>\r
664 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
665 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
666 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
667   <TR ALIGN="center" VALIGN="top">\r
668   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
669   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
670   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
671   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Record.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
672   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
673   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
674   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
675   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
676   </TR>\r
677 </TABLE>\r
678 </TD>\r
679 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
680 </EM>\r
681 </TD>\r
682 </TR>\r
683 \r
684 <TR>\r
685 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
686 &nbsp;<A HREF="../../../org/marc4j/marc/MarcFactory.html" title="class in org.marc4j.marc"><B>PREV CLASS</B></A>&nbsp;\r
687 &nbsp;<A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc"><B>NEXT CLASS</B></A></FONT></TD>\r
688 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
689   <A HREF="../../../index.html?org/marc4j/marc/Record.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
690 &nbsp;<A HREF="Record.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
691 &nbsp;<SCRIPT type="text/javascript">\r
692   <!--\r
693   if(window==top) {\r
694     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
695   }\r
696   //-->\r
697 </SCRIPT>\r
698 <NOSCRIPT>\r
699   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
700 </NOSCRIPT>\r
701 \r
702 \r
703 </FONT></TD>\r
704 </TR>\r
705 <TR>\r
706 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
707   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
708 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
709 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
710 </TR>\r
711 </TABLE>\r
712 <A NAME="skip-navbar_bottom"></A>\r
713 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
714 \r
715 <HR>\r
716 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
717 </BODY>\r
718 </HTML>\r