TruncateTokenFilter (Lucene 9.6.0 common API)

java.lang.Object
- org.apache.lucene.util.AttributeSource
- - org.apache.lucene.analysis.TokenStream
  - - org.apache.lucene.analysis.TokenFilter
    - - org.apache.lucene.analysis.miscellaneous.TruncateTokenFilter

All Implemented Interfaces:

Closeable, AutoCloseable, Unwrappable<TokenStream>
```
public final class TruncateTokenFilter
extends TokenFilter
```
A token filter for truncating the terms into a specific length. Fixed prefix truncation, as a stemming method, produces good results on Turkish language. It is reported that F5, using first 5 characters, produced best results in Information Retrieval on Turkish Texts

- Nested Class Summary
  - Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
    AttributeSource.State
- Field Summary
  - Fields inherited from class org.apache.lucene.analysis.TokenFilter
    input
  - Fields inherited from class org.apache.lucene.analysis.TokenStream
    DEFAULT_TOKEN_ATTRIBUTE_FACTORY
- Constructor Summary
  
  Constructors
  Constructor Description
  
  TruncateTokenFilter(TokenStream input, int length)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  boolean incrementToken()
  - Methods inherited from class org.apache.lucene.analysis.TokenFilter
    close, end, reset, unwrap
  - Methods inherited from class org.apache.lucene.util.AttributeSource
    addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, copyTo, endAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, reflectAsString, reflectWith, removeAllAttributes, restoreState, toString
  - Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TruncateTokenFilter

public TruncateTokenFilter(TokenStream input,
                           int length)

Method Detail
- incrementToken
```
public final boolean incrementToken()
                             throws IOException
```
  Specified by:
  
  incrementToken in class TokenStream
  
  Throws:
  
  IOException