IndexDatabase.java revision 872
207N/A * The contents of this file are subject to the terms of the 207N/A * Common Development and Distribution License (the "License"). 207N/A * You may not use this file except in compliance with the License. 207N/A * language governing permissions and limitations under the License. 207N/A * When distributing Covered Code, include this CDDL HEADER in each 207N/A * If applicable, add the following below this CDDL HEADER, with the 207N/A * fields enclosed by brackets "[]" replaced with your own identifying 207N/A * information: Portions Copyright [yyyy] [name of copyright owner] 1051N/A * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 207N/A * Use is subject to license terms. 207N/A * This class is used to create / update the index databases. Currently we use 207N/A * one index database per project. 207N/A * Create a new instance of the Index Database. Use this constructor if 207N/A * you don't use any projects 253N/A * @throws java.io.IOException if an error occurs while creating directories 928N/A * Create a new instance of an Index Database for a given project 656N/A * @param project the project to create the database for 207N/A * @throws java.io.IOException if an errror occurs while creating directories 207N/A * Update the index database for all of the projects. Print progress to 207N/A * @param executor An executor to run the job 207N/A * @throws IOException if an error occurs 207N/A * Update the index database for all of the projects 207N/A * @param executor An executor to run the job 207N/A * @param listener where to signal the changes to the database 207N/A * @throws IOException if an error occurs 261N/A * Update the index database for a number of sub-directories 261N/A * @param executor An executor to run the job 1054N/A * @param listener where to signal the changes to the database 261N/A * @throws IOException if an error occurs 668N/A // to avoid race conditions, just recheck.. 207N/A * By default the indexer will traverse all directories in the project. 928N/A * If you add directories with this function update will just process 928N/A * the specified directories. 1026N/A * @param dir The directory to scan 580N/A * @return <code>true</code> if the file is added, false oth 274N/A * Update the content of this index database 439N/A * @throws IOException if an error occurs 439N/A * @throws HistoryException if an error occurs when accessing the history 678N/A log.
severe(
"Unable to run ctags! searching definitions will not work!");
359N/A //TODO we might need to add writer.commit after certain phases of index generation, right now it will only happen in the end 656N/A * Optimize all index databases 656N/A * @param executor An executor to run the job 359N/A * @throws IOException if an error occurs 270N/A * Optimize the index database 270N/A log.
warning(
"Optimize terminated... Someone else is updating / optimizing it!");
359N/A * Generate a spelling suggestion for the definitions stored in defs 207N/A //TODO below seems only to index "defs" , possible bug ? 359N/A * Remove a stale file (uidIter.term().text()) from the index database 359N/A * @throws java.io.IOException if an error occurs 207N/A // Remove the parent directory if it's empty 515N/A * Add a file to the Lucene index (and generate a xref file) 515N/A * @param file The file to add 515N/A * @param path The path to the file (from source root) 515N/A * @throws java.io.IOException if an error occurs 207N/A // If mkdirs() returns false, the failure is most likely 207N/A // because the file already exists. But to check for the 207N/A // file first and only add it if it doesn't exists would 207N/A // only increase the file IO... 889N/A * Check if I should accept this file into the index database 889N/A * @param file the file to check 889N/A * @return true if the file should be included, false otherwise 889N/A // Lets support symlinks within the same directory, this 889N/A // should probably be extended to within the same repository 207N/A //below will only let go files and directories, anything else is considered special and is 1028N/A // always accept directories so that their files can be examined 1026N/A // versioned files should always be accepted 207N/A // this is an unversioned file, check if it should be indexed 207N/A * Generate indexes recursively 207N/A * @param dir the root indexDirectory to generate indexes for 1051N/A * Interrupt the index generation (and the index generation will stop as 1051N/A * Register an object to receive events when modifications is done to the 1051N/A * @param listener the object to receive the events 1051N/A * Remove an object from the lists of objects to receive events when 1051N/A * modifications is done to the index database 1051N/A * @param listener the object to remove 1112N/A * List all files in all of the index databases 207N/A * @throws IOException if an error occurs 207N/A * List all files in some of the index databases 1112N/A * @param subFiles Subdirectories for the various projects to list the files 207N/A * for (or null or an empty list to dump all projects) 207N/A * @throws IOException if an error occurs 1108N/A * List all of the files in this index database 594N/A * @throws IOException If an IO error occurs while reading from the database 207N/A * Get an indexReader for the Index database where a given file 207N/A * @param path the file to get the database for 207N/A * @return The index database where the file should be located or null if 207N/A * it cannot be located.