Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Enums
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Interfaces

Interface and Description
org.apache.lucene.search.FieldCache.ByteParser
org.apache.lucene.search.FieldCache.ShortParser

Deprecated Classes

Class and Description
org.apache.lucene.analysis.Analyzer.GlobalReuseStrategy This implementation class will be hidden in Lucene 5.0. Use Analyzer.GLOBAL_REUSE_STRATEGY instead!
org.apache.lucene.analysis.Analyzer.PerFieldReuseStrategy This implementation class will be hidden in Lucene 5.0. Use Analyzer.PER_FIELD_REUSE_STRATEGY instead!
org.apache.lucene.codecs.appending.AppendingCodec This codec is read-only: as the functionality has been folded into the default codec. Its only for convenience to read old segments.
org.apache.lucene.codecs.appending.AppendingTermsReader Only for reading old Appending segments
org.apache.lucene.analysis.ar.ArabicLetterTokenizer (3.1) Use StandardTokenizer instead.
org.apache.lucene.analysis.ar.ArabicLetterTokenizerFactory (3.1) Use StandardTokenizerFactory instead.
org.apache.lucene.document.ByteDocValuesField use NumericDocValuesField instead.
org.apache.lucene.queries.function.valuesource.ByteFieldSource
org.apache.lucene.analysis.cn.ChineseAnalyzer (3.1) Use StandardAnalyzer instead, which has the same functionality. This analyzer will be removed in Lucene 5.0
org.apache.lucene.analysis.cn.ChineseFilter (3.1) Use StopFilter instead, which has the same functionality. This filter will be removed in Lucene 5.0
org.apache.lucene.analysis.cn.ChineseFilterFactory Use StopFilterFactory instead.
org.apache.lucene.analysis.cn.ChineseTokenizer (3.1) Use StandardTokenizer instead, which has the same functionality. This filter will be removed in Lucene 5.0
org.apache.lucene.analysis.cn.ChineseTokenizerFactory Use StandardTokenizerFactory instead.
org.apache.lucene.analysis.cjk.CJKTokenizer Use StandardTokenizer, CJKWidthFilter, CJKBigramFilter, and LowerCaseFilter instead.
org.apache.lucene.analysis.cjk.CJKTokenizerFactory Use CJKBigramFilterFactory instead.
org.apache.lucene.collation.CollationKeyFilter Use CollationAttributeFactory instead, which encodes terms directly as bytes. This filter will be removed in Lucene 5.0
org.apache.lucene.collation.CollationKeyFilterFactory use CollationKeyAnalyzer instead.
org.apache.lucene.document.DerefBytesDocValuesField Use BinaryDocValuesField instead.
org.apache.lucene.analysis.nl.DutchStemFilter (3.1) Use SnowballFilter with DutchStemmer instead, which has the same functionality. This filter will be removed in Lucene 5.0
org.apache.lucene.analysis.nl.DutchStemmer (3.1) Use DutchStemmer instead, which has the same functionality. This filter will be removed in Lucene 5.0
org.apache.lucene.search.FieldComparator.ByteComparator
org.apache.lucene.search.FieldComparator.ShortComparator
org.apache.lucene.analysis.fr.FrenchStemFilter (3.1) Use SnowballFilter with FrenchStemmer instead, which has the same functionality. This filter will be removed in Lucene 5.0
org.apache.lucene.analysis.fr.FrenchStemmer Use FrenchStemmer instead, which has the same functionality. This filter will be removed in Lucene 4.0
org.apache.lucene.queryparser.flexible.standard.processors.GroupQueryNodeProcessor use BooleanQuery2ModifierNodeProcessor instead
org.apache.lucene.util.IndexableBinaryStringTools Implement TermToBytesRefAttribute and store bytes directly instead. This class will be removed in Lucene 5.0
org.apache.lucene.analysis.in.IndicTokenizer (3.6) Use StandardTokenizer instead.
org.apache.lucene.document.IntDocValuesField use NumericDocValuesField instead.
org.apache.lucene.document.LongDocValuesField use NumericDocValuesField instead.
org.apache.lucene.codecs.lucene3x.Lucene3xCodec Only for reading existing 3.x indexes
org.apache.lucene.codecs.lucene3x.Lucene3xSegmentInfoFormat (4.0) This is only used to read indexes created before 4.0.
org.apache.lucene.codecs.lucene3x.Lucene3xSegmentInfoReader Only for reading existing 3.x indexes
org.apache.lucene.codecs.lucene40.Lucene40Codec Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene40.Lucene40DocValuesFormat Only for reading old 4.0 and 4.1 segments
org.apache.lucene.codecs.lucene40.Lucene40FieldInfosFormat Only for reading old 4.0 and 4.1 segments
org.apache.lucene.codecs.lucene40.Lucene40NormsFormat Only for reading old 4.0 and 4.1 segments
org.apache.lucene.codecs.lucene40.Lucene40PostingsBaseFormat Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene40.Lucene40PostingsFormat Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene40.Lucene40PostingsReader Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene40.Lucene40SegmentInfoFormat Only for reading old 4.0-4.5 segments, and supporting IndexWriter.addIndexes
org.apache.lucene.codecs.lucene40.Lucene40SegmentInfoReader Only for reading old 4.0-4.5 segments
org.apache.lucene.codecs.lucene40.Lucene40SegmentInfoWriter
org.apache.lucene.codecs.lucene40.Lucene40SkipListReader Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene41.Lucene41Codec Only for reading old 4.0 segments
org.apache.lucene.codecs.lucene42.Lucene42Codec Only for reading old 4.2 segments
org.apache.lucene.codecs.lucene42.Lucene42DocValuesFormat Only for reading old 4.2 segments
org.apache.lucene.codecs.lucene42.Lucene42FieldInfosFormat Only for reading old 4.2-4.5 segments
org.apache.lucene.analysis.ngram.Lucene43EdgeNGramTokenizer
org.apache.lucene.analysis.ngram.Lucene43NGramTokenizer
org.apache.lucene.codecs.lucene45.Lucene45Codec Only for reading old 4.3-4.5 segments
org.apache.lucene.analysis.miscellaneous.Lucene47WordDelimiterFilter
org.apache.lucene.document.PackedLongDocValuesField use NumericDocValuesField instead.
org.apache.lucene.analysis.miscellaneous.PatternAnalyzer (4.0) use the pattern-based analysis in the analysis/pattern package instead.
org.apache.lucene.analysis.position.PositionFilter (4.4) PositionFilter makes TokenStream graphs inconsistent which can cause highlighting bugs. Its main use-case being to make QueryParser generate boolean queries instead of phrase queries, it is now advised to use QueryParser.setAutoGeneratePhraseQueries(boolean) (for simple cases) or to override QueryParser.newFieldQuery.
org.apache.lucene.analysis.position.PositionFilterFactory (4.4)
org.apache.lucene.analysis.ru.RussianLetterTokenizer (3.1) Use StandardTokenizer instead, which has the same functionality. This filter will be removed in Lucene 5.0
org.apache.lucene.analysis.ru.RussianLetterTokenizerFactory Use StandardTokenizerFactory instead. This tokenizer has no Russian-specific functionality.
org.apache.lucene.analysis.cn.smart.SentenceTokenizer Use HMMChineseTokenizer instead
org.apache.lucene.document.ShortDocValuesField use NumericDocValuesField instead.
org.apache.lucene.queries.function.valuesource.ShortFieldSource
org.apache.lucene.sandbox.queries.SlowCollatedStringComparator Index collation keys with CollationKeyAnalyzer or ICUCollationKeyAnalyzer instead. This class will be removed in Lucene 5.0
org.apache.lucene.sandbox.queries.SlowCollatedTermRangeFilter Index collation keys with CollationKeyAnalyzer or ICUCollationKeyAnalyzer instead. This class will be removed in Lucene 5.0
org.apache.lucene.sandbox.queries.SlowCollatedTermRangeQuery Index collation keys with CollationKeyAnalyzer or ICUCollationKeyAnalyzer instead. This class will be removed in Lucene 5.0
org.apache.lucene.sandbox.queries.SlowCollatedTermRangeTermsEnum Index collation keys with CollationKeyAnalyzer or ICUCollationKeyAnalyzer instead. This class will be removed in Lucene 5.0
org.apache.lucene.sandbox.queries.SlowFuzzyQuery Use FuzzyQuery instead.
org.apache.lucene.sandbox.queries.SlowFuzzyTermsEnum Use FuzzyTermsEnum instead.
org.apache.lucene.analysis.cn.smart.SmartChineseSentenceTokenizerFactory Use HMMChineseTokenizerFactory instead
org.apache.lucene.analysis.cn.smart.SmartChineseWordTokenFilterFactory Use HMMChineseTokenizerFactory instead
org.apache.lucene.analysis.snowball.SnowballAnalyzer (3.1) Use the language-specific analyzer in modules/analysis instead. This analyzer will be removed in Lucene 5.0
org.apache.lucene.document.SortedBytesDocValuesField Use SortedDocValuesField instead.
org.apache.lucene.analysis.standard.std31.StandardTokenizerImpl31
org.apache.lucene.analysis.standard.std34.StandardTokenizerImpl34
org.apache.lucene.analysis.standard.std40.StandardTokenizerImpl40
org.apache.lucene.document.StraightBytesDocValuesField Use BinaryDocValuesField instead.
org.apache.lucene.analysis.th.ThaiWordFilter Use ThaiTokenizer instead.
org.apache.lucene.analysis.th.ThaiWordFilterFactory Use ThaiTokenizerFactory instead
org.apache.lucene.analysis.standard.std31.UAX29URLEmailTokenizerImpl31
org.apache.lucene.analysis.standard.std34.UAX29URLEmailTokenizerImpl34
org.apache.lucene.analysis.standard.std36.UAX29URLEmailTokenizerImpl36
org.apache.lucene.analysis.standard.std40.UAX29URLEmailTokenizerImpl40
org.apache.lucene.analysis.cn.smart.WordTokenFilter Use HMMChineseTokenizer instead.

Deprecated Enums

Enum and Description
org.apache.lucene.document.Field.Index This is here only to ease transition from the pre-4.0 APIs.
org.apache.lucene.document.Field.TermVector This is here only to ease transition from the pre-4.0 APIs.

Deprecated Fields

Field and Description
org.apache.lucene.analysis.standard.StandardTokenizer.ACRONYM (3.1)
org.apache.lucene.analysis.standard.StandardTokenizer.ACRONYM_DEP (3.1)
org.apache.lucene.analysis.standard.StandardTokenizer.APOSTROPHE (3.1)
org.apache.lucene.util.IOUtils.CHARSET_UTF_8 Use StandardCharsets.UTF_8 instead.
org.apache.lucene.analysis.standard.StandardTokenizer.CJ (3.1)
org.apache.lucene.analysis.standard.StandardTokenizer.COMPANY (3.1)
org.apache.lucene.search.FieldCache.DEFAULT_BYTE_PARSER
org.apache.lucene.search.FieldCache.DEFAULT_DOUBLE_PARSER
org.apache.lucene.search.FieldCache.DEFAULT_FLOAT_PARSER
org.apache.lucene.search.FieldCache.DEFAULT_INT_PARSER
org.apache.lucene.search.FieldCache.DEFAULT_LONG_PARSER
org.apache.lucene.analysis.pattern.PatternReplaceCharFilter.DEFAULT_MAX_BLOCK_CHARS
org.apache.lucene.store.FSDirectory.DEFAULT_READ_CHUNK_SIZE This constant is no longer used since Lucene 4.5.
org.apache.lucene.search.FieldCache.DEFAULT_SHORT_PARSER
org.apache.lucene.search.FuzzyQuery.defaultMinSimilarity pass integer edit distances instead.
org.apache.lucene.analysis.standard.StandardTokenizer.HOST (3.1)
org.apache.lucene.util.Constants.JRE_IS_MINIMUM_JAVA6 With Lucene 4.0, we are always on Java 6
org.apache.lucene.util.Constants.JRE_IS_MINIMUM_JAVA7 With Lucene 4.8, we are always on Java 7

Deprecated Methods

Method and Description
org.apache.lucene.index.SegmentInfo.attributes() no longer supported
org.apache.lucene.codecs.CodecUtil.checkEOF(IndexInput) Use CodecUtil.checkFooter(org.apache.lucene.store.ChecksumIndexInput) instead, this should only used for files without checksums
org.apache.lucene.queryparser.surround.query.SimpleTerm.compareTo(SimpleTerm) (March 2011) Not normally used, to be removed from Lucene 4.0. This class implementing Comparable is to be removed at the same time.
org.apache.lucene.search.IndexSearcher.document(int, Set<String>) Use IndexSearcher.doc(int, Set) instead.
org.apache.lucene.sandbox.queries.SlowCollatedTermRangeQuery.field() Use MultiTermQuery.getField() instead.
org.apache.lucene.store.Directory.fileExists(String) This method will be removed in 5.0
org.apache.lucene.search.FuzzyQuery.floatToEdits(float, int) pass integer edit distances instead.
org.apache.lucene.index.SegmentInfo.getAttribute(String) no longer supported
org.apache.lucene.search.FieldCache.getBytes(AtomicReader, String, boolean) (4.4) Index as a numeric field using IntField and then use FieldCache.getInts(AtomicReader, String, boolean) instead.
org.apache.lucene.search.FieldCache.getBytes(AtomicReader, String, FieldCache.ByteParser, boolean) (4.4) Index as a numeric field using IntField and then use FieldCache.getInts(AtomicReader, String, boolean) instead.
org.apache.lucene.queryparser.flexible.standard.parser.CharStream.getColumn()
org.apache.lucene.queryparser.surround.parser.CharStream.getColumn()
org.apache.lucene.queryparser.classic.CharStream.getColumn()
org.apache.lucene.queryparser.flexible.standard.parser.CharStream.getLine()
org.apache.lucene.queryparser.surround.parser.CharStream.getLine()
org.apache.lucene.queryparser.classic.CharStream.getLine()
org.apache.lucene.store.FSDirectory.getReadChunkSize() This is no longer used since Lucene 4.5.
org.apache.lucene.search.FieldCache.getShorts(AtomicReader, String, boolean) (4.4) Index as a numeric field using IntField and then use FieldCache.getInts(AtomicReader, String, boolean) instead.
org.apache.lucene.search.FieldCache.getShorts(AtomicReader, String, FieldCache.ShortParser, boolean) (4.4) Index as a numeric field using IntField and then use FieldCache.getInts(AtomicReader, String, boolean) instead.
org.apache.lucene.index.Fields.getUniqueTermCount() iterate fields and add their size() instead. this method is only provided as a transition mechanism to access this statistic for 3.x indexes, which do not have this statistic per-field.
org.apache.lucene.util.CharsRef.getUTF16SortedAsUTF8Comparator() This comparator is only a transition mechanism
org.apache.lucene.util.BytesRef.getUTF8SortedAsUTF16Comparator() This comparator is only a transition mechanism
org.apache.lucene.index.AtomicReader.hasNorms(String) (4.0) use AtomicReader.getFieldInfos() and check FieldInfo.hasNorms() for the field instead.
org.apache.lucene.search.FieldCacheRangeFilter.newByteRange(String, Byte, Byte, boolean, boolean)
org.apache.lucene.search.FieldCacheRangeFilter.newByteRange(String, FieldCache.ByteParser, Byte, Byte, boolean, boolean)
org.apache.lucene.search.FieldCacheRangeFilter.newShortRange(String, FieldCache.ShortParser, Short, Short, boolean, boolean)
org.apache.lucene.search.FieldCacheRangeFilter.newShortRange(String, Short, Short, boolean, boolean)
org.apache.lucene.index.IndexReader.open(Directory) Use DirectoryReader.open(Directory)
org.apache.lucene.index.IndexReader.open(Directory, int) Use DirectoryReader.open(Directory,int)
org.apache.lucene.index.IndexReader.open(IndexCommit) Use DirectoryReader.open(IndexCommit)
org.apache.lucene.index.IndexReader.open(IndexCommit, int) Use DirectoryReader.open(IndexCommit,int)
org.apache.lucene.index.IndexReader.open(IndexWriter, boolean) Use DirectoryReader.open(IndexWriter,boolean)
org.apache.lucene.store.Directory.IndexInputSlicer.openFullSlice() Only for reading CFS files from 3.x indexes.
org.apache.lucene.index.SegmentInfo.putAttribute(String, String) no longer supported
org.apache.lucene.store.IndexOutput.seek(long) (4.1) This method will be removed in Lucene 5.0
org.apache.lucene.queryparser.flexible.standard.StandardQueryParser.setDateResolution(Map<CharSequence, DateTools.Resolution>) this method was renamed to StandardQueryParser.setDateResolutionMap(Map)
org.apache.lucene.queryparser.flexible.standard.StandardQueryParser.setDefaultPhraseSlop(int) renamed to StandardQueryParser.setPhraseSlop(int)
org.apache.lucene.analysis.util.FilteringTokenFilter.setEnablePositionIncrements(boolean) enablePositionIncrements=false is not supported anymore as of Lucene 4.4
org.apache.lucene.store.FSDirectory.setReadChunkSize(int) This is no longer used since Lucene 4.5.
org.apache.lucene.document.Field.translateFieldType(Field.Store, Field.Index, Field.TermVector) This is here only to ease transition from the pre-4.0 APIs.
org.apache.lucene.index.SegmentInfos.write3xInfo(Directory, SegmentInfo, IOContext)

Deprecated Constructors

Constructor and Description
org.apache.lucene.analysis.AnalyzerWrapper() Use AnalyzerWrapper.AnalyzerWrapper(Analyzer.ReuseStrategy) and specify a valid Analyzer.ReuseStrategy, probably retrieved from the wrapped analyzer using Analyzer.getReuseStrategy().
org.apache.lucene.collation.CollationKeyAnalyzer(Collator) Use CollationKeyAnalyzer.CollationKeyAnalyzer(Version, Collator) and specify a version instead. This ctor will be removed in Lucene 5.0
org.apache.lucene.analysis.ngram.EdgeNGramTokenFilter(Version, TokenStream, EdgeNGramTokenFilter.Side, int, int)
org.apache.lucene.analysis.ngram.EdgeNGramTokenFilter(Version, TokenStream, String, int, int)
org.apache.lucene.analysis.en.EnglishPossessiveFilter(TokenStream) Use EnglishPossessiveFilter.EnglishPossessiveFilter(Version, TokenStream) instead.
org.apache.lucene.document.Field(String, byte[]) Use StoredField instead.
org.apache.lucene.document.Field(String, byte[], int, int) Use StoredField instead.
org.apache.lucene.document.Field(String, Reader) Use TextField instead.
org.apache.lucene.document.Field(String, Reader, Field.TermVector) Use TextField instead.
org.apache.lucene.document.Field(String, String, Field.Store, Field.Index) Use StringField, TextField instead.
org.apache.lucene.document.Field(String, String, Field.Store, Field.Index, Field.TermVector) Use StringField, TextField instead.
org.apache.lucene.document.Field(String, TokenStream) Use TextField instead
org.apache.lucene.document.Field(String, TokenStream, Field.TermVector) Use TextField instead
org.apache.lucene.analysis.util.FilteringTokenFilter(Version, boolean, TokenStream) enablePositionIncrements=false is not supported anymore as of Lucene 4.4
org.apache.lucene.analysis.Analyzer.GlobalReuseStrategy() Don't create instances of this class, use Analyzer.GLOBAL_REUSE_STRATEGY
org.apache.lucene.analysis.miscellaneous.KeepWordFilter(Version, boolean, TokenStream, CharArraySet) enablePositionIncrements=false is not supported anymore as of Lucene 4.4.
org.apache.lucene.analysis.miscellaneous.LengthFilter(Version, boolean, TokenStream, int, int) enablePositionIncrements=false is not supported anymore as of Lucene 4.4.
org.apache.lucene.analysis.ngram.Lucene43EdgeNGramTokenizer(Version, AttributeSource.AttributeFactory, Reader, Lucene43EdgeNGramTokenizer.Side, int, int)
org.apache.lucene.analysis.ngram.Lucene43EdgeNGramTokenizer(Version, AttributeSource.AttributeFactory, Reader, String, int, int)
org.apache.lucene.analysis.ngram.Lucene43EdgeNGramTokenizer(Version, Reader, Lucene43EdgeNGramTokenizer.Side, int, int)
org.apache.lucene.analysis.ngram.Lucene43EdgeNGramTokenizer(Version, Reader, String, int, int)
org.apache.lucene.analysis.pattern.PatternReplaceCharFilter(Pattern, String, int, String, Reader)
org.apache.lucene.analysis.Analyzer.PerFieldReuseStrategy() Don't create instances of this class, use Analyzer.PER_FIELD_REUSE_STRATEGY
org.apache.lucene.analysis.miscellaneous.TrimFilter(Version, TokenStream, boolean) Offset updates are not supported anymore as of Lucene 4.4.
org.apache.lucene.analysis.core.TypeTokenFilter(Version, boolean, TokenStream, Set<String>) enablePositionIncrements=false is not supported anymore as of Lucene 4.4.
org.apache.lucene.analysis.core.TypeTokenFilter(Version, boolean, TokenStream, Set<String>, boolean) enablePositionIncrements=false is not supported anymore as of Lucene 4.4.

Deprecated Enum Constants

Enum Constant and Description
org.apache.lucene.analysis.ngram.EdgeNGramTokenFilter.Side.BACK
org.apache.lucene.search.SortField.Type.BYTE
org.apache.lucene.util.Version.LUCENE_30 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_31 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_32 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_33 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_34 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_35 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_36 (4.0) Use latest
org.apache.lucene.util.Version.LUCENE_40 (4.1) Use latest
org.apache.lucene.util.Version.LUCENE_41 (4.2) Use latest
org.apache.lucene.util.Version.LUCENE_42 (4.3) Use latest
org.apache.lucene.util.Version.LUCENE_43 (4.4) Use latest
org.apache.lucene.util.Version.LUCENE_44 (4.5) Use latest
org.apache.lucene.util.Version.LUCENE_45 (4.6) Use latest
org.apache.lucene.util.Version.LUCENE_46 (4.7) Use latest
org.apache.lucene.util.Version.LUCENE_47 (4.8) Use latest
org.apache.lucene.util.Version.LUCENE_CURRENT Use an actual version instead.
org.apache.lucene.search.SortField.Type.SHORT