Original 2.4. With additional eclipse .project/classpath and git ignore
[marc4j.git] / apidoc / org / marc4j / marc / Subfield.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 Subfield (MARC4J API)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="org.marc4j.marc.Subfield 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="Subfield (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/Subfield.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/Record.html" title="interface in org.marc4j.marc"><B>PREV CLASS</B></A>&nbsp;\r
56 &nbsp;<A HREF="../../../org/marc4j/marc/VariableField.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/Subfield.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="Subfield.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 Subfield</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/SubfieldImpl.html" title="class in org.marc4j.marc.impl">SubfieldImpl</A></DD>\r
96 </DL>\r
97 <HR>\r
98 <DL>\r
99 <DT><PRE>public interface <B>Subfield</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 subfield in 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.11 $</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;boolean</CODE></FONT></TD>\r
128 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Subfield.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
129 \r
130 <BR>\r
131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the given regular expression matches a subsequence of the
132  data element.</TD>\r
133 </TR>\r
134 <TR BGCOLOR="white" CLASS="TableRowColor">\r
135 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
136 <CODE>&nbsp;char</CODE></FONT></TD>\r
137 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Subfield.html#getCode()">getCode</A></B>()</CODE>\r
138 \r
139 <BR>\r
140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the data element identifier.</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/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
145 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Subfield.html#getData()">getData</A></B>()</CODE>\r
146 \r
147 <BR>\r
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the data element.</TD>\r
149 </TR>\r
150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
152 <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
153 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Subfield.html#getId()">getId</A></B>()</CODE>\r
154 \r
155 <BR>\r
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the identifier.</TD>\r
157 </TR>\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
160 <CODE>&nbsp;void</CODE></FONT></TD>\r
161 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Subfield.html#setCode(char)">setCode</A></B>(char&nbsp;code)</CODE>\r
162 \r
163 <BR>\r
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the data element identifier.</TD>\r
165 </TR>\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">\r
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
168 <CODE>&nbsp;void</CODE></FONT></TD>\r
169 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Subfield.html#setData(java.lang.String)">setData</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;data)</CODE>\r
170 \r
171 <BR>\r
172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the data element.</TD>\r
173 </TR>\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
176 <CODE>&nbsp;void</CODE></FONT></TD>\r
177 <TD><CODE><B><A HREF="../../../org/marc4j/marc/Subfield.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
178 \r
179 <BR>\r
180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the identifier.</TD>\r
181 </TR>\r
182 </TABLE>\r
183 &nbsp;\r
184 <P>\r
185 \r
186 <!-- ============ METHOD DETAIL ========== -->\r
187 \r
188 <A NAME="method_detail"><!-- --></A>\r
189 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
190 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
191 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
192 <B>Method Detail</B></FONT></TH>\r
193 </TR>\r
194 </TABLE>\r
195 \r
196 <A NAME="setId(java.lang.Long)"><!-- --></A><H3>\r
197 setId</H3>\r
198 <PRE>\r
199 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
200 <DL>\r
201 <DD>Sets the identifier.
202  
203  <p>
204  The purpose of this identifier is to provide an identifier for
205  persistency.\r
206 <P>\r
207 <DD><DL>\r
208 </DL>\r
209 </DD>\r
210 <DD><DL>\r
211 <DT><B>Parameters:</B><DD><CODE>id</CODE> - the identifier</DL>\r
212 </DD>\r
213 </DL>\r
214 <HR>\r
215 \r
216 <A NAME="getId()"><!-- --></A><H3>\r
217 getId</H3>\r
218 <PRE>\r
219 <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
220 <DL>\r
221 <DD>Returns the identifier.\r
222 <P>\r
223 <DD><DL>\r
224 </DL>\r
225 </DD>\r
226 <DD><DL>\r
227 \r
228 <DT><B>Returns:</B><DD>Long - the identifier</DL>\r
229 </DD>\r
230 </DL>\r
231 <HR>\r
232 \r
233 <A NAME="getCode()"><!-- --></A><H3>\r
234 getCode</H3>\r
235 <PRE>\r
236 char <B>getCode</B>()</PRE>\r
237 <DL>\r
238 <DD>Returns the data element identifier.\r
239 <P>\r
240 <DD><DL>\r
241 </DL>\r
242 </DD>\r
243 <DD><DL>\r
244 \r
245 <DT><B>Returns:</B><DD>char - the data element identifier</DL>\r
246 </DD>\r
247 </DL>\r
248 <HR>\r
249 \r
250 <A NAME="setCode(char)"><!-- --></A><H3>\r
251 setCode</H3>\r
252 <PRE>\r
253 void <B>setCode</B>(char&nbsp;code)</PRE>\r
254 <DL>\r
255 <DD>Sets the data element identifier.\r
256 <P>\r
257 <DD><DL>\r
258 </DL>\r
259 </DD>\r
260 <DD><DL>\r
261 <DT><B>Parameters:</B><DD><CODE>code</CODE> - the data element identifier</DL>\r
262 </DD>\r
263 </DL>\r
264 <HR>\r
265 \r
266 <A NAME="getData()"><!-- --></A><H3>\r
267 getData</H3>\r
268 <PRE>\r
269 <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>getData</B>()</PRE>\r
270 <DL>\r
271 <DD>Returns the data element.\r
272 <P>\r
273 <DD><DL>\r
274 </DL>\r
275 </DD>\r
276 <DD><DL>\r
277 \r
278 <DT><B>Returns:</B><DD>String - the data element</DL>\r
279 </DD>\r
280 </DL>\r
281 <HR>\r
282 \r
283 <A NAME="setData(java.lang.String)"><!-- --></A><H3>\r
284 setData</H3>\r
285 <PRE>\r
286 void <B>setData</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;data)</PRE>\r
287 <DL>\r
288 <DD>Sets the data element.\r
289 <P>\r
290 <DD><DL>\r
291 </DL>\r
292 </DD>\r
293 <DD><DL>\r
294 <DT><B>Parameters:</B><DD><CODE>data</CODE> - the data element</DL>\r
295 </DD>\r
296 </DL>\r
297 <HR>\r
298 \r
299 <A NAME="find(java.lang.String)"><!-- --></A><H3>\r
300 find</H3>\r
301 <PRE>\r
302 boolean <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
303 <DL>\r
304 <DD>Returns true if the given regular expression matches a subsequence of the
305  data element.
306  
307  See (@link java.util.regex.Pattern} for regular expressions.\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>pattern</CODE> - the regular expression\r
314 <DT><B>Returns:</B><DD>true if the pattern matches, false othewise</DL>\r
315 </DD>\r
316 </DL>\r
317 <!-- ========= END OF CLASS DATA ========= -->\r
318 <HR>\r
319 \r
320 \r
321 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
322 <A NAME="navbar_bottom"><!-- --></A>\r
323 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
324 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
325 <TR>\r
326 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
327 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
328 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
329   <TR ALIGN="center" VALIGN="top">\r
330   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
331   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
332   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
333   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Subfield.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
334   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
335   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
336   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
337   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
338   </TR>\r
339 </TABLE>\r
340 </TD>\r
341 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
342 </EM>\r
343 </TD>\r
344 </TR>\r
345 \r
346 <TR>\r
347 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
348 &nbsp;<A HREF="../../../org/marc4j/marc/Record.html" title="interface in org.marc4j.marc"><B>PREV CLASS</B></A>&nbsp;\r
349 &nbsp;<A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc"><B>NEXT CLASS</B></A></FONT></TD>\r
350 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
351   <A HREF="../../../index.html?org/marc4j/marc/Subfield.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
352 &nbsp;<A HREF="Subfield.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
353 &nbsp;<SCRIPT type="text/javascript">\r
354   <!--\r
355   if(window==top) {\r
356     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
357   }\r
358   //-->\r
359 </SCRIPT>\r
360 <NOSCRIPT>\r
361   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
362 </NOSCRIPT>\r
363 \r
364 \r
365 </FONT></TD>\r
366 </TR>\r
367 <TR>\r
368 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
369   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
370 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
371 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
372 </TR>\r
373 </TABLE>\r
374 <A NAME="skip-navbar_bottom"></A>\r
375 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
376 \r
377 <HR>\r
378 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
379 </BODY>\r
380 </HTML>\r