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 DataField (MARC4J API)
\r
10 <META NAME="keywords" CONTENT="org.marc4j.marc.DataField interface">
\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="DataField (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/DataField.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/marc/ControlField.html" title="interface in org.marc4j.marc"><B>PREV CLASS</B></A>
\r
56 <A HREF="../../../org/marc4j/marc/IllegalAddException.html" title="class 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/DataField.html" target="_top"><B>FRAMES</B></A>
\r
59 <A HREF="DataField.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
78 DETAIL: FIELD | CONSTR | <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
88 org.marc4j.marc</FONT>
\r
90 Interface DataField</H2>
\r
92 <DT><B>All Superinterfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Comparable.html" title="class or interface in java.lang">Comparable</A>, <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>, <A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A></DD>
\r
95 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/marc4j/marc/impl/DataFieldImpl.html" title="class in org.marc4j.marc.impl">DataFieldImpl</A></DD>
\r
99 <DT><PRE>public interface <B>DataField</B><DT>extends <A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A></DL>
\r
103 Represents a data field in a MARC record.
\r
108 <DT><B>Version:</B></DT>
\r
109 <DD>$Revision: 1.9 $</DD>
\r
110 <DT><B>Author:</B></DT>
\r
111 <DD>Bas Peters</DD>
\r
117 <!-- ========== METHOD SUMMARY =========== -->
\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
125 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
126 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
127 <CODE> void</CODE></FONT></TD>
\r
128 <TD><CODE><B><A HREF="../../../org/marc4j/marc/DataField.html#addSubfield(int, org.marc4j.marc.Subfield)">addSubfield</A></B>(int index,
\r
129 <A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc">Subfield</A> subfield)</CODE>
\r
132 Inserts a <code>Subfield</code> at the specified position.</TD>
\r
134 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
136 <CODE> void</CODE></FONT></TD>
\r
137 <TD><CODE><B><A HREF="../../../org/marc4j/marc/DataField.html#addSubfield(org.marc4j.marc.Subfield)">addSubfield</A></B>(<A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc">Subfield</A> subfield)</CODE>
\r
140 Adds a <code>Subfield</code>.</TD>
\r
142 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
144 <CODE> char</CODE></FONT></TD>
\r
145 <TD><CODE><B><A HREF="../../../org/marc4j/marc/DataField.html#getIndicator1()">getIndicator1</A></B>()</CODE>
\r
148 Returns the first indicator</TD>
\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
152 <CODE> char</CODE></FONT></TD>
\r
153 <TD><CODE><B><A HREF="../../../org/marc4j/marc/DataField.html#getIndicator2()">getIndicator2</A></B>()</CODE>
\r
156 Returns the second indicator</TD>
\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
160 <CODE> <A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc">Subfield</A></CODE></FONT></TD>
\r
161 <TD><CODE><B><A HREF="../../../org/marc4j/marc/DataField.html#getSubfield(char)">getSubfield</A></B>(char code)</CODE>
\r
164 Returns the first <code>Subfield</code> with the given code.</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="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
169 <TD><CODE><B><A HREF="../../../org/marc4j/marc/DataField.html#getSubfields()">getSubfields</A></B>()</CODE>
\r
172 Returns the list of <code>Subfield</code> objects.</TD>
\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
176 <CODE> <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
177 <TD><CODE><B><A HREF="../../../org/marc4j/marc/DataField.html#getSubfields(char)">getSubfields</A></B>(char code)</CODE>
\r
180 Returns the list of <code>Subfield</code> objects for the goven
181 subfield code.</TD>
\r
183 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
185 <CODE> void</CODE></FONT></TD>
\r
186 <TD><CODE><B><A HREF="../../../org/marc4j/marc/DataField.html#removeSubfield(org.marc4j.marc.Subfield)">removeSubfield</A></B>(<A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc">Subfield</A> subfield)</CODE>
\r
189 Removes a <code>Subfield</code>.</TD>
\r
191 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
192 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
193 <CODE> void</CODE></FONT></TD>
\r
194 <TD><CODE><B><A HREF="../../../org/marc4j/marc/DataField.html#setIndicator1(char)">setIndicator1</A></B>(char ind1)</CODE>
\r
197 Sets the first indicator.</TD>
\r
199 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
200 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
201 <CODE> void</CODE></FONT></TD>
\r
202 <TD><CODE><B><A HREF="../../../org/marc4j/marc/DataField.html#setIndicator2(char)">setIndicator2</A></B>(char ind2)</CODE>
\r
205 Sets the second indicator.</TD>
\r
208 <A NAME="methods_inherited_from_class_org.marc4j.marc.VariableField"><!-- --></A>
\r
209 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
210 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
211 <TH ALIGN="left"><B>Methods inherited from interface org.marc4j.marc.<A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A></B></TH>
\r
213 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
214 <TD><CODE><A HREF="../../../org/marc4j/marc/VariableField.html#find(java.lang.String)">find</A>, <A HREF="../../../org/marc4j/marc/VariableField.html#getId()">getId</A>, <A HREF="../../../org/marc4j/marc/VariableField.html#getTag()">getTag</A>, <A HREF="../../../org/marc4j/marc/VariableField.html#setId(java.lang.Long)">setId</A>, <A HREF="../../../org/marc4j/marc/VariableField.html#setTag(java.lang.String)">setTag</A></CODE></TD>
\r
217 <A NAME="methods_inherited_from_class_java.lang.Comparable"><!-- --></A>
\r
218 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
219 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
220 <TH ALIGN="left"><B>Methods inherited from interface java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Comparable.html" title="class or interface in java.lang">Comparable</A></B></TH>
\r
222 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
223 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Comparable.html#compareTo(T)" title="class or interface in java.lang">compareTo</A></CODE></TD>
\r
229 <!-- ============ METHOD DETAIL ========== -->
\r
231 <A NAME="method_detail"><!-- --></A>
\r
232 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
233 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
234 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
235 <B>Method Detail</B></FONT></TH>
\r
239 <A NAME="getIndicator1()"><!-- --></A><H3>
\r
242 char <B>getIndicator1</B>()</PRE>
\r
244 <DD>Returns the first indicator
\r
251 <DT><B>Returns:</B><DD>char - the first indicator</DL>
\r
256 <A NAME="setIndicator1(char)"><!-- --></A><H3>
\r
259 void <B>setIndicator1</B>(char ind1)</PRE>
\r
261 <DD>Sets the first indicator.
\r
267 <DT><B>Parameters:</B><DD><CODE>ind1</CODE> - the first indicator</DL>
\r
272 <A NAME="getIndicator2()"><!-- --></A><H3>
\r
275 char <B>getIndicator2</B>()</PRE>
\r
277 <DD>Returns the second indicator
\r
284 <DT><B>Returns:</B><DD>char - the second indicator</DL>
\r
289 <A NAME="setIndicator2(char)"><!-- --></A><H3>
\r
292 void <B>setIndicator2</B>(char ind2)</PRE>
\r
294 <DD>Sets the second indicator.
\r
300 <DT><B>Parameters:</B><DD><CODE>ind2</CODE> - the second indicator</DL>
\r
305 <A NAME="getSubfields()"><!-- --></A><H3>
\r
308 <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>getSubfields</B>()</PRE>
\r
310 <DD>Returns the list of <code>Subfield</code> objects.
\r
317 <DT><B>Returns:</B><DD>List - the list of <code>Subfield</code> objects</DL>
\r
322 <A NAME="getSubfields(char)"><!-- --></A><H3>
\r
325 <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>getSubfields</B>(char code)</PRE>
\r
327 <DD>Returns the list of <code>Subfield</code> objects for the goven
334 <DT><B>Parameters:</B><DD><CODE>code</CODE> - the subfield code
\r
335 <DT><B>Returns:</B><DD>List - the list of <code>Subfield</code> objects</DL>
\r
340 <A NAME="getSubfield(char)"><!-- --></A><H3>
\r
343 <A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc">Subfield</A> <B>getSubfield</B>(char code)</PRE>
\r
345 <DD>Returns the first <code>Subfield</code> with the given code.
\r
351 <DT><B>Parameters:</B><DD><CODE>code</CODE> - the subfield code
\r
352 <DT><B>Returns:</B><DD>Subfield - the subfield object or null if no subfield is found</DL>
\r
357 <A NAME="addSubfield(org.marc4j.marc.Subfield)"><!-- --></A><H3>
\r
360 void <B>addSubfield</B>(<A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc">Subfield</A> subfield)</PRE>
\r
362 <DD>Adds a <code>Subfield</code>.
\r
368 <DT><B>Parameters:</B><DD><CODE>subfield</CODE> - the <code>Subfield</code> object
\r
370 <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>Subfield</code> instance</DL>
\r
375 <A NAME="addSubfield(int, org.marc4j.marc.Subfield)"><!-- --></A><H3>
\r
378 void <B>addSubfield</B>(int index,
\r
379 <A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc">Subfield</A> subfield)</PRE>
\r
381 <DD>Inserts a <code>Subfield</code> at the specified position.
\r
387 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the position within the list<DD><CODE>subfield</CODE> - the <code>Subfield</code> object
\r
389 <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>Subfield</code> instance</DL>
\r
394 <A NAME="removeSubfield(org.marc4j.marc.Subfield)"><!-- --></A><H3>
\r
395 removeSubfield</H3>
\r
397 void <B>removeSubfield</B>(<A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc">Subfield</A> subfield)</PRE>
\r
399 <DD>Removes a <code>Subfield</code>.
\r
408 <!-- ========= END OF CLASS DATA ========= -->
\r
412 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
413 <A NAME="navbar_bottom"><!-- --></A>
\r
414 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
415 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
417 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
418 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
419 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
420 <TR ALIGN="center" VALIGN="top">
\r
421 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
422 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
423 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
424 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DataField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
425 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
426 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
427 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
428 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
432 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
438 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
439 <A HREF="../../../org/marc4j/marc/ControlField.html" title="interface in org.marc4j.marc"><B>PREV CLASS</B></A>
\r
440 <A HREF="../../../org/marc4j/marc/IllegalAddException.html" title="class in org.marc4j.marc"><B>NEXT CLASS</B></A></FONT></TD>
\r
441 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
442 <A HREF="../../../index.html?org/marc4j/marc/DataField.html" target="_top"><B>FRAMES</B></A>
\r
443 <A HREF="DataField.html" target="_top"><B>NO FRAMES</B></A>
\r
444 <SCRIPT type="text/javascript">
\r
447 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
452 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
459 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
460 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
461 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
462 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
465 <A NAME="skip-navbar_bottom"></A>
\r
466 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
469 Copyright © 2002-2006 Bas Peters. All Rights Reserved.
\r