AnalyzerGuru.java revision 424
58N/A * CDDL HEADER START 58N/A * The contents of this file are subject to the terms of the 58N/A * Common Development and Distribution License (the "License"). 58N/A * You may not use this file except in compliance with the License. 58N/A * language governing permissions and limitations under the License. 58N/A * When distributing Covered Code, include this CDDL HEADER in each 58N/A * If applicable, add the following below this CDDL HEADER, with the 58N/A * fields enclosed by brackets "[]" replaced with your own identifying 58N/A * information: Portions Copyright [yyyy] [name of copyright owner] 1252N/A * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 58N/A * Use is subject to license terms. 65N/A * Manages and porvides Analyzers as needed. Please see 77N/A * this</a> page for a great description of the purpose of the AnalyzerGuru. 99N/A * Created on September 22, 2005 1026N/A /** The default {@code FileAnalyzerFactory} instance. */ 129N/A /** Map from file extensions to analyzer factories. */ 173N/A // TODO: have a comparator 253N/A /** Map from magic strings to analyzer factories. */ 816N/A * List of matcher objects which can be used to determine which analyzer 1125N/A /** List of all registered {@code FileAnalyzerFactory} instances. */ 1185N/A * If you write your own analyzer please register it here 816N/A * Register a {@code FileAnalyzerFactory} instance. 58N/A "suffix '" +
suffix +
"' used in multiple analyzers";
99N/A "magic '" +
magic +
"' used in multiple analyzers";
129N/A * Instruct the AnalyzerGuru to use a given analyzer for a given 875N/A * @param extension the file-extension to add 318N/A * @param factory a factory which creates 144N/A * the analyzer to use for the given extension 173N/A * (if you pass null as the analyzer, you will disable 253N/A * the analyzer used for that extension) 1185N/A * Get the default Analyzer. 1185N/A * Get an analyzer suited to analyze a file. This function will reuse 1185N/A * analyzers since they are costly. 1185N/A * @param in Input stream containing data to be analyzed 1185N/A * @param file Name of the file to be analyzed 1185N/A * @return An analyzer suited for that file content 1185N/A * @throws java.io.IOException If an error occurs while accessing the 1185N/A * data in the input stream. 58N/A * Create a Lucene document and fill in the required fields 58N/A * @param file The file to index 937N/A * @param in The data to generate the index for 58N/A * @param path Where the file is located (from source root) 58N/A * @return The Lucene document to add to the index database 58N/A * @throws java.io.IOException If an exception occurs while collecting the 816N/A // date = hr.getLastCommentDate() //RFE 773N/A // Ignoring any errors while analysing 773N/A * Get the content type for a named file. 773N/A * @param in The input stream we want to get the content type for (if 773N/A * we cannot determine the content type by the filename) 58N/A * @param file The name of the file 58N/A * @return The contentType suitable for printing to response.setContentType() or null 58N/A * if the factory was not found 773N/A * @throws java.io.IOException If an error occurs while accessing the input 773N/A * Write a browsable version of the file 773N/A * @param factory The analyzer factory for this filetype 773N/A * @param in The input stream containing the data 773N/A * @param out Where to write the result 773N/A * @param annotation Annotation information for the file 773N/A * @param project Project the file belongs to 773N/A * @throws java.io.IOException If an error occurs while creating the 937N/A * Get the genre of a file 58N/A * @param file The file to inpect 58N/A * @return The genre suitable to decide how to display the file 58N/A * Get the genre of a bulk of data 937N/A * @param in A stream containing the data 58N/A * @return The genre suitable to decide how to display the file 58N/A * @throws java.io.IOException If an error occurs while getting the content 664N/A * Get the genre for a named class (this is most likely an analyzer) 58N/A * @param factory the analyzer factory to get the genre for 58N/A * @return The genre of this class (null if not found) 1252N/A * Find a {@code FileAnalyzerFactory} with the specified class name. If one 1185N/A * doesn't exist, create one and register it. 58N/A * @param factoryClassName name of the factory class 58N/A * @return a file analyzer factory 937N/A * @throws ClassNotFoundException if there is no class with that name 65N/A * @throws ClassCastException if the class is not a subclass of {@code 65N/A * FileAnalyzerFactory} 65N/A * @throws IllegalAccessException if the constructor cannot be accessed 937N/A * @throws InstantiationException if the class cannot be instantiated 77N/A * Find a {@code FileAnalyzerFactory} which is an instance of the specified 77N/A * class. If one doesn't exist, create one and register it. 99N/A * @param factoryClass the factory class 99N/A * @return a file analyzer factory 99N/A * @throws ClassCastException if the class is not a subclass of {@code 99N/A * FileAnalyzerFactory} 99N/A * @throws IllegalAccessException if the constructor cannot be accessed 99N/A * @throws InstantiationException if the class cannot be instantiated 1115N/A * Finds a suitable analyser class for file name. If the analyzer cannot 125N/A * be determined by the file extension, try to look at the data in the 125N/A * InputStream to find a suitable analyzer. 937N/A * Use if you just want to find file type. 125N/A * @param in The input stream containing the data 106N/A * @param file The file name to get the analyzer for 106N/A * @return the analyzer factory to use 937N/A * @throws java.io.IOException If a problem occurs while reading the data 112N/A * Finds a suitable analyser class for file name. 112N/A * @param file The file name to get the analyzer for 129N/A * @return the analyzer factory to use 1100N/A // file doesn't have any of the extensions we know 1100N/A * Finds a suitable analyser class for the data in this stream 129N/A * @param in The stream containing the data to analyze 129N/A * @return the analyzer factory to use 129N/A * @throws java.io.IOException if an error occurs while reading data from 318N/A * Finds a suitable analyser class for a magic signature 144N/A * @param signature the magic signature look up 144N/A * @return the analyzer factory to use 173N/A * Get an analyzer by looking up the "magic signature" 173N/A * @param signature the signature to look up 173N/A * @return the analyzer factory to handle data with this signature 296N/A // See if text files have the magic sequence if we remove the 335N/A /** Byte-order markers. */ 335N/A new String(
new char[] {
0xEF,
0xBB,
0xBF}),
// UTF-8 BOM 480N/A * Strip away the byte-order marker from the string, if it has one. 937N/A * @param str the string to remove the BOM from 937N/A * @return a string without the byte-order marker, or <code>null</code> if 667N/A * the string doesn't start with a BOM