git.gag.com Git - debian/freetts/blob - javadoc/com/sun/speech/engine/synthesis/JSMLParser.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.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->\r
   6 <TITLE>\r
   7 JSMLParser (FreeTTS 1.2)\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="keywords" CONTENT="com.sun.speech.engine.synthesis.JSMLParser 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="JSMLParser (FreeTTS 1.2)";\r
  18 }\r
  19 </SCRIPT>\r
  20 \r
  21 </HEAD>\r
  22 \r
  23 <BODY BGCOLOR="white" onload="windowTitle();">\r
  24 \r
  25
  26 <!-- ========= START OF TOP NAVBAR ======= -->\r
  27 <A NAME="navbar_top"><!-- --></A>
  28 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  29 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
  30 <TR>\r
  31 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
  32 <A NAME="navbar_top_firstrow"><!-- --></A>
  33 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
  34   <TR ALIGN="center" VALIGN="top">\r
  35   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
  36   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  37   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  42   </TR>\r
  43 </TABLE>\r
  44 </TD>\r
  45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  46 </EM>\r
  47 </TD>\r
  48 </TR>\r
  49 \r
  50 <TR>\r
  51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  52 &nbsp;<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis"><B>PREV CLASS</B></A>&nbsp;\r
  53 &nbsp;<A HREF="../../../../../com/sun/speech/engine/synthesis/SynthesizerMonitor.html" title="class in com.sun.speech.engine.synthesis"><B>NEXT CLASS</B></A></FONT></TD>\r
  54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  55   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  56 &nbsp;<A HREF="JSMLParser.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  57 &nbsp;<SCRIPT type="text/javascript">\r
  58   <!--\r
  59   if(window==top) {\r
  60     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  61   }\r
  62   //-->\r
  63 </SCRIPT>\r
  64 <NOSCRIPT>\r
  65   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
  66 </NOSCRIPT>
  67 \r
  68 </FONT></TD>\r
  69 </TR>\r
  70 <TR>\r
  71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  72   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
  73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  74 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  75 </TR>\r
  76 </TABLE>\r
  77 <A NAME="skip-navbar_top"></A>
  78 <!-- ========= END OF TOP NAVBAR ========= -->\r
  79 \r
  80 <HR>\r
  81 <!-- ======== START OF CLASS DATA ======== -->\r
  82 <H2>\r
  83 <FONT SIZE="-1">\r
  84 com.sun.speech.engine.synthesis</FONT>\r
  85 <BR>\r
  86 Class JSMLParser</H2>\r
  87 <PRE>\r
  88 java.lang.Object\r
  89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.engine.synthesis.JSMLParser</B>\r
  90 </PRE>\r
  91 <HR>\r
  92 <DL>\r
  93 <DT>public class <B>JSMLParser</B><DT>extends java.lang.Object</DL>\r
  94 \r
  95 <P>\r
  96 Parses a JSML 0.6 document and returns a DOM.\r
  97 <P>\r
  98 \r
  99 <P>\r
 100 <HR>\r
 101 \r
 102 <P>\r
 103 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
 104 \r
 105 \r
 106 <!-- =========== FIELD SUMMARY =========== -->\r
 107 \r
 108 \r
 109 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 110 \r
 111 <A NAME="constructor_summary"><!-- --></A>
 112 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 113 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 114 <TD COLSPAN=2><FONT SIZE="+2">\r
 115 <B>Constructor Summary</B></FONT></TD>\r
 116 </TR>\r
 117 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 118 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/JSMLParser.html#JSMLParser(java.lang.String, boolean)">JSMLParser</A></B>(java.lang.String&nbsp;jsmlText,
 119            boolean&nbsp;validate)</CODE>\r
 120 \r
 121 <BR>\r
 122 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new JSMLParser for the given JSML
 123  text.  </TD>\r
 124 </TR>\r
 125 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 126 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/JSMLParser.html#JSMLParser(java.net.URL, boolean)">JSMLParser</A></B>(java.net.URL&nbsp;jsmlSource,
 127            boolean&nbsp;validate)</CODE>\r
 128 \r
 129 <BR>\r
 130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new JSMLParser for the given <code>URL</code>.
 131  </TD>\r
 132 </TR>\r
 133 </TABLE>\r
 134 &nbsp;\r
 135 <!-- ========== METHOD SUMMARY =========== -->\r
 136 \r
 137 <A NAME="method_summary"><!-- --></A>
 138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 140 <TD COLSPAN=2><FONT SIZE="+2">\r
 141 <B>Method Summary</B></FONT></TD>\r
 142 </TR>\r
 143 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 145 <CODE>&nbsp;org.w3c.dom.Document</CODE></FONT></TD>\r
 146 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/JSMLParser.html#getDocument()">getDocument</A></B>()</CODE>\r
 147 \r
 148 <BR>\r
 149 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the document for this parser.</TD>\r
 150 </TR>\r
 151 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 153 <CODE>protected &nbsp;org.w3c.dom.Document</CODE></FONT></TD>\r
 154 <TD><CODE><B><A HREF="../../../../../com/sun/speech/engine/synthesis/JSMLParser.html#parse(org.xml.sax.InputSource, boolean)">parse</A></B>(org.xml.sax.InputSource&nbsp;source,
 155       boolean&nbsp;validate)</CODE>\r
 156 \r
 157 <BR>\r
 158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parses the source and optionally validates it.</TD>\r
 159 </TR>\r
 160 </TABLE>\r
 161 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 162 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 163 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 164 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
 165 </TR>\r
 166 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 167 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
 168 </TR>\r
 169 </TABLE>\r
 170 &nbsp;\r
 171 <P>\r
 172 \r
 173 <!-- ============ FIELD DETAIL =========== -->\r
 174 \r
 175 \r
 176 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 177 \r
 178 <A NAME="constructor_detail"><!-- --></A>
 179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 180 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 181 <TD COLSPAN=1><FONT SIZE="+2">\r
 182 <B>Constructor Detail</B></FONT></TD>\r
 183 </TR>\r
 184 </TABLE>\r
 185 \r
 186 <A NAME="JSMLParser(java.lang.String, boolean)"><!-- --></A><H3>\r
 187 JSMLParser</H3>\r
 188 <PRE>\r
 189 public <B>JSMLParser</B>(java.lang.String&nbsp;jsmlText,
 190                   boolean&nbsp;validate)
 191            throws javax.speech.synthesis.JSMLException</PRE>\r
 192 <DL>\r
 193 <DD>Creates a new JSMLParser for the given JSML
 194  text.  Parses the text immediately and return any errors.
 195  The resulting DOM Document can be retrieved via
 196  <code>getDocument</code>.
 197  The optional validate will do validation of the JSML text.
 198  This is typically not used since JSML doesn't require validation.\r
 199 <P>\r
 200 <DT><B>Parameters:</B><DD><CODE>jsmlText</CODE> - the JSML text<DD><CODE>validate</CODE> - if <code>true</code>, validate the JSML text
 201 <DT><B>Throws:</B>
 202 <DD><CODE>javax.speech.synthesis.JSMLException</CODE> - if the JSML text contains errors<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/JSMLParser.html#getDocument()"><CODE>getDocument()</CODE></A></DL>\r
 203 <HR>\r
 204 \r
 205 <A NAME="JSMLParser(java.net.URL, boolean)"><!-- --></A><H3>\r
 206 JSMLParser</H3>\r
 207 <PRE>\r
 208 public <B>JSMLParser</B>(java.net.URL&nbsp;jsmlSource,
 209                   boolean&nbsp;validate)
 210            throws javax.speech.synthesis.JSMLException,
 211                   java.io.IOException</PRE>\r
 212 <DL>\r
 213 <DD>Creates a new JSMLParser for the given <code>URL</code>.
 214  Parses the text immediately and returns any errors.
 215  The resulting DOM Document can be retrieved via
 216  <code>getDocument</code>.
 217  The optional validate will do validation of the JSML text.
 218  This is typically not used since JSML doesn't require validation.\r
 219 <P>\r
 220 <DT><B>Parameters:</B><DD><CODE>jsmlSource</CODE> - the URL containing JSML text<DD><CODE>validate</CODE> - if <code>true</code>, validate the JSML text
 221 <DT><B>Throws:</B>
 222 <DD><CODE>javax.speech.synthesis.JSMLException</CODE> - if the JSML text contains errors
 223 <DD><CODE>java.io.IOException</CODE> - if problems encountered with URL<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/speech/engine/synthesis/JSMLParser.html#getDocument()"><CODE>getDocument()</CODE></A></DL>\r
 224 \r
 225 <!-- ============ METHOD DETAIL ========== -->\r
 226 \r
 227 <A NAME="method_detail"><!-- --></A>
 228 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 229 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 230 <TD COLSPAN=1><FONT SIZE="+2">\r
 231 <B>Method Detail</B></FONT></TD>\r
 232 </TR>\r
 233 </TABLE>\r
 234 \r
 235 <A NAME="getDocument()"><!-- --></A><H3>\r
 236 getDocument</H3>\r
 237 <PRE>\r
 238 public org.w3c.dom.Document <B>getDocument</B>()</PRE>\r
 239 <DL>\r
 240 <DD>Gets the document for this parser.\r
 241 <P>\r
 242 <DD><DL>\r
 243
 244 <DT><B>Returns:</B><DD>a DOM</DL>\r
 245 </DD>\r
 246 </DL>\r
 247 <HR>\r
 248 \r
 249 <A NAME="parse(org.xml.sax.InputSource, boolean)"><!-- --></A><H3>\r
 250 parse</H3>\r
 251 <PRE>\r
 252 protected org.w3c.dom.Document <B>parse</B>(org.xml.sax.InputSource&nbsp;source,
 253                                      boolean&nbsp;validate)
 254                               throws javax.speech.synthesis.JSMLException,
 255                                      java.io.IOException</PRE>\r
 256 <DL>\r
 257 <DD>Parses the source and optionally validates it.\r
 258 <P>\r
 259 <DD><DL>\r
 260 <DT><B>Parameters:</B><DD><CODE>source</CODE> - the JSML text<DD><CODE>validate</CODE> - if <code>true</code>, validate the JSML text
 261 <DT><B>Throws:</B>
 262 <DD><CODE>javax.speech.synthesis.JSMLException</CODE> - if the JSML text contains errors
 263 <DD><CODE>java.io.IOException</CODE> - if problems encountered with <code>source</code></DL>\r
 264 </DD>\r
 265 </DL>\r
 266 <!-- ========= END OF CLASS DATA ========= -->\r
 267 <HR>\r
 268 \r
 269
 270 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 271 <A NAME="navbar_bottom"><!-- --></A>
 272 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 273 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 274 <TR>\r
 275 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 276 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 277 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 278   <TR ALIGN="center" VALIGN="top">\r
 279   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 280   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 281   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 282   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 283   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 284   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 285   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 286   </TR>\r
 287 </TABLE>\r
 288 </TD>\r
 289 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 290 </EM>\r
 291 </TD>\r
 292 </TR>\r
 293 \r
 294 <TR>\r
 295 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 296 &nbsp;<A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis"><B>PREV CLASS</B></A>&nbsp;\r
 297 &nbsp;<A HREF="../../../../../com/sun/speech/engine/synthesis/SynthesizerMonitor.html" title="class in com.sun.speech.engine.synthesis"><B>NEXT CLASS</B></A></FONT></TD>\r
 298 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 299   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 300 &nbsp;<A HREF="JSMLParser.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 301 &nbsp;<SCRIPT type="text/javascript">\r
 302   <!--\r
 303   if(window==top) {\r
 304     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 305   }\r
 306   //-->\r
 307 </SCRIPT>\r
 308 <NOSCRIPT>\r
 309   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 310 </NOSCRIPT>
 311 \r
 312 </FONT></TD>\r
 313 </TR>\r
 314 <TR>\r
 315 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 316   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
 317 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 318 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 319 </TR>\r
 320 </TABLE>\r
 321 <A NAME="skip-navbar_bottom"></A>
 322 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 323 \r
 324 <HR>\r
 325 \r
 326 </BODY>\r
 327 </HTML>\r