third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/EXISchema.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_22) on Thu Apr 10 14:54:58 PDT 2014 -->\r
   6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">\r
   7 <TITLE>\r
   8 EXISchema\r
   9 </TITLE>\r
  10 \r
  11 <META NAME="keywords" CONTENT="org.openexi.schema.EXISchema class">\r
  12 \r
  13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
  14 \r
  15 <SCRIPT type="text/javascript">\r
  16 function windowTitle()\r
  17 {\r
  18     parent.document.title="EXISchema";\r
  19 }\r
  20 </SCRIPT>\r
  21 <NOSCRIPT>\r
  22 </NOSCRIPT>\r
  23 \r
  24 </HEAD>\r
  25 \r
  26 <BODY BGCOLOR="white" onload="windowTitle();">\r
  27 \r
  28 \r
  29 <!-- ========= START OF TOP NAVBAR ======= -->\r
  30 <A NAME="navbar_top"><!-- --></A>\r
  31 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
  32 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
  33 <TR>\r
  34 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
  35 <A NAME="navbar_top_firstrow"><!-- --></A>\r
  36 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
  37   <TR ALIGN="center" VALIGN="top">\r
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
  39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  40   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&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/openexi/schema/EmptySchema.html" title="class in org.openexi.schema"><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/openexi/schema/EXISchema.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="EXISchema.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="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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.openexi.schema</FONT>\r
  89 <BR>\r
  90 Class EXISchema</H2>\r
  91 <PRE>\r
  92 java.lang.Object\r
  93   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.schema.EXISchema</B>\r
  94 </PRE>\r
  95 <HR>\r
  96 <DL>\r
  97 <DT><PRE>public final class <B>EXISchema</B><DT>extends java.lang.Object</DL>\r
  98 </PRE>\r
  99 \r
 100 <P>\r
 101 EXISchema provides methods to read and write compiled EXI schemas.\r
 102 <P>\r
 103 \r
 104 <P>\r
 105 <DL>\r
 106 <!-- yWorks UML Doclet   http://www.yworks.com/   b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
 107 </DL>\r
 108 <HR>\r
 109 \r
 110 <P>\r
 111 <!-- =========== FIELD SUMMARY =========== -->\r
 112 \r
 113 <A NAME="field_summary"><!-- --></A>\r
 114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 116 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 117 <B>Field Summary</B></FONT></TH>\r
 118 </TR>\r
 119 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 120 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 121 <CODE>&nbsp;byte[]</CODE></FONT></TD>\r
 122 <TD><CODE><B><A HREF="../../../org/openexi/schema/EXISchema.html#ancestryIds">ancestryIds</A></B></CODE>\r
 123 \r
 124 <BR>\r
 125 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 126 </TR>\r
 127 </TABLE>\r
 128 &nbsp;\r
 129 <!-- ========== METHOD SUMMARY =========== -->\r
 130 \r
 131 <A NAME="method_summary"><!-- --></A>\r
 132 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 133 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 134 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 135 <B>Method Summary</B></FONT></TH>\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>static&nbsp;boolean</CODE></FONT></TD>\r
 140 <TD><CODE><B><A HREF="../../../org/openexi/schema/EXISchema.html#_isSimpleType(int, int[])">_isSimpleType</A></B>(int&nbsp;tp,\r
 141               int[]&nbsp;types)</CODE>\r
 142 \r
 143 <BR>\r
 144 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 145 </TR>\r
 146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 148 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 149 <TD><CODE><B><A HREF="../../../org/openexi/schema/EXISchema.html#isSimpleType(int)">isSimpleType</A></B>(int&nbsp;tp)</CODE>\r
 150 \r
 151 <BR>\r
 152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 153 </TR>\r
 154 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 156 <CODE>static&nbsp;<A HREF="../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A></CODE></FONT></TD>\r
 157 <TD><CODE><B><A HREF="../../../org/openexi/schema/EXISchema.html#readIn(java.io.DataInputStream)">readIn</A></B>(java.io.DataInputStream&nbsp;in)</CODE>\r
 158 \r
 159 <BR>\r
 160 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads an EXI Schema from a DataInputStream.</TD>\r
 161 </TR>\r
 162 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 164 <CODE>&nbsp;void</CODE></FONT></TD>\r
 165 <TD><CODE><B><A HREF="../../../org/openexi/schema/EXISchema.html#writeOut(java.io.DataOutputStream)">writeOut</A></B>(java.io.DataOutputStream&nbsp;out)</CODE>\r
 166 \r
 167 <BR>\r
 168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes out a serialized EXISchema.</TD>\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>&nbsp;void</CODE></FONT></TD>\r
 173 <TD><CODE><B><A HREF="../../../org/openexi/schema/EXISchema.html#writeXml(java.io.OutputStream, boolean)">writeXml</A></B>(java.io.OutputStream&nbsp;out,\r
 174          boolean&nbsp;whole)</CODE>\r
 175 \r
 176 <BR>\r
 177 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 178 </TR>\r
 179 </TABLE>\r
 180 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 181 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 182 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 183 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
 184 </TR>\r
 185 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 186 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 187 </TR>\r
 188 </TABLE>\r
 189 &nbsp;\r
 190 <P>\r
 191 \r
 192 <!-- ============ FIELD DETAIL =========== -->\r
 193 \r
 194 <A NAME="field_detail"><!-- --></A>\r
 195 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 196 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 197 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 198 <B>Field Detail</B></FONT></TH>\r
 199 </TR>\r
 200 </TABLE>\r
 201 \r
 202 <A NAME="ancestryIds"><!-- --></A><H3>\r
 203 ancestryIds</H3>\r
 204 <PRE>\r
 205 public transient byte[] <B>ancestryIds</B></PRE>\r
 206 <DL>\r
 207 <DL>\r
 208 </DL>\r
 209 </DL>\r
 210 \r
 211 <!-- ============ METHOD DETAIL ========== -->\r
 212 \r
 213 <A NAME="method_detail"><!-- --></A>\r
 214 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 215 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 216 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 217 <B>Method Detail</B></FONT></TH>\r
 218 </TR>\r
 219 </TABLE>\r
 220 \r
 221 <A NAME="isSimpleType(int)"><!-- --></A><H3>\r
 222 isSimpleType</H3>\r
 223 <PRE>\r
 224 public boolean <B>isSimpleType</B>(int&nbsp;tp)</PRE>\r
 225 <DL>\r
 226 <DD><DL>\r
 227 </DL>\r
 228 </DD>\r
 229 </DL>\r
 230 <HR>\r
 231 \r
 232 <A NAME="_isSimpleType(int, int[])"><!-- --></A><H3>\r
 233 _isSimpleType</H3>\r
 234 <PRE>\r
 235 public static boolean <B>_isSimpleType</B>(int&nbsp;tp,\r
 236                                     int[]&nbsp;types)</PRE>\r
 237 <DL>\r
 238 <DD><DL>\r
 239 </DL>\r
 240 </DD>\r
 241 </DL>\r
 242 <HR>\r
 243 \r
 244 <A NAME="readIn(java.io.DataInputStream)"><!-- --></A><H3>\r
 245 readIn</H3>\r
 246 <PRE>\r
 247 public static <A HREF="../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A> <B>readIn</B>(java.io.DataInputStream&nbsp;in)\r
 248                         throws java.io.IOException,\r
 249                                java.lang.ClassNotFoundException</PRE>\r
 250 <DL>\r
 251 <DD>Reads an EXI Schema from a DataInputStream.\r
 252 <P>\r
 253 <DD><DL>\r
 254 <DT><B>Parameters:</B><DD><CODE>in</CODE> - DataInputStream containing a serialized EXISchema\r
 255 <DT><B>Returns:</B><DD><A HREF="../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema"><CODE>EXISchema</CODE></A>\r
 256 <DT><B>Throws:</B>\r
 257 <DD><CODE>IOException,</CODE> - ClassNotFoundException\r
 258 <DD><CODE>java.io.IOException</CODE>\r
 259 <DD><CODE>java.lang.ClassNotFoundException</CODE></DL>\r
 260 </DD>\r
 261 </DL>\r
 262 <HR>\r
 263 \r
 264 <A NAME="writeOut(java.io.DataOutputStream)"><!-- --></A><H3>\r
 265 writeOut</H3>\r
 266 <PRE>\r
 267 public void <B>writeOut</B>(java.io.DataOutputStream&nbsp;out)\r
 268               throws java.io.IOException</PRE>\r
 269 <DL>\r
 270 <DD>Writes out a serialized EXISchema.\r
 271 <P>\r
 272 <DD><DL>\r
 273 <DT><B>Parameters:</B><DD><CODE>out</CODE> - DataOutputStream to receive the serialized EXISchema\r
 274 <DT><B>Throws:</B>\r
 275 <DD><CODE>java.io.IOException</CODE></DL>\r
 276 </DD>\r
 277 </DL>\r
 278 <HR>\r
 279 \r
 280 <A NAME="writeXml(java.io.OutputStream, boolean)"><!-- --></A><H3>\r
 281 writeXml</H3>\r
 282 <PRE>\r
 283 public void <B>writeXml</B>(java.io.OutputStream&nbsp;out,\r
 284                      boolean&nbsp;whole)\r
 285               throws java.io.IOException</PRE>\r
 286 <DL>\r
 287 <DD><DL>\r
 288 \r
 289 <DT><B>Throws:</B>\r
 290 <DD><CODE>java.io.IOException</CODE></DL>\r
 291 </DD>\r
 292 </DL>\r
 293 <!-- ========= END OF CLASS DATA ========= -->\r
 294 <HR>\r
 295 \r
 296 \r
 297 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 298 <A NAME="navbar_bottom"><!-- --></A>\r
 299 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 300 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 301 <TR>\r
 302 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 303 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 304 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 305   <TR ALIGN="center" VALIGN="top">\r
 306   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 307   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 308   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 309   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 310   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 311   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 312   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 313   </TR>\r
 314 </TABLE>\r
 315 </TD>\r
 316 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 317 </EM>\r
 318 </TD>\r
 319 </TR>\r
 320 \r
 321 <TR>\r
 322 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 323 &nbsp;<A HREF="../../../org/openexi/schema/EmptySchema.html" title="class in org.openexi.schema"><B>PREV CLASS</B></A>&nbsp;\r
 324 &nbsp;NEXT CLASS</FONT></TD>\r
 325 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 326   <A HREF="../../../index.html?org/openexi/schema/EXISchema.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 327 &nbsp;<A HREF="EXISchema.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 328 &nbsp;<SCRIPT type="text/javascript">\r
 329   <!--\r
 330   if(window==top) {\r
 331     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 332   }\r
 333   //-->\r
 334 </SCRIPT>\r
 335 <NOSCRIPT>\r
 336   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 337 </NOSCRIPT>\r
 338 \r
 339 \r
 340 </FONT></TD>\r
 341 </TR>\r
 342 <TR>\r
 343 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 344   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 345 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 346 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 347 </TR>\r
 348 </TABLE>\r
 349 <A NAME="skip-navbar_bottom"></A>\r
 350 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 351 \r
 352 <HR>\r
 353 \r
 354 </BODY>\r
 355 </HTML>\r