1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.4.2_16) on Mon Mar 09 18:20:29 CET 2009 -->
\r
7 JSMLParser (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.engine.synthesis.JSMLParser class">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 parent.document.title="JSMLParser (FreeTTS 1.2)";
\r
23 <BODY BGCOLOR="white" onload="windowTitle();">
\r
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
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> </TD>
\r
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
45 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
51 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
52 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis"><B>PREV CLASS</B></A>
\r
53 <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>
\r
56 <A HREF="JSMLParser.html" target="_top"><B>NO FRAMES</B></A>
\r
57 <SCRIPT type="text/javascript">
\r
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
71 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
72 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
77 <A NAME="skip-navbar_top"></A>
78 <!-- ========= END OF TOP NAVBAR ========= -->
\r
81 <!-- ======== START OF CLASS DATA ======== -->
\r
84 com.sun.speech.engine.synthesis</FONT>
\r
86 Class JSMLParser</H2>
\r
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.engine.synthesis.JSMLParser</B>
\r
93 <DT>public class <B>JSMLParser</B><DT>extends java.lang.Object</DL>
\r
96 Parses a JSML 0.6 document and returns a DOM.
\r
103 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
106 <!-- =========== FIELD SUMMARY =========== -->
\r
109 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\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
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 jsmlText,
119 boolean validate)</CODE>
\r
122 Creates a new JSMLParser for the given JSML
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 jsmlSource,
127 boolean validate)</CODE>
\r
130 Creates a new JSMLParser for the given <code>URL</code>.
135 <!-- ========== METHOD SUMMARY =========== -->
\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
143 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
145 <CODE> 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
149 Gets the document for this parser.</TD>
\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
153 <CODE>protected 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 source,
155 boolean validate)</CODE>
\r
158 Parses the source and optionally validates it.</TD>
\r
161 <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
166 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
167 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
\r
173 <!-- ============ FIELD DETAIL =========== -->
\r
176 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\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
186 <A NAME="JSMLParser(java.lang.String, boolean)"><!-- --></A><H3>
\r
189 public <B>JSMLParser</B>(java.lang.String jsmlText,
190 boolean validate)
191 throws javax.speech.synthesis.JSMLException</PRE>
\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
200 <DT><B>Parameters:</B><DD><CODE>jsmlText</CODE> - the JSML text<DD><CODE>validate</CODE> - if <code>true</code>, validate the JSML text
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
205 <A NAME="JSMLParser(java.net.URL, boolean)"><!-- --></A><H3>
\r
208 public <B>JSMLParser</B>(java.net.URL jsmlSource,
209 boolean validate)
210 throws javax.speech.synthesis.JSMLException,
211 java.io.IOException</PRE>
\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
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
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
225 <!-- ============ METHOD DETAIL ========== -->
\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
235 <A NAME="getDocument()"><!-- --></A><H3>
\r
238 public org.w3c.dom.Document <B>getDocument</B>()</PRE>
\r
240 <DD>Gets the document for this parser.
\r
244 <DT><B>Returns:</B><DD>a DOM</DL>
\r
249 <A NAME="parse(org.xml.sax.InputSource, boolean)"><!-- --></A><H3>
\r
252 protected org.w3c.dom.Document <B>parse</B>(org.xml.sax.InputSource source,
253 boolean validate)
254 throws javax.speech.synthesis.JSMLException,
255 java.io.IOException</PRE>
\r
257 <DD>Parses the source and optionally validates it.
\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
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
266 <!-- ========= END OF CLASS DATA ========= -->
\r
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
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> </TD>
\r
280 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
281 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
282 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
284 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
289 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
295 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
296 <A HREF="../../../../../com/sun/speech/engine/synthesis/BaseVoice.html" title="class in com.sun.speech.engine.synthesis"><B>PREV CLASS</B></A>
\r
297 <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>
\r
300 <A HREF="JSMLParser.html" target="_top"><B>NO FRAMES</B></A>
\r
301 <SCRIPT type="text/javascript">
\r
304 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
309 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
315 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
316 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
317 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
318 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
321 <A NAME="skip-navbar_bottom"></A>
322 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r