001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.gsf.api;
043:
044: import java.io.IOException;
045: import java.util.Collection;
046: import java.util.Set;
047:
048: /**
049: * This class represents an index that is provided by the IDE to a language
050: * plugin for storage and retrieval. Language plugins should not subclass this class.
051: *
052: * @author Tor Norbye
053: */
054: public abstract class Index {
055:
056: public Index() {
057: }
058:
059: /**
060: * Encodes a reference type,
061: * used by {@link ClassIndex#getElements} and {@link ClassIndex#getResources}
062: * to restrict the search.
063: */
064: public enum SearchKind {
065:
066: /**
067: * The returned class has to extend or implement given element
068: */
069: IMPLEMENTORS,
070:
071: /**
072: * The returned class has to call method on given element
073: */
074: METHOD_REFERENCES,
075:
076: /**
077: * The returned class has to access a field on given element
078: */
079: FIELD_REFERENCES,
080:
081: /**
082: * The returned class contains references to the element type
083: */
084: TYPE_REFERENCES,
085: };
086:
087: /**
088: * Scope used by {@link ClassIndex} to search in
089: */
090: public enum SearchScope {
091: /**
092: * Search is done in source path
093: */
094: SOURCE,
095: /**
096: * Search is done in compile and boot path
097: */
098: DEPENDENCIES
099: };
100:
101: /**
102: * Result corresponding to a "document" in the
103: * index. Each document contains name,value pairs.
104: * Some pairs are unique (a single key and value)
105: * whereas others have many values for a single key.
106: * Call getValues() on the latter.
107: *
108: * @todo There's some asymmetry between gsfStore and
109: * gsfSearch now, in that the store operation
110: * takes a set of maps, whereas the result is a
111: * set of SearchResults (which are map-like). Originally
112: * I returned a set of maps, but the maps aren't
113: * really maps since they wrap Lucene documents,
114: * which don't support all the map operations.
115: * Possibly I could offer some kind of SearchDocument
116: * interface here to be passed in instead for better
117: * symmetry, as long as it's convenient to use.
118: */
119: public interface SearchResult {
120: String getPersistentUrl();
121:
122: String getValue(String key);
123:
124: String[] getValues(String key);
125:
126: // FOR INDEX BROWSER (development/debugging aid) only
127: Object getIndex(); // GSF Index
128:
129: Object getDocument(); // Lucene Document
130:
131: Object getIndexReader(); // Lucene IndexReader
132:
133: java.io.File getSegment(); // Segment directory
134:
135: //String[] getKeys(); // Set of field
136: int getDocumentNumber();
137: }
138:
139: public abstract void search(final String key, final String name,
140: final NameKind kind, final Set<SearchScope> scope,
141: Set<SearchResult> result, final Set<String> includeKeys)
142: throws IOException;
143: }
|