upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / clunits / ClusterUnitDatabase.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 ClusterUnitDatabase (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.clunits.ClusterUnitDatabase 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="ClusterUnitDatabase (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;PREV CLASS&nbsp;\r
53 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/clunits/ClusterUnitPitchmarkGenerator.html" title="class in com.sun.speech.freetts.clunits"><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="ClusterUnitDatabase.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;CONSTR&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;CONSTR&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.clunits</FONT>\r
85 <BR>\r
86 Class ClusterUnitDatabase</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.clunits.ClusterUnitDatabase</B>\r
90 </PRE>\r
91 <HR>\r
92 <DL>\r
93 <DT>public class <B>ClusterUnitDatabase</B><DT>extends java.lang.Object</DL>\r
94 \r
95 <P>\r
96 Provides support for the cluster unit database. The use of the
97  cluster unit database is confined to this clunits package. This
98  class provides a main program that can be used to convert from a
99  text version of the database to a binary version of the database.
100
101  The ClusterUnitDataBase can be loaded from a text or a binary
102  source. The binary form of the database loads much faster and
103  therefore is generally used in a deployed system.\r
104 <P>\r
105 \r
106 <P>\r
107 <HR>\r
108 \r
109 <P>\r
110 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
111 \r
112 \r
113 <!-- =========== FIELD SUMMARY =========== -->\r
114 \r
115 \r
116 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
117 \r
118 \r
119 <!-- ========== METHOD SUMMARY =========== -->\r
120 \r
121 <A NAME="method_summary"><!-- --></A>
122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
124 <TD COLSPAN=2><FONT SIZE="+2">\r
125 <B>Method Summary</B></FONT></TD>\r
126 </TR>\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">\r
128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
129 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
130 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/clunits/ClusterUnitDatabase.html#compare(com.sun.speech.freetts.clunits.ClusterUnitDatabase)">compare</A></B>(<A HREF="../../../../../com/sun/speech/freetts/clunits/ClusterUnitDatabase.html" title="class in com.sun.speech.freetts.clunits">ClusterUnitDatabase</A>&nbsp;other)</CODE>\r
131 \r
132 <BR>\r
133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if two databases are identical.</TD>\r
134 </TR>\r
135 <TR BGCOLOR="white" CLASS="TableRowColor">\r
136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
137 <CODE>static&nbsp;void</CODE></FONT></TD>\r
138 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/clunits/ClusterUnitDatabase.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>\r
139 \r
140 <BR>\r
141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Manipulates a ClusterUnitDatabase.  
142
143  </TD>\r
144 </TR>\r
145 </TABLE>\r
146 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
147 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
148 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
149 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
150 </TR>\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">\r
152 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
153 </TR>\r
154 </TABLE>\r
155 &nbsp;\r
156 <P>\r
157 \r
158 <!-- ============ FIELD DETAIL =========== -->\r
159 \r
160 \r
161 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
162 \r
163 \r
164 <!-- ============ METHOD DETAIL ========== -->\r
165 \r
166 <A NAME="method_detail"><!-- --></A>
167 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
168 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
169 <TD COLSPAN=1><FONT SIZE="+2">\r
170 <B>Method Detail</B></FONT></TD>\r
171 </TR>\r
172 </TABLE>\r
173 \r
174 <A NAME="compare(com.sun.speech.freetts.clunits.ClusterUnitDatabase)"><!-- --></A><H3>\r
175 compare</H3>\r
176 <PRE>\r
177 public boolean <B>compare</B>(<A HREF="../../../../../com/sun/speech/freetts/clunits/ClusterUnitDatabase.html" title="class in com.sun.speech.freetts.clunits">ClusterUnitDatabase</A>&nbsp;other)</PRE>\r
178 <DL>\r
179 <DD>Determines if two databases are identical.\r
180 <P>\r
181 <DD><DL>\r
182 <DT><B>Parameters:</B><DD><CODE>other</CODE> - the database to compare this one to
183 <DT><B>Returns:</B><DD>true if the databases are identical</DL>\r
184 </DD>\r
185 </DL>\r
186 <HR>\r
187 \r
188 <A NAME="main(java.lang.String[])"><!-- --></A><H3>\r
189 main</H3>\r
190 <PRE>\r
191 public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>\r
192 <DL>\r
193 <DD>Manipulates a ClusterUnitDatabase.  
194
195  <p>
196  <b> Usage </b>
197  <p>
198   <code> java com.sun.speech.freetts.clunits.ClusterUnitDatabase
199   [options]</code> 
200  <p>
201  <b> Options </b>
202  <p>
203     <ul>
204           <li> <code> -src path </code> provides a directory
205           path to the source text for the database
206           <li> <code> -dest path </code> provides a directory
207           for where to place the resulting binaries
208                 <li> <code> -generate_binary [filename]</code> reads
209                 in the text version of the database and generates
210                 the binary version of the database.
211                 <li> <code> -compare </code>  Loads the text and
212                 binary versions of the database and compares them to
213                 see if they are equivalent.
214                 <li> <code> -showTimes </code> shows timings for any
215                 loading, comparing or dumping operation
216     </ul>\r
217 <P>\r
218 <DD><DL>\r
219 </DL>\r
220 </DD>\r
221 </DL>\r
222 <!-- ========= END OF CLASS DATA ========= -->\r
223 <HR>\r
224 \r
225
226 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
227 <A NAME="navbar_bottom"><!-- --></A>
228 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
229 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
230 <TR>\r
231 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
232 <A NAME="navbar_bottom_firstrow"><!-- --></A>
233 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
234   <TR ALIGN="center" VALIGN="top">\r
235   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
236   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
237   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
238   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
239   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
240   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
241   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
242   </TR>\r
243 </TABLE>\r
244 </TD>\r
245 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
246 </EM>\r
247 </TD>\r
248 </TR>\r
249 \r
250 <TR>\r
251 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
252 &nbsp;PREV CLASS&nbsp;\r
253 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/clunits/ClusterUnitPitchmarkGenerator.html" title="class in com.sun.speech.freetts.clunits"><B>NEXT CLASS</B></A></FONT></TD>\r
254 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
255   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
256 &nbsp;<A HREF="ClusterUnitDatabase.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
257 &nbsp;<SCRIPT type="text/javascript">\r
258   <!--\r
259   if(window==top) {\r
260     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
261   }\r
262   //-->\r
263 </SCRIPT>\r
264 <NOSCRIPT>\r
265   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
266 </NOSCRIPT>
267 \r
268 </FONT></TD>\r
269 </TR>\r
270 <TR>\r
271 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
272   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
273 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
274 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
275 </TR>\r
276 </TABLE>\r
277 <A NAME="skip-navbar_bottom"></A>
278 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
279 \r
280 <HR>\r
281 \r
282 </BODY>\r
283 </HTML>\r