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.File;
045: import java.io.IOException;
046: import java.util.List;
047: import org.netbeans.modules.gsf.api.IndexDocument;
048: import org.netbeans.modules.gsf.api.IndexDocumentFactory;
049: import org.openide.filesystems.FileObject;
050:
051: /**
052: * Language plugins should implement this interface and register the
053: * implementation in the Languages folder. This method will be called
054: * when the index needs to be updated. The indexer should iterate through
055: * its parsing results and store information in the provided index as
056: * necessary. Client code like code completion etc. can later retrieve
057: * information from the index which is passed around with CompilationInfos.
058: *
059: * @todo Add fileDeletion notification?
060: * @todo Queue up in RepositoryUpdater and process in a single batch operation
061: * for improved Lucene performance
062: *
063: * @author Tor Norbye
064: */
065: public abstract interface Indexer {
066: /** Returns true iff this indexer wants to index the given file */
067: boolean isIndexable(ParserFile file);
068:
069: /** For files that are {@link #isIndexable}, index the given file by
070: * operating on the provided {@link Index} using the given {@link ParserResult} to
071: * fetch AST information.
072: */
073: List<IndexDocument> index(ParserResult result,
074: IndexDocumentFactory factory) throws IOException;
075:
076: String getPersistentUrl(File file);
077:
078: /**
079: * Return the version stamp of the schema that is currently being stored
080: * by this indexer. Along with the index name this string will be used to
081: * create a unique data directory for the database.
082: *
083: * Whenever you incompatibly change what is stored by the indexer,
084: * update the version stamp.
085: *
086: * @return The version stamp of the current index.
087: */
088: String getIndexVersion();
089:
090: /**
091: * Return the name of this indexer. This name should be unique because GSF
092: * will use this name to produce a separate data directory for each indexer
093: * where it has its own storage.
094: *
095: * @return The indexer name. This does not need to be localized since it is
096: * never shown to the user, but should contain filesystem safe characters.
097: */
098: String getIndexerName();
099:
100: /**
101: * If not null, return the FileObject of a directory containing pre-indexed versions
102: * of various libraries.
103: *
104: * @return A file object for the preindexed database, or null
105: */
106: FileObject getPreindexedDb();
107: }
|