source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/record/meta/RecordTypeInfo.html @ 120

Last change on this file since 120 was 120, checked in by (none), 14 years ago

Added the mail files for the Hadoop JUNit Project
  • Property svn:executable set to *
File size: 25.7 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_07) on Tue Sep 01 20:56:55 UTC 2009 -->
6<TITLE>
7RecordTypeInfo (Hadoop 0.20.1 API)
8</TITLE>
9
10<META NAME="date" CONTENT="2009-09-01">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="RecordTypeInfo (Hadoop 0.20.1 API)";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RecordTypeInfo.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52</EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../../../org/apache/hadoop/record/meta/MapTypeID.html" title="class in org.apache.hadoop.record.meta"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/hadoop/record/meta/StructTypeID.html" title="class in org.apache.hadoop.record.meta"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/hadoop/record/meta/RecordTypeInfo.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="RecordTypeInfo.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91org.apache.hadoop.record.meta</FONT>
92<BR>
93Class RecordTypeInfo</H2>
94<PRE>
95<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/hadoop/record/Record.html" title="class in org.apache.hadoop.record">org.apache.hadoop.record.Record</A>
97      <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.hadoop.record.meta.RecordTypeInfo</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A>, <A HREF="../../../../../org/apache/hadoop/io/Writable.html" title="interface in org.apache.hadoop.io">Writable</A>, <A HREF="../../../../../org/apache/hadoop/io/WritableComparable.html" title="interface in org.apache.hadoop.io">WritableComparable</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public class <B>RecordTypeInfo</B><DT>extends <A HREF="../../../../../org/apache/hadoop/record/Record.html" title="class in org.apache.hadoop.record">Record</A></DL>
105</PRE>
106
107<P>
108A record's Type Information object which can read/write itself.
109 
110 Type information for a record comprises metadata about the record,
111 as well as a collection of type information for each field in the record.
112<P>
113
114<P>
115<HR>
116
117<P>
118
119<!-- ======== CONSTRUCTOR SUMMARY ======== -->
120
121<A NAME="constructor_summary"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125<B>Constructor Summary</B></FONT></TH>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html#RecordTypeInfo()">RecordTypeInfo</A></B>()</CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create an empty RecordTypeInfo object.</TD>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html#RecordTypeInfo(java.lang.String)">RecordTypeInfo</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a RecordTypeInfo object representing a record with the given name</TD>
138</TR>
139</TABLE>
140&nbsp;
141<!-- ========== METHOD SUMMARY =========== -->
142
143<A NAME="method_summary"><!-- --></A>
144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
147<B>Method Summary</B></FONT></TH>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<CODE>&nbsp;void</CODE></FONT></TD>
152<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html#addField(java.lang.String, org.apache.hadoop.record.meta.TypeID)">addField</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;fieldName,
153         <A HREF="../../../../../org/apache/hadoop/record/meta/TypeID.html" title="class in org.apache.hadoop.record.meta">TypeID</A>&nbsp;tid)</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a field.</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>&nbsp;int</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html#compareTo(java.lang.Object)">compareTo</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;peer_)</CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This class doesn't implement Comparable as it's not meant to be used
165 for anything besides de/serializing.</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>&nbsp;void</CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html#deserialize(org.apache.hadoop.record.RecordInput, java.lang.String)">deserialize</A></B>(<A HREF="../../../../../org/apache/hadoop/record/RecordInput.html" title="interface in org.apache.hadoop.record">RecordInput</A>&nbsp;rin,
171            <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;tag)</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deserialize the type information for a record</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../../org/apache/hadoop/record/meta/FieldTypeInfo.html" title="class in org.apache.hadoop.record.meta">FieldTypeInfo</A>&gt;</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html#getFieldTypeInfos()">getFieldTypeInfos</A></B>()</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a collection of field type infos</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html#getName()">getName</A></B>()</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return the name of the record</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>&nbsp;<A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html" title="class in org.apache.hadoop.record.meta">RecordTypeInfo</A></CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html#getNestedStructTypeInfo(java.lang.String)">getNestedStructTypeInfo</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the type info of a nested record.</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>&nbsp;void</CODE></FONT></TD>
203<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html#serialize(org.apache.hadoop.record.RecordOutput, java.lang.String)">serialize</A></B>(<A HREF="../../../../../org/apache/hadoop/record/RecordOutput.html" title="interface in org.apache.hadoop.record">RecordOutput</A>&nbsp;rout,
204          <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;tag)</CODE>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Serialize the type information for a record</TD>
208</TR>
209<TR BGCOLOR="white" CLASS="TableRowColor">
210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211<CODE>&nbsp;void</CODE></FONT></TD>
212<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html#setName(java.lang.String)">setName</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
213
214<BR>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the name of the record</TD>
216</TR>
217</TABLE>
218&nbsp;<A NAME="methods_inherited_from_class_org.apache.hadoop.record.Record"><!-- --></A>
219<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
220<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
221<TH ALIGN="left"><B>Methods inherited from class org.apache.hadoop.record.<A HREF="../../../../../org/apache/hadoop/record/Record.html" title="class in org.apache.hadoop.record">Record</A></B></TH>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD><CODE><A HREF="../../../../../org/apache/hadoop/record/Record.html#deserialize(org.apache.hadoop.record.RecordInput)">deserialize</A>, <A HREF="../../../../../org/apache/hadoop/record/Record.html#readFields(java.io.DataInput)">readFields</A>, <A HREF="../../../../../org/apache/hadoop/record/Record.html#serialize(org.apache.hadoop.record.RecordOutput)">serialize</A>, <A HREF="../../../../../org/apache/hadoop/record/Record.html#toString()">toString</A>, <A HREF="../../../../../org/apache/hadoop/record/Record.html#write(java.io.DataOutput)">write</A></CODE></TD>
225</TR>
226</TABLE>
227&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
228<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
229<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
230<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
231</TR>
232<TR BGCOLOR="white" CLASS="TableRowColor">
233<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
234</TR>
235</TABLE>
236&nbsp;
237<P>
238
239<!-- ========= CONSTRUCTOR DETAIL ======== -->
240
241<A NAME="constructor_detail"><!-- --></A>
242<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
243<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
244<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
245<B>Constructor Detail</B></FONT></TH>
246</TR>
247</TABLE>
248
249<A NAME="RecordTypeInfo()"><!-- --></A><H3>
250RecordTypeInfo</H3>
251<PRE>
252public <B>RecordTypeInfo</B>()</PRE>
253<DL>
254<DD>Create an empty RecordTypeInfo object.
255<P>
256</DL>
257<HR>
258
259<A NAME="RecordTypeInfo(java.lang.String)"><!-- --></A><H3>
260RecordTypeInfo</H3>
261<PRE>
262public <B>RecordTypeInfo</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
263<DL>
264<DD>Create a RecordTypeInfo object representing a record with the given name
265<P>
266<DL>
267<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the record</DL>
268</DL>
269
270<!-- ============ METHOD DETAIL ========== -->
271
272<A NAME="method_detail"><!-- --></A>
273<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
274<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
275<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
276<B>Method Detail</B></FONT></TH>
277</TR>
278</TABLE>
279
280<A NAME="getName()"><!-- --></A><H3>
281getName</H3>
282<PRE>
283public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
284<DL>
285<DD>return the name of the record
286<P>
287<DD><DL>
288</DL>
289</DD>
290</DL>
291<HR>
292
293<A NAME="setName(java.lang.String)"><!-- --></A><H3>
294setName</H3>
295<PRE>
296public void <B>setName</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
297<DL>
298<DD>set the name of the record
299<P>
300<DD><DL>
301</DL>
302</DD>
303</DL>
304<HR>
305
306<A NAME="addField(java.lang.String, org.apache.hadoop.record.meta.TypeID)"><!-- --></A><H3>
307addField</H3>
308<PRE>
309public void <B>addField</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;fieldName,
310                     <A HREF="../../../../../org/apache/hadoop/record/meta/TypeID.html" title="class in org.apache.hadoop.record.meta">TypeID</A>&nbsp;tid)</PRE>
311<DL>
312<DD>Add a field.
313<P>
314<DD><DL>
315<DT><B>Parameters:</B><DD><CODE>fieldName</CODE> - Name of the field<DD><CODE>tid</CODE> - Type ID of the field</DL>
316</DD>
317</DL>
318<HR>
319
320<A NAME="getFieldTypeInfos()"><!-- --></A><H3>
321getFieldTypeInfos</H3>
322<PRE>
323public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../../org/apache/hadoop/record/meta/FieldTypeInfo.html" title="class in org.apache.hadoop.record.meta">FieldTypeInfo</A>&gt; <B>getFieldTypeInfos</B>()</PRE>
324<DL>
325<DD>Return a collection of field type infos
326<P>
327<DD><DL>
328</DL>
329</DD>
330</DL>
331<HR>
332
333<A NAME="getNestedStructTypeInfo(java.lang.String)"><!-- --></A><H3>
334getNestedStructTypeInfo</H3>
335<PRE>
336public <A HREF="../../../../../org/apache/hadoop/record/meta/RecordTypeInfo.html" title="class in org.apache.hadoop.record.meta">RecordTypeInfo</A> <B>getNestedStructTypeInfo</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
337<DL>
338<DD>Return the type info of a nested record. We only consider nesting
339 to one level.
340<P>
341<DD><DL>
342<DT><B>Parameters:</B><DD><CODE>name</CODE> - Name of the nested record</DL>
343</DD>
344</DL>
345<HR>
346
347<A NAME="serialize(org.apache.hadoop.record.RecordOutput, java.lang.String)"><!-- --></A><H3>
348serialize</H3>
349<PRE>
350public void <B>serialize</B>(<A HREF="../../../../../org/apache/hadoop/record/RecordOutput.html" title="interface in org.apache.hadoop.record">RecordOutput</A>&nbsp;rout,
351                      <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;tag)
352               throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
353<DL>
354<DD>Serialize the type information for a record
355<P>
356<DD><DL>
357<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/record/Record.html#serialize(org.apache.hadoop.record.RecordOutput, java.lang.String)">serialize</A></CODE> in class <CODE><A HREF="../../../../../org/apache/hadoop/record/Record.html" title="class in org.apache.hadoop.record">Record</A></CODE></DL>
358</DD>
359<DD><DL>
360<DT><B>Parameters:</B><DD><CODE>rout</CODE> - Record output destination<DD><CODE>tag</CODE> - record tag (Used only in tagged serialization e.g. XML)
361<DT><B>Throws:</B>
362<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
363</DD>
364</DL>
365<HR>
366
367<A NAME="deserialize(org.apache.hadoop.record.RecordInput, java.lang.String)"><!-- --></A><H3>
368deserialize</H3>
369<PRE>
370public void <B>deserialize</B>(<A HREF="../../../../../org/apache/hadoop/record/RecordInput.html" title="interface in org.apache.hadoop.record">RecordInput</A>&nbsp;rin,
371                        <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;tag)
372                 throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
373<DL>
374<DD>Deserialize the type information for a record
375<P>
376<DD><DL>
377<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/record/Record.html#deserialize(org.apache.hadoop.record.RecordInput, java.lang.String)">deserialize</A></CODE> in class <CODE><A HREF="../../../../../org/apache/hadoop/record/Record.html" title="class in org.apache.hadoop.record">Record</A></CODE></DL>
378</DD>
379<DD><DL>
380<DT><B>Parameters:</B><DD><CODE>rin</CODE> - Record input source<DD><CODE>tag</CODE> - Record tag (Used only in tagged serialization e.g. XML)
381<DT><B>Throws:</B>
382<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
383</DD>
384</DL>
385<HR>
386
387<A NAME="compareTo(java.lang.Object)"><!-- --></A><H3>
388compareTo</H3>
389<PRE>
390public int <B>compareTo</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;peer_)
391              throws <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</A></PRE>
392<DL>
393<DD>This class doesn't implement Comparable as it's not meant to be used
394 for anything besides de/serializing.
395 So we always throw an exception.
396 Not implemented. Always returns 0 if another RecordTypeInfo is passed in.
397<P>
398<DD><DL>
399<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</A></CODE> in interface <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/hadoop/record/Record.html#compareTo(java.lang.Object)">compareTo</A></CODE> in class <CODE><A HREF="../../../../../org/apache/hadoop/record/Record.html" title="class in org.apache.hadoop.record">Record</A></CODE></DL>
400</DD>
401<DD><DL>
402
403<DT><B>Throws:</B>
404<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</A></CODE></DL>
405</DD>
406</DL>
407<!-- ========= END OF CLASS DATA ========= -->
408<HR>
409
410
411<!-- ======= START OF BOTTOM NAVBAR ====== -->
412<A NAME="navbar_bottom"><!-- --></A>
413<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
414<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
415<TR>
416<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
417<A NAME="navbar_bottom_firstrow"><!-- --></A>
418<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
419  <TR ALIGN="center" VALIGN="top">
420  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
421  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
422  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
423  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RecordTypeInfo.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
424  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
425  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
426  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
427  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
428  </TR>
429</TABLE>
430</TD>
431<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
432</EM>
433</TD>
434</TR>
435
436<TR>
437<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
438&nbsp;<A HREF="../../../../../org/apache/hadoop/record/meta/MapTypeID.html" title="class in org.apache.hadoop.record.meta"><B>PREV CLASS</B></A>&nbsp;
439&nbsp;<A HREF="../../../../../org/apache/hadoop/record/meta/StructTypeID.html" title="class in org.apache.hadoop.record.meta"><B>NEXT CLASS</B></A></FONT></TD>
440<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
441  <A HREF="../../../../../index.html?org/apache/hadoop/record/meta/RecordTypeInfo.html" target="_top"><B>FRAMES</B></A>  &nbsp;
442&nbsp;<A HREF="RecordTypeInfo.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
443&nbsp;<SCRIPT type="text/javascript">
444  <!--
445  if(window==top) {
446    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
447  }
448  //-->
449</SCRIPT>
450<NOSCRIPT>
451  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
452</NOSCRIPT>
453
454
455</FONT></TD>
456</TR>
457<TR>
458<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
459  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
460<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
461DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
462</TR>
463</TABLE>
464<A NAME="skip-navbar_bottom"></A>
465<!-- ======== END OF BOTTOM NAVBAR ======= -->
466
467<HR>
468Copyright &copy; 2009 The Apache Software Foundation
469</BODY>
470</HTML>
Note: See TracBrowser for help on using the repository browser.