apidoc/org/marc4j/marc/VariableField.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 VariableField (MARC4J API)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="org.marc4j.marc.VariableField 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="VariableField (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/VariableField.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/Subfield.html" title="interface in org.marc4j.marc"><B>PREV CLASS</B></A>&nbsp;\r
  56 &nbsp;NEXT CLASS</FONT></TD>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58   <A HREF="../../../index.html?org/marc4j/marc/VariableField.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="VariableField.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 VariableField</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/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></DD>\r
  93 </DL>\r
  94 <DL>\r
  95 <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../org/marc4j/marc/ControlField.html" title="interface in org.marc4j.marc">ControlField</A>, <A HREF="../../../org/marc4j/marc/DataField.html" title="interface in org.marc4j.marc">DataField</A></DD>\r
  96 </DL>\r
  97 <DL>\r
  98 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../org/marc4j/marc/impl/ControlFieldImpl.html" title="class in org.marc4j.marc.impl">ControlFieldImpl</A>, <A HREF="../../../org/marc4j/marc/impl/DataFieldImpl.html" title="class in org.marc4j.marc.impl">DataFieldImpl</A>, <A HREF="../../../org/marc4j/marc/impl/VariableFieldImpl.html" title="class in org.marc4j.marc.impl">VariableFieldImpl</A></DD>\r
  99 </DL>\r
 100 <HR>\r
 101 <DL>\r
 102 <DT><PRE>public interface <B>VariableField</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>, <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></DL>\r
 103 </PRE>\r
 104 \r
 105 <P>\r
 106 Represents a variable field in a MARC record.\r
 107 <P>\r
 108 \r
 109 <P>\r
 110 <DL>\r
 111 <DT><B>Version:</B></DT>\r
 112   <DD>$Revision: 1.10 $</DD>\r
 113 <DT><B>Author:</B></DT>\r
 114   <DD>Bas Peters</DD>\r
 115 </DL>\r
 116 <HR>\r
 117 \r
 118 <P>\r
 119 \r
 120 <!-- ========== METHOD SUMMARY =========== -->\r
 121 \r
 122 <A NAME="method_summary"><!-- --></A>\r
 123 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 124 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 125 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 126 <B>Method Summary</B></FONT></TH>\r
 127 </TR>\r
 128 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 129 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 130 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 131 <TD><CODE><B><A HREF="../../../org/marc4j/marc/VariableField.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
 132 \r
 133 <BR>\r
 134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the given regular expression matches a subsequence of a
 135  data element within the variable field.</TD>\r
 136 </TR>\r
 137 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 138 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 139 <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
 140 <TD><CODE><B><A HREF="../../../org/marc4j/marc/VariableField.html#getId()">getId</A></B>()</CODE>\r
 141 \r
 142 <BR>\r
 143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the identifier.</TD>\r
 144 </TR>\r
 145 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 146 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 147 <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
 148 <TD><CODE><B><A HREF="../../../org/marc4j/marc/VariableField.html#getTag()">getTag</A></B>()</CODE>\r
 149 \r
 150 <BR>\r
 151 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the tag name.</TD>\r
 152 </TR>\r
 153 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 155 <CODE>&nbsp;void</CODE></FONT></TD>\r
 156 <TD><CODE><B><A HREF="../../../org/marc4j/marc/VariableField.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
 157 \r
 158 <BR>\r
 159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the identifier.</TD>\r
 160 </TR>\r
 161 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 162 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 163 <CODE>&nbsp;void</CODE></FONT></TD>\r
 164 <TD><CODE><B><A HREF="../../../org/marc4j/marc/VariableField.html#setTag(java.lang.String)">setTag</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
 165 \r
 166 <BR>\r
 167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the tag name.</TD>\r
 168 </TR>\r
 169 </TABLE>\r
 170 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Comparable"><!-- --></A>\r
 171 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 172 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 173 <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
 174 </TR>\r
 175 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 176 <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
 177 </TR>\r
 178 </TABLE>\r
 179 &nbsp;\r
 180 <P>\r
 181 \r
 182 <!-- ============ METHOD DETAIL ========== -->\r
 183 \r
 184 <A NAME="method_detail"><!-- --></A>\r
 185 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 186 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 187 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 188 <B>Method Detail</B></FONT></TH>\r
 189 </TR>\r
 190 </TABLE>\r
 191 \r
 192 <A NAME="setId(java.lang.Long)"><!-- --></A><H3>\r
 193 setId</H3>\r
 194 <PRE>\r
 195 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
 196 <DL>\r
 197 <DD>Sets the identifier.
 198
 199  <p>
 200  The purpose of this identifier is to provide an identifier for
 201  persistency.\r
 202 <P>\r
 203 <DD><DL>\r
 204 </DL>\r
 205 </DD>\r
 206 <DD><DL>\r
 207 <DT><B>Parameters:</B><DD><CODE>id</CODE> - the identifier</DL>\r
 208 </DD>\r
 209 </DL>\r
 210 <HR>\r
 211 \r
 212 <A NAME="getId()"><!-- --></A><H3>\r
 213 getId</H3>\r
 214 <PRE>\r
 215 <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
 216 <DL>\r
 217 <DD>Returns the identifier.\r
 218 <P>\r
 219 <DD><DL>\r
 220 </DL>\r
 221 </DD>\r
 222 <DD><DL>\r
 223 \r
 224 <DT><B>Returns:</B><DD>Long - the identifier</DL>\r
 225 </DD>\r
 226 </DL>\r
 227 <HR>\r
 228 \r
 229 <A NAME="getTag()"><!-- --></A><H3>\r
 230 getTag</H3>\r
 231 <PRE>\r
 232 <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>getTag</B>()</PRE>\r
 233 <DL>\r
 234 <DD>Returns the tag name.\r
 235 <P>\r
 236 <DD><DL>\r
 237 </DL>\r
 238 </DD>\r
 239 <DD><DL>\r
 240 \r
 241 <DT><B>Returns:</B><DD>String - the tag name</DL>\r
 242 </DD>\r
 243 </DL>\r
 244 <HR>\r
 245 \r
 246 <A NAME="setTag(java.lang.String)"><!-- --></A><H3>\r
 247 setTag</H3>\r
 248 <PRE>\r
 249 void <B>setTag</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
 250 <DL>\r
 251 <DD>Sets the tag name.\r
 252 <P>\r
 253 <DD><DL>\r
 254 </DL>\r
 255 </DD>\r
 256 <DD><DL>\r
 257 <DT><B>Parameters:</B><DD><CODE>tag</CODE> - the tag name</DL>\r
 258 </DD>\r
 259 </DL>\r
 260 <HR>\r
 261 \r
 262 <A NAME="find(java.lang.String)"><!-- --></A><H3>\r
 263 find</H3>\r
 264 <PRE>\r
 265 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
 266 <DL>\r
 267 <DD>Returns true if the given regular expression matches a subsequence of a
 268  data element within the variable field.
 269
 270  <p>
 271  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
 272  regular expressions.
 273  </p>\r
 274 <P>\r
 275 <DD><DL>\r
 276 </DL>\r
 277 </DD>\r
 278 <DD><DL>\r
 279 <DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the regular expression\r
 280 <DT><B>Returns:</B><DD>true if the pattern matches, false othewise</DL>\r
 281 </DD>\r
 282 </DL>\r
 283 <!-- ========= END OF CLASS DATA ========= -->\r
 284 <HR>\r
 285 \r
 286 \r
 287 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 288 <A NAME="navbar_bottom"><!-- --></A>\r
 289 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 290 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 291 <TR>\r
 292 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 293 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 294 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 295   <TR ALIGN="center" VALIGN="top">\r
 296   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 297   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 298   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 299   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/VariableField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 300   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 301   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 302   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 303   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 304   </TR>\r
 305 </TABLE>\r
 306 </TD>\r
 307 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 308 </EM>\r
 309 </TD>\r
 310 </TR>\r
 311 \r
 312 <TR>\r
 313 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 314 &nbsp;<A HREF="../../../org/marc4j/marc/Subfield.html" title="interface in org.marc4j.marc"><B>PREV CLASS</B></A>&nbsp;\r
 315 &nbsp;NEXT CLASS</FONT></TD>\r
 316 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 317   <A HREF="../../../index.html?org/marc4j/marc/VariableField.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 318 &nbsp;<A HREF="VariableField.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 319 &nbsp;<SCRIPT type="text/javascript">\r
 320   <!--\r
 321   if(window==top) {\r
 322     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 323   }\r
 324   //-->\r
 325 </SCRIPT>\r
 326 <NOSCRIPT>\r
 327   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 328 </NOSCRIPT>\r
 329 \r
 330 \r
 331 </FONT></TD>\r
 332 </TR>\r
 333 <TR>\r
 334 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 335   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 336 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 337 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 338 </TR>\r
 339 </TABLE>\r
 340 <A NAME="skip-navbar_bottom"></A>\r
 341 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 342 \r
 343 <HR>\r
 344 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
 345 </BODY>\r
 346 </HTML>\r