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 FeatureSet (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.FeatureSet interface">
\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="FeatureSet (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/freetts/FeatureProcessor.html" title="interface in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts"><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="FeatureSet.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
74 DETAIL: FIELD | CONSTR | <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.freetts</FONT>
\r
86 Interface FeatureSet</H2>
\r
88 <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../com/sun/speech/freetts/Dumpable.html" title="interface in com.sun.speech.freetts">Dumpable</A></DD>
\r
91 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/sun/speech/freetts/FeatureSetImpl.html" title="class in com.sun.speech.freetts">FeatureSetImpl</A>, <A HREF="../../../../com/sun/speech/freetts/Utterance.html" title="class in com.sun.speech.freetts">Utterance</A></DD>
\r
95 <DT>public interface <B>FeatureSet</B><DT>extends <A HREF="../../../../com/sun/speech/freetts/Dumpable.html" title="interface in com.sun.speech.freetts">Dumpable</A></DL>
\r
98 Represents the abstract interface to an entity that has
99 a set of features. Provides interfaces to set and get the name/value
100 pairs as well as providing a set of convenience methods for
101 setting and retrieving values of a particular type.
\r
108 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
111 <!-- =========== FIELD SUMMARY =========== -->
\r
114 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
117 <!-- ========== METHOD SUMMARY =========== -->
\r
119 <A NAME="method_summary"><!-- --></A>
120 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
121 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
122 <TD COLSPAN=2><FONT SIZE="+2">
\r
123 <B>Method Summary</B></FONT></TD>
\r
125 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
126 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
127 <CODE> void</CODE></FONT></TD>
\r
128 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#dump(java.io.PrintWriter, int, java.lang.String)">dump</A></B>(java.io.PrintWriter output,
130 java.lang.String title)</CODE>
\r
133 Dumps the FeatureSet in textual form.</TD>
\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
137 <CODE> float</CODE></FONT></TD>
\r
138 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#getFloat(java.lang.String)">getFloat</A></B>(java.lang.String name)</CODE>
\r
141 Convenience method that returns the named feature as a float.</TD>
\r
143 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
145 <CODE> int</CODE></FONT></TD>
\r
146 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#getInt(java.lang.String)">getInt</A></B>(java.lang.String name)</CODE>
\r
149 Convenience method that returns the named feature as an int.</TD>
\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
153 <CODE> java.lang.Object</CODE></FONT></TD>
\r
154 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#getObject(java.lang.String)">getObject</A></B>(java.lang.String name)</CODE>
\r
157 Returns the named feature as an object.</TD>
\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
161 <CODE> java.lang.String</CODE></FONT></TD>
\r
162 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#getString(java.lang.String)">getString</A></B>(java.lang.String name)</CODE>
\r
165 Convenience method that returns the named feature as a string.</TD>
\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
169 <CODE> boolean</CODE></FONT></TD>
\r
170 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#isPresent(java.lang.String)">isPresent</A></B>(java.lang.String name)</CODE>
\r
173 Determines if the given feature is present.</TD>
\r
175 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
177 <CODE> void</CODE></FONT></TD>
\r
178 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#remove(java.lang.String)">remove</A></B>(java.lang.String name)</CODE>
\r
181 Removes the named feature from this set of features.</TD>
\r
183 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
185 <CODE> void</CODE></FONT></TD>
\r
186 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#setFloat(java.lang.String, float)">setFloat</A></B>(java.lang.String name,
187 float value)</CODE>
\r
190 Convenience method that sets the named feature as a float</TD>
\r
192 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
194 <CODE> void</CODE></FONT></TD>
\r
195 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#setInt(java.lang.String, int)">setInt</A></B>(java.lang.String name,
196 int value)</CODE>
\r
199 Convenience method that sets the named feature as an int.</TD>
\r
201 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
203 <CODE> void</CODE></FONT></TD>
\r
204 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#setObject(java.lang.String, java.lang.Object)">setObject</A></B>(java.lang.String name,
205 java.lang.Object value)</CODE>
\r
208 Sets the named feature .</TD>
\r
210 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
211 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
212 <CODE> void</CODE></FONT></TD>
\r
213 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/FeatureSet.html#setString(java.lang.String, java.lang.String)">setString</A></B>(java.lang.String name,
214 java.lang.String value)</CODE>
\r
217 Convenience method that sets the named feature as a String.</TD>
\r
223 <!-- ============ FIELD DETAIL =========== -->
\r
226 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
229 <!-- ============ METHOD DETAIL ========== -->
\r
231 <A NAME="method_detail"><!-- --></A>
232 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
233 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
234 <TD COLSPAN=1><FONT SIZE="+2">
\r
235 <B>Method Detail</B></FONT></TD>
\r
239 <A NAME="isPresent(java.lang.String)"><!-- --></A><H3>
\r
242 public boolean <B>isPresent</B>(java.lang.String name)</PRE>
\r
244 <DD>Determines if the given feature is present.
\r
250 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature of interest
251 <DT><B>Returns:</B><DD>true if the named feature is present</DL>
\r
256 <A NAME="remove(java.lang.String)"><!-- --></A><H3>
\r
259 public void <B>remove</B>(java.lang.String name)</PRE>
\r
261 <DD>Removes the named feature from this set of features.
\r
267 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature of interest</DL>
\r
272 <A NAME="getString(java.lang.String)"><!-- --></A><H3>
\r
275 public java.lang.String <B>getString</B>(java.lang.String name)</PRE>
\r
277 <DD>Convenience method that returns the named feature as a string.
\r
283 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature
284 <DT><B>Returns:</B><DD>the value associated with the name or null if the value
287 <DD><CODE>java.lang.ClassCastException</CODE> - if theassociated value is not a
293 <A NAME="getInt(java.lang.String)"><!-- --></A><H3>
\r
296 public int <B>getInt</B>(java.lang.String name)</PRE>
\r
298 <DD>Convenience method that returns the named feature as an int.
\r
304 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature
305 <DT><B>Returns:</B><DD>the value associated with the name or null if the value
308 <DD><CODE>java.lang.ClassCastException</CODE> - if the associated value is not an
314 <A NAME="getFloat(java.lang.String)"><!-- --></A><H3>
\r
317 public float <B>getFloat</B>(java.lang.String name)</PRE>
\r
319 <DD>Convenience method that returns the named feature as a float.
\r
325 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature
326 <DT><B>Returns:</B><DD>the value associated with the name or null if the value
329 <DD><CODE>java.lang.ClassCastException</CODE> - if the associated value is not a
335 <A NAME="getObject(java.lang.String)"><!-- --></A><H3>
\r
338 public java.lang.Object <B>getObject</B>(java.lang.String name)</PRE>
\r
340 <DD>Returns the named feature as an object.
\r
346 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature
347 <DT><B>Returns:</B><DD>the value associated with the name or null if the value
353 <A NAME="setInt(java.lang.String, int)"><!-- --></A><H3>
\r
356 public void <B>setInt</B>(java.lang.String name,
357 int value)</PRE>
\r
359 <DD>Convenience method that sets the named feature as an int.
\r
365 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature<DD><CODE>value</CODE> - the value of the feature</DL>
\r
370 <A NAME="setFloat(java.lang.String, float)"><!-- --></A><H3>
\r
373 public void <B>setFloat</B>(java.lang.String name,
374 float value)</PRE>
\r
376 <DD>Convenience method that sets the named feature as a float
\r
382 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature<DD><CODE>value</CODE> - the value of the feature</DL>
\r
387 <A NAME="setString(java.lang.String, java.lang.String)"><!-- --></A><H3>
\r
390 public void <B>setString</B>(java.lang.String name,
391 java.lang.String value)</PRE>
\r
393 <DD>Convenience method that sets the named feature as a String.
\r
399 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature<DD><CODE>value</CODE> - the value of the feature</DL>
\r
404 <A NAME="setObject(java.lang.String, java.lang.Object)"><!-- --></A><H3>
\r
407 public void <B>setObject</B>(java.lang.String name,
408 java.lang.Object value)</PRE>
\r
410 <DD>Sets the named feature .
\r
416 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the feature<DD><CODE>value</CODE> - the value of the feature</DL>
\r
421 <A NAME="dump(java.io.PrintWriter, int, java.lang.String)"><!-- --></A><H3>
\r
424 public void <B>dump</B>(java.io.PrintWriter output,
426 java.lang.String title)</PRE>
\r
428 <DD>Dumps the FeatureSet in textual form.
\r
431 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/Dumpable.html#dump(java.io.PrintWriter, int, java.lang.String)">dump</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/Dumpable.html" title="interface in com.sun.speech.freetts">Dumpable</A></CODE></DL>
\r
434 <DT><B>Parameters:</B><DD><CODE>output</CODE> - where to send the formatted output<DD><CODE>pad</CODE> - the padding<DD><CODE>title</CODE> - the title</DL>
\r
437 <!-- ========= END OF CLASS DATA ========= -->
\r
441 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
442 <A NAME="navbar_bottom"><!-- --></A>
443 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
444 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
446 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
447 <A NAME="navbar_bottom_firstrow"><!-- --></A>
448 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
449 <TR ALIGN="center" VALIGN="top">
\r
450 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
451 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
452 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
453 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
454 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
455 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
456 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
460 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
466 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
467 <A HREF="../../../../com/sun/speech/freetts/FeatureProcessor.html" title="interface in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
468 <A HREF="../../../../com/sun/speech/freetts/FreeTTSSpeakable.html" title="interface in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
469 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
470 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
471 <A HREF="FeatureSet.html" target="_top"><B>NO FRAMES</B></A>
\r
472 <SCRIPT type="text/javascript">
\r
475 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
480 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
486 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
487 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
488 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
489 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
492 <A NAME="skip-navbar_bottom"></A>
493 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r
projects / debian / freetts / blob