IndexDatabase.java revision 1327
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 (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved. 207N/A * This class is used to create / update the index databases. Currently we use 1190N/A * one index database per project. 928N/A * @author Lubos Kosco , update for lucene 3.0.0 207N/A * Create a new instance of the Index Database. Use this constructor if 207N/A * you don't use any projects 207N/A * @throws java.io.IOException if an error occurs while creating directories 207N/A * Create a new instance of an Index Database for a given project 207N/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 261N/A * @param executor An executor to run the job 459N/A * @throws IOException if an error occurs 207N/A * Update the index database for all of the projects 261N/A * @param executor An executor to run the job 207N/A * @param listener where to signal the changes to the database 459N/A * @throws IOException if an error occurs 668N/A * Update the index database for a number of sub-directories 668N/A * @param executor An executor to run the job 668N/A * @param listener where to signal the changes to the database 580N/A // to avoid race conditions, just recheck.. 274N/A * By default the indexer will traverse all directories in the project. 274N/A * If you add directories with this function update will just process 274N/A * the specified directories. 274N/A * @param dir The directory to scan 297N/A * @return <code>true</code> if the file is added, false oth 207N/A * Update the content of this index database 459N/A * @throws IOException if an error occurs 678N/A * @throws HistoryException if an error occurs when accessing the history 816N/A //TODO we might need to add writer.commit after certain phases of index generation, right now it will only happen in the end 1318N/A //iwc.setRAMBufferSizeMB(256.0); //TODO check what is the sweet spot 1318N/A //writer.setMaxFieldLength(RuntimeEnvironment.getInstance().getIndexWordLimit()); 1112N/A //TODO below should be optional, since it traverses the tree once more to get total count! :( 1327N/A +
"'used for timestamping the index database");
1327N/A +
"', used for timestamping the index database");
270N/A * Optimize all index databases 270N/A * @param executor An executor to run the job 459N/A * @throws IOException if an error occurs 207N/A * Optimize the index database 207N/A * Generate a spelling suggestion for the definitions stored in defs 830N/A //TODO below seems only to index "defs" , possible bug ? 1190N/A * Remove a stale file (uidIter.term().text()) from the index database 207N/A * @throws java.io.IOException if an error occurs 506N/A // Remove the parent directory if it's empty 207N/A * Add a file to the Lucene index (and generate a xref file) 207N/A * @param file The file to add 207N/A * @param path The path to the file (from source root) 207N/A * @throws java.io.IOException if an error occurs 1327N/A "Skipped file ''{0}'' because the analyzer didn''t " +
889N/A // If mkdirs() returns false, the failure is most likely 889N/A // because the file already exists. But to check for the 889N/A // file first and only add it if it doesn't exists would 889N/A // only increase the file IO... 207N/A * Check if I should accept this file into the index database 207N/A * @param file the file to check 207N/A * @return true if the file should be included, false otherwise 1028N/A // the filter should not affect directory names 876N/A //below will only let go files and directories, anything else is considered special and is not added 504N/A // always accept directories so that their files can be examined 504N/A // versioned files should always be accepted 504N/A // this is an unversioned file, check if it should be indexed 1192N/A // Now, let's verify that it's not a link back up the chain... 1016N/A * Check if I should accept the path containing a symlink 1016N/A * @param absolutePath the path with a symlink to check 1016N/A * @param canonicalPath the canonical path to the file 1016N/A * @return true if the file should be accepted, false otherwise 1051N/A // Always accept local symlinks 1051N/A * Check if a file is local to the current project. If we don't have 1051N/A * projects, check if the file is in the source root. 1051N/A * @param path the path to a file 1051N/A * @return true if the file is local to the current repository 1051N/A // File is under the current project, so it's local. 1051N/A // File is under source root, and we don't have projects, so 207N/A * Generate indexes recursively 207N/A * @param dir the root indexDirectory to generate indexes for 1112N/A * @param count_only if true will just traverse the source root and count files 1112N/A * @param cur_count current count during the traversal of the tree 1112N/A * @param est_total estimate total files to process 207N/A * Interrupt the index generation (and the index generation will stop as 207N/A * Register an object to receive events when modifications is done to the 207N/A * @param listener the object to receive the events 207N/A * Remove an object from the lists of objects to receive events when 207N/A * modifications is done to the index database 207N/A * @param listener the object to remove 207N/A * List all files in all of the index databases 359N/A * @throws IOException if an error occurs 207N/A * List all files in some of the index databases 207N/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) 359N/A * @throws IOException if an error occurs 207N/A * List all of the files in this index database 359N/A * @throws IOException If an IO error occurs while reading from the database 208N/A * Get an indexReader for the Index database where a given file 208N/A * @param path the file to get the database for 208N/A * @return The index database where the file should be located or null if 208N/A * it cannot be located. 1127N/A * Get the latest definitions for a file from the index. 1127N/A * @param file the file whose definitions to find 1127N/A * @return definitions for the file, or {@code null} if they could not 1127N/A * @throws IOException if an error happens when accessing the index 1127N/A * @throws ParseException if an error happens when building the Lucene query 1127N/A * @throws ClassNotFoundException if the class for the stored definitions 1127N/A // No index, no definitions... 1127N/A // No hits, no definitions... 1127N/A // Only use the definitions if we found an exact match. 1127N/A // Didn't find any definitions.