01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package threaddemo.apps.index;
43:
44: import java.util.Map;
45: import javax.swing.event.ChangeListener;
46: import threaddemo.locking.RWLock;
47: import threaddemo.model.Phadhail;
48:
49: /**
50: * Maintains a read-only index of elements in XML phadhail documents.
51: * @author Jesse Glick
52: */
53: interface Index {
54:
55: /**
56: * Get the root of the tree being searched.
57: */
58: Phadhail getRoot();
59:
60: /**
61: * Begin parsing, if it has not already been begun.
62: */
63: void start();
64:
65: /**
66: * Stop any ongoing processing if there was any.
67: * Results will not generally be valid after this.
68: */
69: void cancel();
70:
71: /**
72: * Get the index data.
73: * Keys are XML element names.
74: * Values are occurrence counts.
75: * <p>Must be called with lock held, and result may only be accessed with it held.
76: */
77: Map<String, Integer> getData();
78:
79: /**
80: * Add a listener to changes in the data.
81: */
82: void addChangeListener(ChangeListener l);
83:
84: /**
85: * Remove a listener.
86: */
87: void removeChangeListener(ChangeListener l);
88:
89: /**
90: * Associated lock.
91: */
92: RWLock getLock();
93:
94: }
|