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 VoiceDirectory (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.VoiceDirectory 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="VoiceDirectory (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/Voice.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/VoiceManager.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>
\r
56 <A HREF="VoiceDirectory.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.freetts</FONT>
\r
86 Class VoiceDirectory</H2>
\r
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.VoiceDirectory</B>
\r
92 <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../de/dfki/lt/freetts/en/us/MbrolaVoiceDirectory.html" title="class in de.dfki.lt.freetts.en.us">MbrolaVoiceDirectory</A></DD>
\r
96 <DT>public abstract class <B>VoiceDirectory</B><DT>extends java.lang.Object</DL>
\r
99 Provides a means to access the voices that are stored in a jar
100 file. Every jar file that provides a voice must contain a subclass
101 of VoiceDirectory. The class must provide a main() function that
102 calls dumpVoices() or performs an equivalent operation. All
103 subclasses of VoiceDirectory can be assumed to always be created by
104 the default constructor (no arguments).
106 Any jar file that has a subclass of VoiceDirectory must define
107 certain attributes in its Manifest. "Main-class:" must refer to
108 the subclass of VoiceDirectory. "Class-Path:" lists the other jar
109 files upon which this is dependent. For example,
110 "cmu_us_kal.jar" may be dependent on "en_us.jar" for its lexicon.
111 The Manifest must also have a "FreeTTSVoiceDefinition: true" entry.
\r
116 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts"><CODE>Voice</CODE></A>,
117 <A HREF="../../../../com/sun/speech/freetts/VoiceManager.html" title="class in com.sun.speech.freetts"><CODE>VoiceManager</CODE></A></DL>
\r
121 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
124 <!-- =========== FIELD SUMMARY =========== -->
\r
127 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
129 <A NAME="constructor_summary"><!-- --></A>
130 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
131 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
132 <TD COLSPAN=2><FONT SIZE="+2">
\r
133 <B>Constructor Summary</B></FONT></TD>
\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
136 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#VoiceDirectory()">VoiceDirectory</A></B>()</CODE>
\r
139 Default constructor does nothing. </TD>
\r
143 <!-- ========== METHOD SUMMARY =========== -->
\r
145 <A NAME="method_summary"><!-- --></A>
146 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
147 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
148 <TD COLSPAN=2><FONT SIZE="+2">
\r
149 <B>Method Summary</B></FONT></TD>
\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
153 <CODE>abstract <A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A>[]</CODE></FONT></TD>
\r
154 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#getVoices()">getVoices</A></B>()</CODE>
\r
157 Provide a means to access the voices in a voice jar file. </TD>
\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
161 <CODE>static void</CODE></FONT></TD>
\r
162 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE>
\r
165 The main function must be implemented by subclasses to print
166 out information about provided voices. </TD>
\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
170 <CODE> java.lang.String</CODE></FONT></TD>
\r
171 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#toString()">toString</A></B>()</CODE>
\r
174 Print the information about voices contained in this voice
175 directory to a String.</TD>
\r
178 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
179 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
180 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
181 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
183 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
184 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
190 <!-- ============ FIELD DETAIL =========== -->
\r
193 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
195 <A NAME="constructor_detail"><!-- --></A>
196 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
197 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
198 <TD COLSPAN=1><FONT SIZE="+2">
\r
199 <B>Constructor Detail</B></FONT></TD>
\r
203 <A NAME="VoiceDirectory()"><!-- --></A><H3>
\r
204 VoiceDirectory</H3>
\r
206 public <B>VoiceDirectory</B>()</PRE>
\r
208 <DD>Default constructor does nothing. This may be overridden by
209 subclasses, but it is not recommended. This is the only
210 constructor that will be called.
\r
214 <!-- ============ METHOD DETAIL ========== -->
\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
224 <A NAME="getVoices()"><!-- --></A><H3>
\r
227 public abstract <A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts">Voice</A>[] <B>getVoices</B>()</PRE>
\r
229 <DD>Provide a means to access the voices in a voice jar file. The
230 implementation of this function is up to the subclasses.
\r
234 <DT><B>Returns:</B><DD>an array of Voice instances provided in the jar file</DL>
\r
239 <A NAME="toString()"><!-- --></A><H3>
\r
242 public java.lang.String <B>toString</B>()</PRE>
\r
244 <DD>Print the information about voices contained in this voice
245 directory to a String.
\r
249 <DT><B>Returns:</B><DD>a String containing the information<DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#main(java.lang.String[])"><CODE>main(String[] args)</CODE></A></DL>
\r
254 <A NAME="main(java.lang.String[])"><!-- --></A><H3>
\r
257 public static void <B>main</B>(java.lang.String[] args)</PRE>
\r
259 <DD>The main function must be implemented by subclasses to print
260 out information about provided voices. For example, they may
261 just call dumpVoices()
\r
264 <DT><B>See Also:</B><DD><A HREF="../../../../com/sun/speech/freetts/VoiceDirectory.html#toString()"><CODE>toString()</CODE></A></DL>
\r
267 <!-- ========= END OF CLASS DATA ========= -->
\r
271 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
272 <A NAME="navbar_bottom"><!-- --></A>
273 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
274 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
276 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
277 <A NAME="navbar_bottom_firstrow"><!-- --></A>
278 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
279 <TR ALIGN="center" VALIGN="top">
\r
280 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
281 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
282 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
284 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
286 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
290 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
296 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
297 <A HREF="../../../../com/sun/speech/freetts/Voice.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
298 <A HREF="../../../../com/sun/speech/freetts/VoiceManager.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
299 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
300 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
301 <A HREF="VoiceDirectory.html" target="_top"><B>NO FRAMES</B></A>
\r
302 <SCRIPT type="text/javascript">
\r
305 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
310 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
316 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
317 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
318 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
319 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
322 <A NAME="skip-navbar_bottom"></A>
323 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r