third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/package-summary.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 org.openexi.proc\r
   9 </TITLE>\r
  10 \r
  11 <META NAME="keywords" CONTENT="org.openexi.proc package">\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="org.openexi.proc";\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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</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;PREV PACKAGE&nbsp;\r
  56 &nbsp;<A HREF="../../../org/openexi/proc/common/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58   <A HREF="../../../index.html?org/openexi/proc/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="package-summary.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 </TABLE>\r
  75 <A NAME="skip-navbar_top"></A>\r
  76 <!-- ========= END OF TOP NAVBAR ========= -->\r
  77 \r
  78 <HR>\r
  79 <H2>\r
  80 Package org.openexi.proc\r
  81 </H2>\r
  82 \r
  83 <tr valign="top" cellpadding="3" border="0">\r
  84 \r
  85 The Proc (Processor) package contains the EXIDecoder, which is used to convert EXI streams to XML format.\r
  86 <P>\r
  87 <B>See:</B>\r
  88 <BR>\r
  89 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>\r
  90 <P>\r
  91 \r
  92 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
  93 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
  94 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
  95 <B>Interface Summary</B></FONT></TH>\r
  96 </TR>\r
  97 <TR BGCOLOR="white" CLASS="TableRowColor">\r
  98 <TD WIDTH="15%"><B><A HREF="../../../org/openexi/proc/EXISchemaResolver.html" title="interface in org.openexi.proc">EXISchemaResolver</A></B></TD>\r
  99 <TD>Developers have the option of implementing the EXISchemaResolver interface
 100  to help EXIReader and EXIDecoder locate the correct grammar cache for parsing
 101  an EXI stream.</TD>\r
 102 </TR>\r
 103 </TABLE>\r
 104 &nbsp;\r
 105 \r
 106 <P>\r
 107 \r
 108 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 109 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 110 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 111 <B>Class Summary</B></FONT></TH>\r
 112 </TR>\r
 113 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 114 <TD WIDTH="15%"><B><A HREF="../../../org/openexi/proc/EXIDecoder.html" title="class in org.openexi.proc">EXIDecoder</A></B></TD>\r
 115 <TD>EXIDecoder provides methods to configure and
 116  instantiate a <A HREF="../../../org/openexi/proc/io/Scanner.html" title="class in org.openexi.proc.io"><CODE>Scanner</CODE></A> object
 117  you can use to parse the contents of an EXI stream.</TD>\r
 118 </TR>\r
 119 </TABLE>\r
 120 &nbsp;\r
 121 \r
 122 <P>\r
 123 \r
 124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 126 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 127 <B>Enum Summary</B></FONT></TH>\r
 128 </TR>\r
 129 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 130 <TD WIDTH="15%"><B><A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A></B></TD>\r
 131 <TD>This enumeration provides three possible settings for header options output.</TD>\r
 132 </TR>\r
 133 </TABLE>\r
 134 &nbsp;\r
 135 \r
 136 <P>\r
 137 <A NAME="package_description"><!-- --></A><H2>\r
 138 Package org.openexi.proc Description\r
 139 </H2>\r
 140 \r
 141 <P>\r
 142 <table>\r
 143 <tr valign="top" cellpadding="3" border="0">\r
 144 <td>\r
 145 <p>The Proc (Processor) package contains the EXIDecoder, which is used to convert EXI streams to XML format.\r
 146 EXIDecoder uses the org.openexi.proc.io.Scanner to parse EXI streams into a sequence of XML events. org.openexi.sax.EXIReader wraps EXIDecoder to provide a SAX interface for accessing the XML content.\r
 147 </p>\r
 148 <p>\r
 149 The EXISchemaResolver interface can be implemented and used to add a hint in the EXI header to help EXIDecoder locate the EXISchema.\r
 150 </p>\r
 151 <p>The HeaderOptionsOutputType enumerator is used to set the header output options in the Transmogrifier.</td>\r
 152 <td width="385">\r
 153 <img src="http://openexi.sourceforge.net/images/OpenEXI_Architecture_Proc.PNG" width="375" height="280" />\r
 154 </td>\r
 155 </tr>\r
 156 </table>\r
 157 </p>\r
 158 <P>\r
 159 \r
 160 <P>\r
 161 <DL>\r
 162 <!-- yWorks UML Doclet   http://www.yworks.com/   b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
 163 </DL>\r
 164 <HR>\r
 165 \r
 166 \r
 167 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 168 <A NAME="navbar_bottom"><!-- --></A>\r
 169 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 170 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 171 <TR>\r
 172 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 173 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 174 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 175   <TR ALIGN="center" VALIGN="top">\r
 176   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 177   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
 178   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
 179   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 180   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 181   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 182   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 183   </TR>\r
 184 </TABLE>\r
 185 </TD>\r
 186 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 187 </EM>\r
 188 </TD>\r
 189 </TR>\r
 190 \r
 191 <TR>\r
 192 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 193 &nbsp;PREV PACKAGE&nbsp;\r
 194 &nbsp;<A HREF="../../../org/openexi/proc/common/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
 195 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 196   <A HREF="../../../index.html?org/openexi/proc/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 197 &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 198 &nbsp;<SCRIPT type="text/javascript">\r
 199   <!--\r
 200   if(window==top) {\r
 201     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 202   }\r
 203   //-->\r
 204 </SCRIPT>\r
 205 <NOSCRIPT>\r
 206   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 207 </NOSCRIPT>\r
 208 \r
 209 \r
 210 </FONT></TD>\r
 211 </TR>\r
 212 </TABLE>\r
 213 <A NAME="skip-navbar_bottom"></A>\r
 214 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 215 \r
 216 <HR>\r
 217 \r
 218 </BODY>\r
 219 </HTML>\r