Original 2.4. With additional eclipse .project/classpath and git ignore
[marc4j.git] / apidoc / org / marc4j / converter / CharConverter.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 CharConverter (MARC4J API)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="org.marc4j.converter.CharConverter 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="CharConverter (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/CharConverter.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;NEXT CLASS</FONT></TD>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58   <A HREF="../../../index.html?org/marc4j/converter/CharConverter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="CharConverter.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;<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</FONT>\r
89 <BR>\r
90 Class CharConverter</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 "><B>org.marc4j.converter.CharConverter</B>\r
94 </PRE>\r
95 <DL>\r
96 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/marc4j/converter/impl/AnselToUnicode.html" title="class in org.marc4j.converter.impl">AnselToUnicode</A>, <A HREF="../../../org/marc4j/converter/impl/Iso5426ToUnicode.html" title="class in org.marc4j.converter.impl">Iso5426ToUnicode</A>, <A HREF="../../../org/marc4j/converter/impl/Iso6937ToUnicode.html" title="class in org.marc4j.converter.impl">Iso6937ToUnicode</A>, <A HREF="../../../org/marc4j/converter/impl/UnicodeToAnsel.html" title="class in org.marc4j.converter.impl">UnicodeToAnsel</A>, <A HREF="../../../org/marc4j/converter/impl/UnicodeToIso5426.html" title="class in org.marc4j.converter.impl">UnicodeToIso5426</A>, <A HREF="../../../org/marc4j/converter/impl/UnicodeToIso6937.html" title="class in org.marc4j.converter.impl">UnicodeToIso6937</A></DD>\r
97 </DL>\r
98 <HR>\r
99 <DL>\r
100 <DT><PRE>public abstract class <B>CharConverter</B><DT>extends <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></DL>\r
101 </PRE>\r
102 \r
103 <P>\r
104 Extend this class to create a character converter.\r
105 <P>\r
106 \r
107 <P>\r
108 <DL>\r
109 <DT><B>Version:</B></DT>\r
110   <DD>$Revision: 1.3 $</DD>\r
111 <DT><B>Author:</B></DT>\r
112   <DD>Bas Peters</DD>\r
113 </DL>\r
114 <HR>\r
115 \r
116 <P>\r
117 \r
118 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
119 \r
120 <A NAME="constructor_summary"><!-- --></A>\r
121 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
122 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
123 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
124 <B>Constructor Summary</B></FONT></TH>\r
125 </TR>\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
127 <TD><CODE><B><A HREF="../../../org/marc4j/converter/CharConverter.html#CharConverter()">CharConverter</A></B>()</CODE>\r
128 \r
129 <BR>\r
130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
131 </TR>\r
132 </TABLE>\r
133 &nbsp;\r
134 <!-- ========== METHOD SUMMARY =========== -->\r
135 \r
136 <A NAME="method_summary"><!-- --></A>\r
137 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
138 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
139 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
140 <B>Method Summary</B></FONT></TH>\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/converter/CharConverter.html#convert(byte[])">convert</A></B>(byte[]&nbsp;dataElement)</CODE>\r
146 \r
147 <BR>\r
148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Alternate method for performing a character conversion.</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>abstract &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
153 <TD><CODE><B><A HREF="../../../org/marc4j/converter/CharConverter.html#convert(char[])">convert</A></B>(char[]&nbsp;dataElement)</CODE>\r
154 \r
155 <BR>\r
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The method that needs to be implemented in a subclass to create a CharConverter.</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;<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
161 <TD><CODE><B><A HREF="../../../org/marc4j/converter/CharConverter.html#convert(java.lang.String)">convert</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;dataElement)</CODE>\r
162 \r
163 <BR>\r
164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Alternate method for performing a character conversion.</TD>\r
165 </TR>\r
166 </TABLE>\r
167 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
168 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
169 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
170 <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
171 </TR>\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">\r
173 <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
174 </TR>\r
175 </TABLE>\r
176 &nbsp;\r
177 <P>\r
178 \r
179 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
180 \r
181 <A NAME="constructor_detail"><!-- --></A>\r
182 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
183 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
184 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
185 <B>Constructor Detail</B></FONT></TH>\r
186 </TR>\r
187 </TABLE>\r
188 \r
189 <A NAME="CharConverter()"><!-- --></A><H3>\r
190 CharConverter</H3>\r
191 <PRE>\r
192 public <B>CharConverter</B>()</PRE>\r
193 <DL>\r
194 </DL>\r
195 \r
196 <!-- ============ METHOD DETAIL ========== -->\r
197 \r
198 <A NAME="method_detail"><!-- --></A>\r
199 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
200 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
201 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
202 <B>Method Detail</B></FONT></TH>\r
203 </TR>\r
204 </TABLE>\r
205 \r
206 <A NAME="convert(char[])"><!-- --></A><H3>\r
207 convert</H3>\r
208 <PRE>\r
209 public abstract <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>convert</B>(char[]&nbsp;dataElement)</PRE>\r
210 <DL>\r
211 <DD>The method that needs to be implemented in a subclass to create a CharConverter.
212  Receives a data element extracted from a record as a array of characters, and 
213  converts that data and returns the result as a <code>String</code> object.\r
214 <P>\r
215 <DD><DL>\r
216 <DT><B>Parameters:</B><DD><CODE>dataElement</CODE> - the data to convert\r
217 <DT><B>Returns:</B><DD>String the conversion result</DL>\r
218 </DD>\r
219 </DL>\r
220 <HR>\r
221 \r
222 <A NAME="convert(byte[])"><!-- --></A><H3>\r
223 convert</H3>\r
224 <PRE>\r
225 public final <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>convert</B>(byte[]&nbsp;dataElement)</PRE>\r
226 <DL>\r
227 <DD>Alternate method for performing a character conversion.  Receives the incoming
228  as a byte array, converts the bytes to characters, and calls the above convert method
229  which must be implemented in the subclass.\r
230 <P>\r
231 <DD><DL>\r
232 <DT><B>Parameters:</B><DD><CODE>dataElement</CODE> - the data to convert\r
233 <DT><B>Returns:</B><DD>String the conversion result</DL>\r
234 </DD>\r
235 </DL>\r
236 <HR>\r
237 \r
238 <A NAME="convert(java.lang.String)"><!-- --></A><H3>\r
239 convert</H3>\r
240 <PRE>\r
241 public final <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>convert</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;dataElement)</PRE>\r
242 <DL>\r
243 <DD>Alternate method for performing a character conversion.  Receives the incoming
244  as a String, converts the String to a character array, and calls the above convert 
245  method which must be implemented in the subclass.\r
246 <P>\r
247 <DD><DL>\r
248 <DT><B>Parameters:</B><DD><CODE>dataElement</CODE> - the data to convert\r
249 <DT><B>Returns:</B><DD>String the conversion result</DL>\r
250 </DD>\r
251 </DL>\r
252 <!-- ========= END OF CLASS DATA ========= -->\r
253 <HR>\r
254 \r
255 \r
256 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
257 <A NAME="navbar_bottom"><!-- --></A>\r
258 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
259 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
260 <TR>\r
261 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
262 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
263 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
264   <TR ALIGN="center" VALIGN="top">\r
265   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
266   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
267   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
268   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CharConverter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
269   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
270   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
271   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
272   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
273   </TR>\r
274 </TABLE>\r
275 </TD>\r
276 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
277 </EM>\r
278 </TD>\r
279 </TR>\r
280 \r
281 <TR>\r
282 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
283 &nbsp;PREV CLASS&nbsp;\r
284 &nbsp;NEXT CLASS</FONT></TD>\r
285 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
286   <A HREF="../../../index.html?org/marc4j/converter/CharConverter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
287 &nbsp;<A HREF="CharConverter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
288 &nbsp;<SCRIPT type="text/javascript">\r
289   <!--\r
290   if(window==top) {\r
291     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
292   }\r
293   //-->\r
294 </SCRIPT>\r
295 <NOSCRIPT>\r
296   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
297 </NOSCRIPT>\r
298 \r
299 \r
300 </FONT></TD>\r
301 </TR>\r
302 <TR>\r
303 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
304   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
305 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
306 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
307 </TR>\r
308 </TABLE>\r
309 <A NAME="skip-navbar_bottom"></A>\r
310 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
311 \r
312 <HR>\r
313 Copyright © 2002-2006 Bas Peters. All Rights Reserved.\r
314 </BODY>\r
315 </HTML>\r