Package org.opengrok.indexer.analysis

Class TextAnalyzer

java.lang.Object
org.apache.lucene.analysis.Analyzer
org.opengrok.indexer.analysis.AbstractAnalyzer
org.opengrok.indexer.analysis.FileAnalyzer
org.opengrok.indexer.analysis.TextAnalyzer
All Implemented Interfaces:
Closeable, AutoCloseable
Direct Known Subclasses:
MandocAnalyzer, PlainAnalyzer, TroffAnalyzer, UuencodeAnalyzer, XMLAnalyzer
public abstract class TextAnalyzer extends FileAnalyzer

  • Constructor Details

    • TextAnalyzer

      protected TextAnalyzer(AnalyzerFactory factory)
      Creates a new instance of TextAnalyzer.
      Parameters:
      factory - defined instance for the analyzer

    • TextAnalyzer

      protected TextAnalyzer(AnalyzerFactory factory, Supplier<JFlexTokenizer> symbolTokenizerFactory)
      Creates a new instance of TextAnalyzer.
      Parameters:
      factory - defined instance for the analyzer
      symbolTokenizerFactory - defined instance for the analyzer

  • Method Details

    • getSpecializedVersionNo

      protected int getSpecializedVersionNo()
      Gets a version number to be used to tag processed documents so that re-analysis can be re-done later if a stored version number is different from the current implementation.
      Overrides:
      getSpecializedVersionNo in class AbstractAnalyzer
      Returns:
      20171223_00

    • writeXref

      public Xrefer writeXref(WriteXrefArgs args) throws IOException
      Write a cross referenced HTML file reads the source from in.
      Overrides:
      writeXref in class FileAnalyzer
      Parameters:
      args - a defined instance
      Returns:
      the instance used to write the cross-referencing
      Throws:
      IOException - if an I/O error occurs

    • newXref

      protected abstract Xrefer newXref(Reader reader)
      Derived classes should implement to create an xref for the language supported by this analyzer.
      Parameters:
      reader - the data to produce xref for
      Returns:
      an xref instance

    • getReader

      protected Reader getReader(InputStream stream) throws IOException
      Gets a BOM-stripped Reader (default UTF-8 charset) of the specified stream, wrapped in a ZeroReader.
      Parameters:
      stream - input stream
      Returns:
      Reader instance
      Throws:
      IOException