apidoc/org/marc4j/marc/ControlField.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 ControlField (MARC4J API)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="org.marc4j.marc.ControlField 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="ControlField (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/ControlField.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;PREV CLASS&nbsp;\r
  56 &nbsp;<A HREF="../../../org/marc4j/marc/DataField.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/ControlField.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="ControlField.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 ControlField</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>, <A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A></DD>\r
  93 </DL>\r
  94 <DL>\r
  95 <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></DD>\r
  96 </DL>\r
  97 <HR>\r
  98 <DL>\r
  99 <DT><PRE>public interface <B>ControlField</B><DT>extends <A HREF="../../../org/marc4j/marc/VariableField.html" title="interface in org.marc4j.marc">VariableField</A></DL>\r
 100 </PRE>\r
 101 \r
 102 <P>\r
 103 Represents a control field 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.8 $</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;<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
 128 <TD><CODE><B><A HREF="../../../org/marc4j/marc/ControlField.html#getData()">getData</A></B>()</CODE>\r
 129 \r
 130 <BR>\r
 131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the data element</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;void</CODE></FONT></TD>\r
 136 <TD><CODE><B><A HREF="../../../org/marc4j/marc/ControlField.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
 137 \r
 138 <BR>\r
 139 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the data element.</TD>\r
 140 </TR>\r
 141 </TABLE>\r
 142 &nbsp;<A NAME="methods_inherited_from_class_org.marc4j.marc.VariableField"><!-- --></A>\r
 143 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 144 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 145 <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
 146 </TR>\r
 147 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 148 <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
 149 </TR>\r
 150 </TABLE>\r
 151 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Comparable"><!-- --></A>\r
 152 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 153 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 154 <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
 155 </TR>\r
 156 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 157 <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
 158 </TR>\r
 159 </TABLE>\r
 160 &nbsp;\r
 161 <P>\r
 162 \r
 163 <!-- ============ METHOD DETAIL ========== -->\r
 164 \r
 165 <A NAME="method_detail"><!-- --></A>\r
 166 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 167 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 168 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 169 <B>Method Detail</B></FONT></TH>\r
 170 </TR>\r
 171 </TABLE>\r
 172 \r
 173 <A NAME="getData()"><!-- --></A><H3>\r
 174 getData</H3>\r
 175 <PRE>\r
 176 <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
 177 <DL>\r
 178 <DD>Returns the data element\r
 179 <P>\r
 180 <DD><DL>\r
 181 </DL>\r
 182 </DD>\r
 183 <DD><DL>\r
 184 \r
 185 <DT><B>Returns:</B><DD>String - the data element</DL>\r
 186 </DD>\r
 187 </DL>\r
 188 <HR>\r
 189 \r
 190 <A NAME="setData(java.lang.String)"><!-- --></A><H3>\r
 191 setData</H3>\r
 192 <PRE>\r
 193 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
 194 <DL>\r
 195 <DD>Sets the data element.\r
 196 <P>\r
 197 <DD><DL>\r
 198 </DL>\r
 199 </DD>\r
 200 <DD><DL>\r
 201 <DT><B>Parameters:</B><DD><CODE>data</CODE> - the data element</DL>\r
 202 </DD>\r
 203 </DL>\r
 204 <!-- ========= END OF CLASS DATA ========= -->\r
 205 <HR>\r
 206 \r
 207 \r
 208 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 209 <A NAME="navbar_bottom"><!-- --></A>\r
 210 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 211 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 212 <TR>\r
 213 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 214 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 215 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 216   <TR ALIGN="center" VALIGN="top">\r
 217   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 218   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 219   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 220   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ControlField.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 221   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 222   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 223   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 224   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 225   </TR>\r
 226 </TABLE>\r
 227 </TD>\r
 228 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 229 </EM>\r
 230 </TD>\r
 231 </TR>\r
 232 \r
 233 <TR>\r
 234 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 235 &nbsp;PREV CLASS&nbsp;\r
 236 &nbsp;<A HREF="../../../org/marc4j/marc/DataField.html" title="interface in org.marc4j.marc"><B>NEXT CLASS</B></A></FONT></TD>\r
 237 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 238   <A HREF="../../../index.html?org/marc4j/marc/ControlField.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 239 &nbsp;<A HREF="ControlField.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 240 &nbsp;<SCRIPT type="text/javascript">\r
 241   <!--\r
 242   if(window==top) {\r
 243     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 244   }\r
 245   //-->\r
 246 </SCRIPT>\r
 247 <NOSCRIPT>\r
 248   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 249 </NOSCRIPT>\r
 250 \r
 251 \r
 252 </FONT></TD>\r
 253 </TR>\r
 254 <TR>\r
 255 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 256   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 257 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 258 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 259 </TR>\r
 260 </TABLE>\r
 261 <A NAME="skip-navbar_bottom"></A>\r
 262 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 263 \r
 264 <HR>\r
 265 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
 266 </BODY>\r
 267 </HTML>\r