Package org.opengrok.indexer.analysis.executables

Class JavaClassAnalyzer

java.lang.Object

org.apache.lucene.analysis.Analyzer

org.opengrok.indexer.analysis.AbstractAnalyzer

org.opengrok.indexer.analysis.FileAnalyzer

org.opengrok.indexer.analysis.executables.JavaClassAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable

public class JavaClassAnalyzer
extends FileAnalyzer

Analyzes Java Class files. Created on September 23, 2005

Author:

Chandan, Lubos Kosco , January 2010 , updated bcel, comment on thread safety

Nested Class Summary

Nested classes/interfaces inherited from class org.opengrok.indexer.analysis.AbstractAnalyzer

AbstractAnalyzer.Genre

Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer

org.apache.lucene.analysis.Analyzer.ReuseStrategy, org.apache.lucene.analysis.Analyzer.TokenStreamComponents

Field Summary

Fields inherited from class org.opengrok.indexer.analysis.AbstractAnalyzer

countsAggregator, ctags, DUMMY_READER, factory, foldingEnabled, project, scopesEnabled, symbolTokenizerFactory

Fields inherited from class org.apache.lucene.analysis.Analyzer

GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaClassAnalyzer(AnalyzerFactory factory)	Creates a new instance of JavaClassAnalyzer.

Method Summary

Modifier and Type	Method	Description
void	analyze(org.apache.lucene.document.Document doc, StreamSource src, Writer xrefOut)	Analyze the contents of a source file.
String	constantToString(org.apache.bcel.classfile.Constant c, org.apache.bcel.classfile.ConstantPool cp, int[] v)
String	getCtagsLang()	Subclasses should override to return the case-insensitive name aligning with either a built-in Universal Ctags language name or an OpenGrok custom language name.
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.
protected String	linkDef(String def)
protected String	linkPath(String path)
protected String	tagDef(String def)

Methods inherited from class org.opengrok.indexer.analysis.FileAnalyzer

addNumLinesLOC, createComponents, getFileTypeName, getVersionNo, normalize, supportsScopes, writeXref

Methods inherited from class org.opengrok.indexer.analysis.AbstractAnalyzer

getFactory, getGenre, setCountsAggregator, setCtags, setFoldingEnabled, setProject, setScopesEnabled

Methods inherited from class org.apache.lucene.analysis.Analyzer

attributeFactory, close, getOffsetGap, getPositionIncrementGap, getReuseStrategy, initReader, initReaderForNormalization, normalize, tokenStream, tokenStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JavaClassAnalyzer

protected JavaClassAnalyzer(AnalyzerFactory factory)

Creates a new instance of JavaClassAnalyzer.

Parameters:

factory - The factory that creates JavaClassAnalyzers

Method Details

getCtagsLang

public String getCtagsLang()

Description copied from class: AbstractAnalyzer

Subclasses should override to return the case-insensitive name aligning with either a built-in Universal Ctags language name or an OpenGrok custom language name.

Overrides:

getCtagsLang in class FileAnalyzer

Returns:

null as there is no aligned language

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:

20180612_00

analyze

public void analyze(org.apache.lucene.document.Document doc,
 StreamSource src,
 Writer xrefOut)
             throws IOException

Description copied from class: FileAnalyzer

Analyze the contents of a source file. This includes populating the Lucene document with fields to add to the index, and writing the cross-referenced data to the specified destination.

Overrides:

analyze in class FileAnalyzer

Parameters:

doc - the Lucene document

src - the input data source

xrefOut - where to write the xref (may be null)

Throws:

IOException - if any I/O error

linkPath

protected String linkPath(String path)

linkDef

protected String linkDef(String def)

tagDef

protected String tagDef(String def)

constantToString

public String constantToString(org.apache.bcel.classfile.Constant c,
 org.apache.bcel.classfile.ConstantPool cp,
 int[] v)
                        throws org.apache.bcel.classfile.ClassFormatException

Throws:

org.apache.bcel.classfile.ClassFormatException