upstream version 1.2.2
[debian/freetts] / javadoc / com / sun / speech / freetts / PathExtractor.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 PathExtractor (FreeTTS 1.2)\r
8 </TITLE>\r
9 \r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.PathExtractor interface">\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="PathExtractor (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/PartOfSpeech.html" title="interface in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
53 &nbsp;<A HREF="../../../../com/sun/speech/freetts/PhoneDurations.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>  &nbsp;\r
56 &nbsp;<A HREF="PathExtractor.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</FONT>\r
85 <BR>\r
86 Interface PathExtractor</H2>\r
87 <DL>\r
88 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/sun/speech/freetts/PathExtractorImpl.html" title="class in com.sun.speech.freetts">PathExtractorImpl</A></DD>\r
89 </DL>\r
90 <HR>\r
91 <DL>\r
92 <DT>public interface <B>PathExtractor</B></DL>\r
93 \r
94 <P>\r
95 Manages a feature or item path. Allows navigation
96  to the corresponding feature or item.\r
97 <P>\r
98 \r
99 <P>\r
100 <HR>\r
101 \r
102 <P>\r
103 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
104 \r
105 \r
106 <!-- =========== FIELD SUMMARY =========== -->\r
107 \r
108 \r
109 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
110 \r
111 \r
112 <!-- ========== METHOD SUMMARY =========== -->\r
113 \r
114 <A NAME="method_summary"><!-- --></A>
115 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
116 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
117 <TD COLSPAN=2><FONT SIZE="+2">\r
118 <B>Method Summary</B></FONT></TD>\r
119 </TR>\r
120 <TR BGCOLOR="white" CLASS="TableRowColor">\r
121 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
122 <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>\r
123 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PathExtractor.html#findFeature(com.sun.speech.freetts.Item)">findFeature</A></B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A>&nbsp;item)</CODE>\r
124 \r
125 <BR>\r
126 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Finds the feature associated with this object.</TD>\r
127 </TR>\r
128 <TR BGCOLOR="white" CLASS="TableRowColor">\r
129 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
130 <CODE>&nbsp;<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>\r
131 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PathExtractor.html#findItem(com.sun.speech.freetts.Item)">findItem</A></B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A>&nbsp;item)</CODE>\r
132 \r
133 <BR>\r
134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Finds the item associated with this object.</TD>\r
135 </TR>\r
136 </TABLE>\r
137 &nbsp;\r
138 <P>\r
139 \r
140 <!-- ============ FIELD DETAIL =========== -->\r
141 \r
142 \r
143 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
144 \r
145 \r
146 <!-- ============ METHOD DETAIL ========== -->\r
147 \r
148 <A NAME="method_detail"><!-- --></A>
149 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
150 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
151 <TD COLSPAN=1><FONT SIZE="+2">\r
152 <B>Method Detail</B></FONT></TD>\r
153 </TR>\r
154 </TABLE>\r
155 \r
156 <A NAME="findItem(com.sun.speech.freetts.Item)"><!-- --></A><H3>\r
157 findItem</H3>\r
158 <PRE>\r
159 public <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> <B>findItem</B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A>&nbsp;item)</PRE>\r
160 <DL>\r
161 <DD>Finds the item associated with this object.\r
162 <P>\r
163 <DD><DL>\r
164 <DT><B>Parameters:</B><DD><CODE>item</CODE> - the starting point for the path navigation
165 <DT><B>Returns:</B><DD>the item associated with the path or null</DL>\r
166 </DD>\r
167 </DL>\r
168 <HR>\r
169 \r
170 <A NAME="findFeature(com.sun.speech.freetts.Item)"><!-- --></A><H3>\r
171 findFeature</H3>\r
172 <PRE>\r
173 public java.lang.Object <B>findFeature</B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A>&nbsp;item)</PRE>\r
174 <DL>\r
175 <DD>Finds the feature associated with this object.\r
176 <P>\r
177 <DD><DL>\r
178 <DT><B>Parameters:</B><DD><CODE>item</CODE> - the starting point for the path navigation
179 <DT><B>Returns:</B><DD>the feature associated or "0"  if the
180    feature was not found</DL>\r
181 </DD>\r
182 </DL>\r
183 <!-- ========= END OF CLASS DATA ========= -->\r
184 <HR>\r
185 \r
186
187 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
188 <A NAME="navbar_bottom"><!-- --></A>
189 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
190 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
191 <TR>\r
192 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
193 <A NAME="navbar_bottom_firstrow"><!-- --></A>
194 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
195   <TR ALIGN="center" VALIGN="top">\r
196   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
197   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
198   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
199   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
200   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
201   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
202   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
203   </TR>\r
204 </TABLE>\r
205 </TD>\r
206 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
207 </EM>\r
208 </TD>\r
209 </TR>\r
210 \r
211 <TR>\r
212 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
213 &nbsp;<A HREF="../../../../com/sun/speech/freetts/PartOfSpeech.html" title="interface in com.sun.speech.freetts"><B>PREV CLASS</B></A>&nbsp;\r
214 &nbsp;<A HREF="../../../../com/sun/speech/freetts/PhoneDurations.html" title="interface in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>\r
215 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
216   <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
217 &nbsp;<A HREF="PathExtractor.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
218 &nbsp;<SCRIPT type="text/javascript">\r
219   <!--\r
220   if(window==top) {\r
221     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
222   }\r
223   //-->\r
224 </SCRIPT>\r
225 <NOSCRIPT>\r
226   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
227 </NOSCRIPT>
228 \r
229 </FONT></TD>\r
230 </TR>\r
231 <TR>\r
232 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
233   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
234 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
235 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
236 </TR>\r
237 </TABLE>\r
238 <A NAME="skip-navbar_bottom"></A>
239 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
240 \r
241 <HR>\r
242 \r
243 </BODY>\r
244 </HTML>\r