Package org.opengrok.indexer.analysis.plain

Class AbstractSourceCodeAnalyzer

java.lang.Object
org.apache.lucene.analysis.Analyzer
org.opengrok.indexer.analysis.AbstractAnalyzer
org.opengrok.indexer.analysis.FileAnalyzer
org.opengrok.indexer.analysis.TextAnalyzer
org.opengrok.indexer.analysis.plain.PlainAnalyzer
org.opengrok.indexer.analysis.plain.AbstractSourceCodeAnalyzer
All Implemented Interfaces:
Closeable, AutoCloseable
Direct Known Subclasses:
AdaAnalyzer, AsmAnalyzer, CAnalyzer, ClojureAnalyzer, CSharpAnalyzer, CxxAnalyzer, EiffelAnalyzer, ErlangAnalyzer, FortranAnalyzer, GolangAnalyzer, HaskellAnalyzer, HCLAnalyzer, JavaAnalyzer, JavaScriptAnalyzer, JsonAnalyzer, KotlinAnalyzer, LispAnalyzer, LuaAnalyzer, PascalAnalyzer, PerlAnalyzer, PhpAnalyzer, PowershellAnalyzer, PythonAnalyzer, RAnalyzer, RubyAnalyzer, RustAnalyzer, ScalaAnalyzer, ShAnalyzer, SwiftAnalyzer, TclAnalyzer, TerraformAnalyzer, TypeScriptAnalyzer, VBAnalyzer, VerilogAnalyzer, YamlAnalyzer
public abstract class AbstractSourceCodeAnalyzer extends PlainAnalyzer
Author:
Lubos Kosco This class should abstract all analysers that deal with source code. Source code is specific that it has definitions and references. Source code has custom xref generators, depending on symbols. This class should mark the classes that can provide defs and refs. NOTE: SymbolTokenizer gets set for #1376 in PlainAnalyzer::analyze and not part of this class anymore due to changes in lucene 6 . Anything shared just for source code analyzers should be here, also all interfaces for source code analyzer should start here. Any child is forced to provide necessary xref and symbol tokenizers, if it fails to do so it will automatically behave like PlainAnalyzer.

  • Constructor Details

    • AbstractSourceCodeAnalyzer

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

  • Method Details

    • newXref

      protected abstract JFlexXref newXref(Reader reader)
      Create an xref for the language supported by this analyzer.
      Overrides:
      newXref in class PlainAnalyzer
      Parameters:
      reader - the data to produce xref for
      Returns:
      an xref instance