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 PathExtractorImpl (FreeTTS 1.2)
\r
10 <META NAME="keywords" CONTENT="com.sun.speech.freetts.PathExtractorImpl 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="PathExtractorImpl (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/PartOfSpeechImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
53 <A HREF="../../../../com/sun/speech/freetts/PhoneDuration.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="PathExtractorImpl.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 | <A HREF="#field_summary">FIELD</A> | <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: <A HREF="#field_detail">FIELD</A> | <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 PathExtractorImpl</H2>
\r
89 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by"><B>com.sun.speech.freetts.PathExtractorImpl</B>
\r
92 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/sun/speech/freetts/PathExtractor.html" title="interface in com.sun.speech.freetts">PathExtractor</A></DD>
\r
96 <DT>public class <B>PathExtractorImpl</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/sun/speech/freetts/PathExtractor.html" title="interface in com.sun.speech.freetts">PathExtractor</A></DL>
\r
99 Interface that Manages a feature or item path. Allows navigation
100 to the corresponding feature or item.
101 This class in controlled by the following system properties:
104 com.sun.speech.freetts.interpretCartPaths - default false
105 com.sun.speech.freetts.lazyCartCompile - default true
107 com.sun.speech.freetts.interpretCartPaths
109 Instances of this class will optionally pre-compile the paths.
110 Pre-compiling paths reduces the processing time and objects needed
111 to extract a feature or an item based upon a path.
\r
118 <!-- ======== NESTED CLASS SUMMARY ======== -->
\r
121 <!-- =========== FIELD SUMMARY =========== -->
\r
123 <A NAME="field_summary"><!-- --></A>
124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
126 <TD COLSPAN=2><FONT SIZE="+2">
\r
127 <B>Field Summary</B></FONT></TD>
\r
129 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
130 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
131 <CODE>static java.lang.String</CODE></FONT></TD>
\r
132 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PathExtractorImpl.html#INTERPRET_PATHS_PROPERTY">INTERPRET_PATHS_PROPERTY</A></B></CODE>
\r
135 If this system property is set to true, paths will
136 not be compiled.</TD>
\r
138 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
139 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
140 <CODE>static java.lang.String</CODE></FONT></TD>
\r
141 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PathExtractorImpl.html#LAZY_COMPILE_PROPERTY">LAZY_COMPILE_PROPERTY</A></B></CODE>
\r
144 If this system property is set to true, CART feature/item
145 paths will only be compiled as needed.</TD>
\r
149 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
151 <A NAME="constructor_summary"><!-- --></A>
152 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
153 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
154 <TD COLSPAN=2><FONT SIZE="+2">
\r
155 <B>Constructor Summary</B></FONT></TD>
\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
158 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PathExtractorImpl.html#PathExtractorImpl(java.lang.String, boolean)">PathExtractorImpl</A></B>(java.lang.String pathAndFeature,
159 boolean wantFeature)</CODE>
\r
162 Creates a path for the given feature.</TD>
\r
166 <!-- ========== METHOD SUMMARY =========== -->
\r
168 <A NAME="method_summary"><!-- --></A>
169 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
170 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
171 <TD COLSPAN=2><FONT SIZE="+2">
\r
172 <B>Method Summary</B></FONT></TD>
\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
176 <CODE> java.lang.Object</CODE></FONT></TD>
\r
177 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PathExtractorImpl.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> item)</CODE>
\r
180 Finds the feature associated with this Path.</TD>
\r
182 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
184 <CODE> <A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A></CODE></FONT></TD>
\r
185 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PathExtractorImpl.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> item)</CODE>
\r
188 Finds the item associated with this Path.</TD>
\r
190 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
192 <CODE> java.lang.String</CODE></FONT></TD>
\r
193 <TD><CODE><B><A HREF="../../../../com/sun/speech/freetts/PathExtractorImpl.html#toString()">toString</A></B>()</CODE>
\r
196 </TD>
\r
199 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
200 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
201 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
202 <TD><B>Methods inherited from class java.lang.Object</B></TD>
\r
204 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
205 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
211 <!-- ============ FIELD DETAIL =========== -->
\r
213 <A NAME="field_detail"><!-- --></A>
214 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
215 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
216 <TD COLSPAN=1><FONT SIZE="+2">
\r
217 <B>Field Detail</B></FONT></TD>
\r
221 <A NAME="INTERPRET_PATHS_PROPERTY"><!-- --></A><H3>
\r
222 INTERPRET_PATHS_PROPERTY</H3>
\r
224 public static final java.lang.String <B>INTERPRET_PATHS_PROPERTY</B></PRE>
\r
226 <DD>If this system property is set to true, paths will
230 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.PathExtractorImpl.INTERPRET_PATHS_PROPERTY">Constant Field Values</A></DL>
\r
234 <A NAME="LAZY_COMPILE_PROPERTY"><!-- --></A><H3>
\r
235 LAZY_COMPILE_PROPERTY</H3>
\r
237 public static final java.lang.String <B>LAZY_COMPILE_PROPERTY</B></PRE>
\r
239 <DD>If this system property is set to true, CART feature/item
240 paths will only be compiled as needed.
\r
243 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.sun.speech.freetts.PathExtractorImpl.LAZY_COMPILE_PROPERTY">Constant Field Values</A></DL>
\r
246 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
248 <A NAME="constructor_detail"><!-- --></A>
249 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
250 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
251 <TD COLSPAN=1><FONT SIZE="+2">
\r
252 <B>Constructor Detail</B></FONT></TD>
\r
256 <A NAME="PathExtractorImpl(java.lang.String, boolean)"><!-- --></A><H3>
\r
257 PathExtractorImpl</H3>
\r
259 public <B>PathExtractorImpl</B>(java.lang.String pathAndFeature,
260 boolean wantFeature)</PRE>
\r
262 <DD>Creates a path for the given feature.
\r
266 <!-- ============ METHOD DETAIL ========== -->
\r
268 <A NAME="method_detail"><!-- --></A>
269 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
270 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
271 <TD COLSPAN=1><FONT SIZE="+2">
\r
272 <B>Method Detail</B></FONT></TD>
\r
276 <A NAME="findItem(com.sun.speech.freetts.Item)"><!-- --></A><H3>
\r
279 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> item)</PRE>
\r
281 <DD>Finds the item associated with this Path.
\r
284 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/PathExtractor.html#findItem(com.sun.speech.freetts.Item)">findItem</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/PathExtractor.html" title="interface in com.sun.speech.freetts">PathExtractor</A></CODE></DL>
\r
287 <DT><B>Parameters:</B><DD><CODE>item</CODE> - the item to start at
288 <DT><B>Returns:</B><DD>the item associated with the path or null</DL>
\r
293 <A NAME="findFeature(com.sun.speech.freetts.Item)"><!-- --></A><H3>
\r
296 public java.lang.Object <B>findFeature</B>(<A HREF="../../../../com/sun/speech/freetts/Item.html" title="class in com.sun.speech.freetts">Item</A> item)</PRE>
\r
298 <DD>Finds the feature associated with this Path.
\r
301 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/sun/speech/freetts/PathExtractor.html#findFeature(com.sun.speech.freetts.Item)">findFeature</A></CODE> in interface <CODE><A HREF="../../../../com/sun/speech/freetts/PathExtractor.html" title="interface in com.sun.speech.freetts">PathExtractor</A></CODE></DL>
\r
304 <DT><B>Parameters:</B><DD><CODE>item</CODE> - the item to start at
305 <DT><B>Returns:</B><DD>the feature associated or "0" if the
306 feature was not found.</DL>
\r
311 <A NAME="toString()"><!-- --></A><H3>
\r
314 public java.lang.String <B>toString</B>()</PRE>
\r
323 <!-- ========= END OF CLASS DATA ========= -->
\r
327 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
328 <A NAME="navbar_bottom"><!-- --></A>
329 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
330 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
332 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
333 <A NAME="navbar_bottom_firstrow"><!-- --></A>
334 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
335 <TR ALIGN="center" VALIGN="top">
\r
336 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
337 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
338 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
339 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
340 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
341 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
342 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
346 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
352 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
353 <A HREF="../../../../com/sun/speech/freetts/PartOfSpeechImpl.html" title="class in com.sun.speech.freetts"><B>PREV CLASS</B></A>
\r
354 <A HREF="../../../../com/sun/speech/freetts/PhoneDuration.html" title="class in com.sun.speech.freetts"><B>NEXT CLASS</B></A></FONT></TD>
\r
355 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
356 <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
\r
357 <A HREF="PathExtractorImpl.html" target="_top"><B>NO FRAMES</B></A>
\r
358 <SCRIPT type="text/javascript">
\r
361 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
366 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
372 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
373 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
374 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
375 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
378 <A NAME="skip-navbar_bottom"></A>
379 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r