Original 2.4. With additional eclipse .project/classpath and git ignore
[marc4j.git] / apidoc / org / marc4j / converter / impl / CodeTableGenerator.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 CodeTableGenerator (MARC4J API)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="org.marc4j.converter.impl.CodeTableGenerator class">\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="CodeTableGenerator (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/CodeTableGenerator.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/converter/impl/CodeTableGenerated.html" title="class in org.marc4j.converter.impl"><B>PREV CLASS</B></A>&nbsp;\r
56 &nbsp;<A HREF="../../../../org/marc4j/converter/impl/CodeTableHandler.html" title="class in org.marc4j.converter.impl"><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/converter/impl/CodeTableGenerator.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="CodeTableGenerator.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;<A HREF="#fields_inherited_from_class_org.marc4j.converter.impl.CodeTable">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&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;<A HREF="#constructor_detail">CONSTR</A>&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.converter.impl</FONT>\r
89 <BR>\r
90 Class CodeTableGenerator</H2>\r
91 <PRE>\r
92 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>\r
93   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/marc4j/converter/impl/CodeTable.html" title="class in org.marc4j.converter.impl">org.marc4j.converter.impl.CodeTable</A>\r
94       <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.marc4j.converter.impl.CodeTableGenerator</B>\r
95 </PRE>\r
96 <DL>\r
97 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/marc4j/converter/impl/CodeTableInterface.html" title="interface in org.marc4j.converter.impl">CodeTableInterface</A></DD>\r
98 </DL>\r
99 <HR>\r
100 <DL>\r
101 <DT><PRE>public class <B>CodeTableGenerator</B><DT>extends <A HREF="../../../../org/marc4j/converter/impl/CodeTable.html" title="class in org.marc4j.converter.impl">CodeTable</A></DL>\r
102 </PRE>\r
103 \r
104 <P>\r
105 Invoked at build time to generate a java source file (named CodeTableGenerated.java) 
106  which when compiled will implement the CodeTableInterface (primarily through switch statements)
107  and which can be used be the AnselToUnicode converter instead of this class, and which will
108  produce the same results as the object CodeTable.
109  <br>
110  The following routines are only used in the code generation process, and are not available to
111  be called from within an application that uses Marc4j. 
112  <br>
113  The routines generated for converting MARC8 multibyte characters to unicode are 
114  split into several routines to workaround a limitation in java that a method can only contain 64k of code when it is compiled.\r
115 <P>\r
116 \r
117 <P>\r
118 <DL>\r
119 <DT><B>Version:</B></DT>\r
120   <DD>$Revision: 1.2 $</DD>\r
121 <DT><B>Author:</B></DT>\r
122   <DD>Robert Haschart</DD>\r
123 </DL>\r
124 <HR>\r
125 \r
126 <P>\r
127 <!-- =========== FIELD SUMMARY =========== -->\r
128 \r
129 <A NAME="field_summary"><!-- --></A>\r
130 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
131 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
132 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
133 <B>Field Summary</B></FONT></TH>\r
134 </TR>\r
135 </TABLE>\r
136 &nbsp;<A NAME="fields_inherited_from_class_org.marc4j.converter.impl.CodeTable"><!-- --></A>\r
137 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
138 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
139 <TH ALIGN="left"><B>Fields inherited from class org.marc4j.converter.impl.<A HREF="../../../../org/marc4j/converter/impl/CodeTable.html" title="class in org.marc4j.converter.impl">CodeTable</A></B></TH>\r
140 </TR>\r
141 <TR BGCOLOR="white" CLASS="TableRowColor">\r
142 <TD><CODE><A HREF="../../../../org/marc4j/converter/impl/CodeTable.html#charsets">charsets</A>, <A HREF="../../../../org/marc4j/converter/impl/CodeTable.html#combining">combining</A></CODE></TD>\r
143 </TR>\r
144 </TABLE>\r
145 &nbsp;\r
146 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
147 \r
148 <A NAME="constructor_summary"><!-- --></A>\r
149 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
150 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
151 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
152 <B>Constructor Summary</B></FONT></TH>\r
153 </TR>\r
154 <TR BGCOLOR="white" CLASS="TableRowColor">\r
155 <TD><CODE><B><A HREF="../../../../org/marc4j/converter/impl/CodeTableGenerator.html#CodeTableGenerator(java.io.InputStream)">CodeTableGenerator</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A>&nbsp;byteStream)</CODE>\r
156 \r
157 <BR>\r
158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
159 </TR>\r
160 </TABLE>\r
161 &nbsp;\r
162 <!-- ========== METHOD SUMMARY =========== -->\r
163 \r
164 <A NAME="method_summary"><!-- --></A>\r
165 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
166 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
167 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
168 <B>Method Summary</B></FONT></TH>\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>static&nbsp;void</CODE></FONT></TD>\r
173 <TD><CODE><B><A HREF="../../../../org/marc4j/converter/impl/CodeTableGenerator.html#main(java.lang.String[])">main</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;args)</CODE>\r
174 \r
175 <BR>\r
176 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
177 </TR>\r
178 </TABLE>\r
179 &nbsp;<A NAME="methods_inherited_from_class_org.marc4j.converter.impl.CodeTable"><!-- --></A>\r
180 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
181 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
182 <TH ALIGN="left"><B>Methods inherited from class org.marc4j.converter.impl.<A HREF="../../../../org/marc4j/converter/impl/CodeTable.html" title="class in org.marc4j.converter.impl">CodeTable</A></B></TH>\r
183 </TR>\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">\r
185 <TD><CODE><A HREF="../../../../org/marc4j/converter/impl/CodeTable.html#getChar(int, int)">getChar</A>, <A HREF="../../../../org/marc4j/converter/impl/CodeTable.html#isCombining(int, int, int)">isCombining</A></CODE></TD>\r
186 </TR>\r
187 </TABLE>\r
188 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
189 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
190 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
191 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>\r
192 </TR>\r
193 <TR BGCOLOR="white" CLASS="TableRowColor">\r
194 <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
195 </TR>\r
196 </TABLE>\r
197 &nbsp;\r
198 <P>\r
199 \r
200 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
201 \r
202 <A NAME="constructor_detail"><!-- --></A>\r
203 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
204 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
205 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
206 <B>Constructor Detail</B></FONT></TH>\r
207 </TR>\r
208 </TABLE>\r
209 \r
210 <A NAME="CodeTableGenerator(java.io.InputStream)"><!-- --></A><H3>\r
211 CodeTableGenerator</H3>\r
212 <PRE>\r
213 public <B>CodeTableGenerator</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A>&nbsp;byteStream)</PRE>\r
214 <DL>\r
215 </DL>\r
216 \r
217 <!-- ============ METHOD DETAIL ========== -->\r
218 \r
219 <A NAME="method_detail"><!-- --></A>\r
220 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
221 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
222 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
223 <B>Method Detail</B></FONT></TH>\r
224 </TR>\r
225 </TABLE>\r
226 \r
227 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
228 main</H3>\r
229 <PRE>\r
230 public static void <B>main</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;args)</PRE>\r
231 <DL>\r
232 <DD><DL>\r
233 </DL>\r
234 </DD>\r
235 </DL>\r
236 <!-- ========= END OF CLASS DATA ========= -->\r
237 <HR>\r
238 \r
239 \r
240 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
241 <A NAME="navbar_bottom"><!-- --></A>\r
242 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
243 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
244 <TR>\r
245 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
246 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
247 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
248   <TR ALIGN="center" VALIGN="top">\r
249   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
250   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
251   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
252   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CodeTableGenerator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
253   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
254   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
255   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
256   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
257   </TR>\r
258 </TABLE>\r
259 </TD>\r
260 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
261 </EM>\r
262 </TD>\r
263 </TR>\r
264 \r
265 <TR>\r
266 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
267 &nbsp;<A HREF="../../../../org/marc4j/converter/impl/CodeTableGenerated.html" title="class in org.marc4j.converter.impl"><B>PREV CLASS</B></A>&nbsp;\r
268 &nbsp;<A HREF="../../../../org/marc4j/converter/impl/CodeTableHandler.html" title="class in org.marc4j.converter.impl"><B>NEXT CLASS</B></A></FONT></TD>\r
269 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
270   <A HREF="../../../../index.html?org/marc4j/converter/impl/CodeTableGenerator.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
271 &nbsp;<A HREF="CodeTableGenerator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
272 &nbsp;<SCRIPT type="text/javascript">\r
273   <!--\r
274   if(window==top) {\r
275     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
276   }\r
277   //-->\r
278 </SCRIPT>\r
279 <NOSCRIPT>\r
280   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
281 </NOSCRIPT>\r
282 \r
283 \r
284 </FONT></TD>\r
285 </TR>\r
286 <TR>\r
287 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
288   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.marc4j.converter.impl.CodeTable">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
289 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
290 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
291 </TR>\r
292 </TABLE>\r
293 <A NAME="skip-navbar_bottom"></A>\r
294 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
295 \r
296 <HR>\r
297 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
298 </BODY>\r
299 </HTML>\r