CommonGramsTokenFilterDescriptor (Atlassian Confluence 8.0.0-m90 API)

java.lang.Object
- com.atlassian.confluence.search.v2.analysis.CommonGramsTokenFilterDescriptor

All Implemented Interfaces:

TokenFilterDescriptor
```
public final class CommonGramsTokenFilterDescriptor
extends Object
implements TokenFilterDescriptor
```
Token filter that generates bigrams for frequently occurring terms. Single terms are still indexed. It can be used as an alternative to the Stop Token Filter when we don’t want to completely ignore common terms

Since:

7.0

- Constructor Summary
  
  Constructors
  Constructor Description
  
  CommonGramsTokenFilterDescriptor(Collection<String> commonWords, boolean queryMode)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Collection<String> getCommonWords()
  
  boolean isQueryMode()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CommonGramsTokenFilterDescriptor
```
public CommonGramsTokenFilterDescriptor(Collection<String> commonWords,
                                        boolean queryMode)
```
    Parameters:
    
    commonWords - list of common words
    
    queryMode - whether to optimize for query which means only returning single words when they are not a member of a bigram.
- Method Detail
  - getCommonWords
```
public Collection<String> getCommonWords()
```
  - isQueryMode
```
public boolean isQueryMode()
```