RamAccountingTermsEnum (elasticsearch-extend 3.2 API)

java.lang.Object
- org.apache.lucene.index.TermsEnum
- - org.apache.lucene.index.FilteredTermsEnum
  - - org.elasticsearch.index.fielddata.RamAccountingTermsEnum

All Implemented Interfaces:

BytesRefIterator
```
public final class RamAccountingTermsEnum
extends FilteredTermsEnum
```
TermsEnum that takes a CircuitBreaker, increasing the breaker every time .next(...) is called. Proxies all methods to the original TermsEnum otherwise.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.lucene.index.FilteredTermsEnum
  FilteredTermsEnum.AcceptStatus
- Nested classes/interfaces inherited from class org.apache.lucene.index.TermsEnum
  TermsEnum.SeekStatus

Field Summary
- Fields inherited from class org.apache.lucene.index.FilteredTermsEnum
  actualTerm, tenum
- Fields inherited from class org.apache.lucene.index.TermsEnum
  EMPTY

Constructor Summary

Constructors
Constructor	Description
`RamAccountingTermsEnum(TermsEnum termsEnum, CircuitBreaker breaker, AbstractIndexFieldData.PerValueEstimator estimator, String fieldName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected FilteredTermsEnum.AcceptStatus`	`accept(BytesRef term)`	Always accept the term.
`void`	`flush()`	Flush the `flushBuffer` to the breaker, incrementing the total bytes and resetting the buffer.
`long`	`getTotalBytes()`
`BytesRef`	`next()`	Proxy to the original next() call, but estimates the overhead of loading the next term.

Methods inherited from class org.apache.lucene.index.FilteredTermsEnum
attributes, docFreq, impacts, nextSeekTerm, ord, postings, seekCeil, seekExact, seekExact, seekExact, setInitialSeekTerm, term, termState, totalTermFreq

Methods inherited from class org.apache.lucene.index.TermsEnum
postings

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RamAccountingTermsEnum
```
public RamAccountingTermsEnum(TermsEnum termsEnum,
                              CircuitBreaker breaker,
                              AbstractIndexFieldData.PerValueEstimator estimator,
                              String fieldName)
```
- Method Detail
  - accept
```
protected FilteredTermsEnum.AcceptStatus accept(BytesRef term)
                                         throws IOException
```
    Always accept the term.
    
    Specified by:
    
    accept in class FilteredTermsEnum
    
    Throws:
    
    IOException
  - flush
```
public void flush()
```
    Flush the flushBuffer to the breaker, incrementing the total bytes and resetting the buffer.
  - next
```
public BytesRef next()
              throws IOException
```
    Proxy to the original next() call, but estimates the overhead of loading the next term.
    
    Specified by:
    
    next in interface BytesRefIterator
    
    Overrides:
    
    next in class FilteredTermsEnum
    
    Returns:
    
    the next BytesRef in the iterator or null if the end of the iterator is reached.
    
    Throws:
    
    IOException - If there is a low-level I/O error.
  - getTotalBytes
```
public long getTotalBytes()
```
    Returns:
    
    the total number of bytes that have been aggregated