upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / util / SegmentRelationUtils.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:30 CET 2009 -->\r
6 <TITLE>\r
7 SegmentRelationUtils (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.util.SegmentRelationUtils 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="SegmentRelationUtils (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/util/BulkTimer.html" title="class in com.sun.speech.freetts.util"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/util/Timer.html" title="class in com.sun.speech.freetts.util"><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="SegmentRelationUtils.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.util</FONT>\r
85 <BR>\r
86 Class SegmentRelationUtils</H2>\r
87 <PRE>\r
88 java.lang.Object\r
89   <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.util.SegmentRelationUtils</B>\r
90 </PRE>\r
91 <HR>\r
92 <DL>\r
93 <DT>public class <B>SegmentRelationUtils</B><DT>extends java.lang.Object</DL>\r
94 \r
95 <P>\r
96 Provides a set of utilities for the SegmentRelation. A 
97  SegmentRelation is a Relation, but has
98  features specific to Segments.\r
99 <P>\r
100 \r
101 <P>\r
102 <HR>\r
103 \r
104 <P>\r
105 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
106 \r
107 \r
108 <!-- =========== FIELD SUMMARY =========== -->\r
109 \r
110 \r
111 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
112 \r
113 <A NAME="constructor_summary"><!-- --></A>
114 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
115 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
116 <TD COLSPAN=2><FONT SIZE="+2">\r
117 <B>Constructor Summary</B></FONT></TD>\r
118 </TR>\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">\r
120 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/SegmentRelationUtils.html#SegmentRelationUtils()">SegmentRelationUtils</A></B>()</CODE>\r
121 \r
122 <BR>\r
123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
124 </TR>\r
125 </TABLE>\r
126 &nbsp;\r
127 <!-- ========== METHOD SUMMARY =========== -->\r
128 \r
129 <A NAME="method_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>Method Summary</B></FONT></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;<A HREF="../../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>\r
138 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/SegmentRelationUtils.html#findFromEnd(com.sun.speech.freetts.Relation, float)">findFromEnd</A></B>(<A HREF="../../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A>&nbsp;segmentRelation,
139             float&nbsp;time)</CODE>\r
140 \r
141 <BR>\r
142 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starting from the end of the given Segment Relation, go backwards
143  to find the Item that corresponds to the given time.</TD>\r
144 </TR>\r
145 <TR BGCOLOR="white" CLASS="TableRowColor">\r
146 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
147 <CODE>static&nbsp;<A HREF="../../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>\r
148 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/SegmentRelationUtils.html#findFromFront(com.sun.speech.freetts.Relation, float)">findFromFront</A></B>(<A HREF="../../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A>&nbsp;segmentRelation,
149               float&nbsp;time)</CODE>\r
150 \r
151 <BR>\r
152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starting from the front of the given Segment Relation, finds the Item
153  that corresponds to the given time.</TD>\r
154 </TR>\r
155 <TR BGCOLOR="white" CLASS="TableRowColor">\r
156 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
157 <CODE>static&nbsp;<A HREF="../../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>\r
158 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/SegmentRelationUtils.html#getItem(com.sun.speech.freetts.Relation, float)">getItem</A></B>(<A HREF="../../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A>&nbsp;segmentRelation,
159         float&nbsp;time)</CODE>\r
160 \r
161 <BR>\r
162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Item in the Segment Relation that corresponds to the given
163  time.</TD>\r
164 </TR>\r
165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
167 <CODE>static&nbsp;float</CODE></FONT></TD>\r
168 <TD><CODE><B><A HREF="../../../../../com/sun/speech/freetts/util/SegmentRelationUtils.html#getSegmentEnd(com.sun.speech.freetts.Item)">getSegmentEnd</A></B>(<A HREF="../../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A>&nbsp;segment)</CODE>\r
169 \r
170 <BR>\r
171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the value of the feature <code>end</code> of
172  the given Segment Item.</TD>\r
173 </TR>\r
174 </TABLE>\r
175 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
176 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
177 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
178 <TD><B>Methods inherited from class java.lang.Object</B></TD>\r
179 </TR>\r
180 <TR BGCOLOR="white" CLASS="TableRowColor">\r
181 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
182 </TR>\r
183 </TABLE>\r
184 &nbsp;\r
185 <P>\r
186 \r
187 <!-- ============ FIELD DETAIL =========== -->\r
188 \r
189 \r
190 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
191 \r
192 <A NAME="constructor_detail"><!-- --></A>
193 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
194 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
195 <TD COLSPAN=1><FONT SIZE="+2">\r
196 <B>Constructor Detail</B></FONT></TD>\r
197 </TR>\r
198 </TABLE>\r
199 \r
200 <A NAME="SegmentRelationUtils()"><!-- --></A><H3>\r
201 SegmentRelationUtils</H3>\r
202 <PRE>\r
203 public <B>SegmentRelationUtils</B>()</PRE>\r
204 <DL>\r
205 </DL>\r
206 \r
207 <!-- ============ METHOD DETAIL ========== -->\r
208 \r
209 <A NAME="method_detail"><!-- --></A>
210 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
211 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
212 <TD COLSPAN=1><FONT SIZE="+2">\r
213 <B>Method Detail</B></FONT></TD>\r
214 </TR>\r
215 </TABLE>\r
216 \r
217 <A NAME="getItem(com.sun.speech.freetts.Relation, float)"><!-- --></A><H3>\r
218 getItem</H3>\r
219 <PRE>\r
220 public static <A HREF="../../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>getItem</B>(<A HREF="../../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A>&nbsp;segmentRelation,
221                            float&nbsp;time)</PRE>\r
222 <DL>\r
223 <DD>Returns the Item in the Segment Relation that corresponds to the given
224  time.\r
225 <P>\r
226 <DD><DL>\r
227 <DT><B>Parameters:</B><DD><CODE>segmentRelation</CODE> - the segmentRelation of interest<DD><CODE>time</CODE> - the time</DL>\r
228 </DD>\r
229 </DL>\r
230 <HR>\r
231 \r
232 <A NAME="getSegmentEnd(com.sun.speech.freetts.Item)"><!-- --></A><H3>\r
233 getSegmentEnd</H3>\r
234 <PRE>\r
235 public static float <B>getSegmentEnd</B>(<A HREF="../../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A>&nbsp;segment)</PRE>\r
236 <DL>\r
237 <DD>Returns the value of the feature <code>end</code> of
238  the given Segment Item.\r
239 <P>\r
240 <DD><DL>\r
241 <DT><B>Parameters:</B><DD><CODE>segment</CODE> - the Segment Item
242 <DT><B>Returns:</B><DD>the <code>end</code> feature of the Segment</DL>\r
243 </DD>\r
244 </DL>\r
245 <HR>\r
246 \r
247 <A NAME="findFromFront(com.sun.speech.freetts.Relation, float)"><!-- --></A><H3>\r
248 findFromFront</H3>\r
249 <PRE>\r
250 public static <A HREF="../../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>findFromFront</B>(<A HREF="../../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A>&nbsp;segmentRelation,
251                                  float&nbsp;time)</PRE>\r
252 <DL>\r
253 <DD>Starting from the front of the given Segment Relation, finds the Item
254  that corresponds to the given time.\r
255 <P>\r
256 <DD><DL>\r
257 <DT><B>Parameters:</B><DD><CODE>segmentRelation</CODE> - the Segment Relation to search<DD><CODE>time</CODE> - the time of the Segment Item
258 <DT><B>Returns:</B><DD>the Segment Item</DL>\r
259 </DD>\r
260 </DL>\r
261 <HR>\r
262 \r
263 <A NAME="findFromEnd(com.sun.speech.freetts.Relation, float)"><!-- --></A><H3>\r
264 findFromEnd</H3>\r
265 <PRE>\r
266 public static <A HREF="../../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>findFromEnd</B>(<A HREF="../../../../../com/sun/speech/freetts/Relation.html" title="class in com.sun.speech.freetts">Relation</A>&nbsp;segmentRelation,
267                                float&nbsp;time)</PRE>\r
268 <DL>\r
269 <DD>Starting from the end of the given Segment Relation, go backwards
270  to find the Item that corresponds to the given time.\r
271 <P>\r
272 <DD><DL>\r
273 <DT><B>Parameters:</B><DD><CODE>segmentRelation</CODE> - the Segment Relation to search<DD><CODE>time</CODE> - the time of the Segment Item
274 <DT><B>Returns:</B><DD>the Segment Item</DL>\r
275 </DD>\r
276 </DL>\r
277 <!-- ========= END OF CLASS DATA ========= -->\r
278 <HR>\r
279 \r
280
281 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
282 <A NAME="navbar_bottom"><!-- --></A>
283 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
284 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
285 <TR>\r
286 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
287 <A NAME="navbar_bottom_firstrow"><!-- --></A>
288 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
289   <TR ALIGN="center" VALIGN="top">\r
290   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
291   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
292   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
293   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
294   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
295   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
296   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
297   </TR>\r
298 </TABLE>\r
299 </TD>\r
300 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
301 </EM>\r
302 </TD>\r
303 </TR>\r
304 \r
305 <TR>\r
306 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
307 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/util/BulkTimer.html" title="class in com.sun.speech.freetts.util"><B>PREV CLASS</B></A>&nbsp;\r
308 &nbsp;<A HREF="../../../../../com/sun/speech/freetts/util/Timer.html" title="class in com.sun.speech.freetts.util"><B>NEXT CLASS</B></A></FONT></TD>\r
309 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
310   <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
311 &nbsp;<A HREF="SegmentRelationUtils.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
312 &nbsp;<SCRIPT type="text/javascript">\r
313   <!--\r
314   if(window==top) {\r
315     document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
316   }\r
317   //-->\r
318 </SCRIPT>\r
319 <NOSCRIPT>\r
320   <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
321 </NOSCRIPT>
322 \r
323 </FONT></TD>\r
324 </TR>\r
325 <TR>\r
326 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
327   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
328 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
329 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
330 </TR>\r
331 </TABLE>\r
332 <A NAME="skip-navbar_bottom"></A>
333 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
334 \r
335 <HR>\r
336 \r
337 </BODY>\r
338 </HTML>\r