upstream version 1.2.2
[debian/freetts] / com / sun / speech / freetts / PathExtractor.java
1 /**
2  * Portions Copyright 2001 Sun Microsystems, Inc.
3  * Portions Copyright 1999-2001 Language Technologies Institute, 
4  * Carnegie Mellon University.
5  * All Rights Reserved.  Use is subject to license terms.
6  * 
7  * See the file "license.terms" for information on usage and
8  * redistribution of this file, and for a DISCLAIMER OF ALL 
9  * WARRANTIES.
10  */
11 package com.sun.speech.freetts;
12
13
14 /**
15  * Manages a feature or item path. Allows navigation
16  * to the corresponding feature or item.
17  */
18 public interface PathExtractor {
19
20     /**
21      * Finds the item associated with this object.
22      *
23      * @param item the starting point for the path navigation
24      *
25      * @return the item associated with the path or null
26      */
27     public Item findItem(Item item);
28
29     /**
30      * Finds the feature associated with this object.
31      *
32      * @param item the starting point for the path navigation
33      *
34      * @return the feature associated or "0"  if the
35      *   feature was not found
36      */
37     public Object findFeature(Item item);
38
39
40     // TODO: add these to the interface should we support binary
41     // files
42     /*
43     public void writeBinary();
44     public void readBinary();
45     */
46 }