Package org.opengrok.indexer.analysis.eiffel

Class EiffelAnalyzer

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

org.opengrok.indexer.analysis.eiffel.EiffelAnalyzer

All Implemented Interfaces:

Closeable, AutoCloseable

public class EiffelAnalyzer
extends AbstractSourceCodeAnalyzer

Represents an analyzer for the Eiffel language.

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	EiffelAnalyzer(AnalyzerFactory factory)	Creates a new instance of EiffelAnalyzer.

Method Summary

Modifier and Type	Method	Description
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 JFlexXref	newXref(Reader reader)	Creates a wrapped EiffelXref instance.

Methods inherited from class org.opengrok.indexer.analysis.plain.PlainAnalyzer

analyze, getReader

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

writeXref

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

addNumLinesLOC, createComponents, getFileTypeName, getVersionNo, normalize, supportsScopes

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

EiffelAnalyzer

protected EiffelAnalyzer(AnalyzerFactory factory)

Creates a new instance of EiffelAnalyzer.

Parameters:

factory - instance

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 PlainAnalyzer

Returns:

"Eiffel"

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 PlainAnalyzer

Returns:

20190118_00

newXref

protected JFlexXref newXref(Reader reader)

Creates a wrapped EiffelXref instance.

Specified by:

newXref in class AbstractSourceCodeAnalyzer

Parameters:

reader - the data to produce xref for

Returns:

a defined instance