upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / PhoneSetImpl.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 PhoneSetImpl (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.PhoneSetImpl 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="PhoneSetImpl (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/freetts/PhoneDurationsImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class 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>  &nbsp;\r
56 &nbsp;<A HREF="PhoneSetImpl.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.freetts</FONT>\r
85 <BR>\r
86 Class PhoneSetImpl</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.PhoneSetImpl</B>\r
90 </PRE>\r
91 <DL>\r
92 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/sun/speech/freetts/PhoneSet.html" title="interface in com.sun.speech.freetts">PhoneSet</A></DD>\r
93 </DL>\r
94 <HR>\r
95 <DL>\r
96 <DT>public class <B>PhoneSetImpl</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/sun/speech/freetts/PhoneSet.html" title="interface in com.sun.speech.freetts">PhoneSet</A></DL>\r
97 \r
98 <P>\r
99 Implementation of a <code>PhoneSet</code> that reads the info from
100  a file.  The format of the file is as follows:
101
102  <pre>
103  phone feature value
104  phone feature value
105  phone feature value
106  ...
107  </pre>
108
109  Where <code>phone</code> is the phone name, <code>feature</code> is
110  the phone feature such as "vc," "vlng," "vheight," and so on, and
111  "value" is the value of the feature.  There can be multiple lines
112  for the same phone to describe various features of that phone.\r
113 <P>\r
114 \r
115 <P>\r
116 <HR>\r
117 \r
118 <P>\r
119 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
120 \r
121 \r
122 <!-- =========== FIELD SUMMARY =========== -->\r
123 \r
124 <A NAME="field_summary"><!-- --></A>
125 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
126 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
127 <TD COLSPAN=2><FONT SIZE="+2">\r
128 <B>Field Summary</B></FONT></TD>\r
129 </TR>\r
130 </TABLE>\r
131 &nbsp;<A NAME="fields_inherited_from_class_com.sun.speech.freetts.PhoneSet"><!-- --></A>
132 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
133 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
134 <TD><B>Fields inherited from interface com.sun.speech.freetts.<A HREF="../../../../com/sun/speech/freetts/PhoneSet.html" title="interface in com.sun.speech.freetts">PhoneSet</A></B></TD>\r
135 </TR>\r
136 <TR BGCOLOR="white" CLASS="TableRowColor">\r
137 <TD><CODE><A HREF="../../../../com/sun/speech/freetts/PhoneSet.html#CPLACE">CPLACE</A>, <A HREF="../../../../com/sun/speech/freetts/PhoneSet.html#CTYPE">CTYPE</A>, <A HREF="../../../../com/sun/speech/freetts/PhoneSet.html#CVOX">CVOX</A>, <A HREF="../../../../com/sun/speech/freetts/PhoneSet.html#VC">VC</A>, <A HREF="../../../../com/sun/speech/freetts/PhoneSet.html#VFRONT">VFRONT</A>, <A HREF="../../../../com/sun/speech/freetts/PhoneSet.html#VHEIGHT">VHEIGHT</A>, <A HREF="../../../../com/sun/speech/freetts/PhoneSet.html#VLNG">VLNG</A>, <A HREF="../../../../com/sun/speech/freetts/PhoneSet.html#VRND">VRND</A></CODE></TD>\r
138 </TR>\r
139 </TABLE>\r
140 &nbsp;\r
141 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
142 \r
143 <A NAME="constructor_summary"><!-- --></A>
144 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
145 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
146 <TD COLSPAN=2><FONT SIZE="+2">\r
147 <B>Constructor Summary</B></FONT></TD>\r
148 </TR>\r
149 <TR BGCOLOR="white" CLASS="TableRowColor">\r
150 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PhoneSetImpl.html#PhoneSetImpl(java.net.URL)">PhoneSetImpl</A></B>(java.net.URL&nbsp;url)</CODE>\r
151 \r
152 <BR>\r
153 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new <code>PhoneSetImpl</code> by reading from the
154  given URL.</TD>\r
155 </TR>\r
156 </TABLE>\r
157 &nbsp;\r
158 <!-- ========== METHOD SUMMARY =========== -->\r
159 \r
160 <A NAME="method_summary"><!-- --></A>
161 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
162 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
163 <TD COLSPAN=2><FONT SIZE="+2">\r
164 <B>Method Summary</B></FONT></TD>\r
165 </TR>\r
166 <TR BGCOLOR="white" CLASS="TableRowColor">\r
167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
168 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
169 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PhoneSetImpl.html#getPhoneFeature(java.lang.String, java.lang.String)">getPhoneFeature</A></B>(java.lang.String&nbsp;phone,
170                 java.lang.String&nbsp;featureName)</CODE>\r
171 \r
172 <BR>\r
173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given a phoneme and a feature name, returns the feature.</TD>\r
174 </TR>\r
175 </TABLE>\r
176 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
177 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
178 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
179 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
180 </TR>\r
181 <TR BGCOLOR="white" CLASS="TableRowColor">\r
182 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
183 </TR>\r
184 </TABLE>\r
185 &nbsp;\r
186 <P>\r
187 \r
188 <!-- ============ FIELD DETAIL =========== -->\r
189 \r
190 \r
191 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
192 \r
193 <A NAME="constructor_detail"><!-- --></A>
194 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
195 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
196 <TD COLSPAN=1><FONT SIZE="+2">\r
197 <B>Constructor Detail</B></FONT></TD>\r
198 </TR>\r
199 </TABLE>\r
200 \r
201 <A NAME="PhoneSetImpl(java.net.URL)"><!-- --></A><H3>\r
202 PhoneSetImpl</H3>\r
203 <PRE>\r
204 public <B>PhoneSetImpl</B>(java.net.URL&nbsp;url)
205              throws java.io.IOException</PRE>\r
206 <DL>\r
207 <DD>Create a new <code>PhoneSetImpl</code> by reading from the
208  given URL.\r
209 <P>\r
210 <DT><B>Parameters:</B><DD><CODE>url</CODE> - the input source
211 <DT><B>Throws:</B>
212 <DD><CODE>java.io.IOException</CODE> - if an error occurs</DL>\r
213 \r
214 <!-- ============ METHOD DETAIL ========== -->\r
215 \r
216 <A NAME="method_detail"><!-- --></A>
217 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
218 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
219 <TD COLSPAN=1><FONT SIZE="+2">\r
220 <B>Method Detail</B></FONT></TD>\r
221 </TR>\r
222 </TABLE>\r
223 \r
224 <A NAME="getPhoneFeature(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
225 getPhoneFeature</H3>\r
226 <PRE>\r
227 public java.lang.String <B>getPhoneFeature</B>(java.lang.String&nbsp;phone,
228                                         java.lang.String&nbsp;featureName)</PRE>\r
229 <DL>\r
230 <DD>Given a phoneme and a feature name, returns the feature.\r
231 <P>\r
232 <DD><DL>\r
233 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/PhoneSet.html#getPhoneFeature(java.lang.String, java.lang.String)">getPhoneFeature</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/PhoneSet.html" title="interface in com.sun.speech.freetts">PhoneSet</A></CODE></DL>\r
234 </DD>\r
235 <DD><DL>\r
236 <DT><B>Parameters:</B><DD><CODE>phone</CODE> - the phoneme of interest<DD><CODE>featureName</CODE> - the name of the feature of interest
237 <DT><B>Returns:</B><DD>the feature with the given name</DL>\r
238 </DD>\r
239 </DL>\r
240 <!-- ========= END OF CLASS DATA ========= -->\r
241 <HR>\r
242 \r
243
244 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
245 <A NAME="navbar_bottom"><!-- --></A>
246 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
247 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
248 <TR>\r
249 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
250 <A NAME="navbar_bottom_firstrow"><!-- --></A>
251 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
252   <TR ALIGN="center" VALIGN="top">\r
253   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
254   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
255   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
256   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
257   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
258   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
259   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
260   </TR>\r
261 </TABLE>\r
262 </TD>\r
263 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
264 </EM>\r
265 </TD>\r
266 </TR>\r
267 \r
268 <TR>\r
269 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
270 &nbsp;<A HREF="../../../../com/sun/speech/freetts/PhoneDurationsImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
271 &nbsp;<A HREF="../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
272 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
273   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
274 &nbsp;<A HREF="PhoneSetImpl.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
275 &nbsp;<SCRIPT type="text/javascript">\r
276   <!--\r
277   if(window==top) {\r
278     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
279   }\r
280   //-->\r
281 </SCRIPT>\r
282 <NOSCRIPT>\r
283   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
284 </NOSCRIPT>
285 \r
286 </FONT></TD>\r
287 </TR>\r
288 <TR>\r
289 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
290   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
291 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
292 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
293 </TR>\r
294 </TABLE>\r
295 <A NAME="skip-navbar_bottom"></A>
296 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
297 \r
298 <HR>\r
299 \r
300 </BODY>\r
301 </HTML>\r