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-2007 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 org.netbeans.modules.xml.xam.ui.search;
43:
44: import java.util.List;
45:
46: /**
47: * Provides the capability to search a XAM model and display the results
48: * in a manner appropriate for the current view of the model.
49: *
50: * @author Nathan Fiedler
51: */
52: public interface SearchProvider {
53:
54: /**
55: * Returns the display string for describing this search provider.
56: *
57: * @return display name.
58: */
59: String getDisplayName();
60:
61: /**
62: * Returns a description of the expected input for this provider.
63: * This is used to instruct the user on what should be entered into
64: * the search field.
65: *
66: * @return description of expected input.
67: */
68: String getInputDescription();
69:
70: /**
71: * Returns a brief description of this provider, useful for tooltips.
72: *
73: * @return short description.
74: */
75: String getShortDescription();
76:
77: /**
78: * Performs the search using the given query string. The query string
79: * will match any element that contains the given string, whether in
80: * whole or in part (i.e. a "sub-string" search), and will be compared
81: * in a case-insensitive fashion.
82: *
83: * @param query encapsulates the search parameters.
84: * @return search results, or empty if none found.
85: * @throws SearchException
86: * if the search resulted in an unexpected error.
87: */
88: List<Object> search(Query query) throws SearchException;
89: }
|