org.elasticsearch.index.fielddata.plain

Class PackedArrayIndexFieldData.PackedArrayEstimator

java.lang.Object

org.elasticsearch.index.fielddata.plain.PackedArrayIndexFieldData.PackedArrayEstimator

All Implemented Interfaces:

AbstractIndexFieldData.PerValueEstimator

Enclosing class:

PackedArrayIndexFieldData

public class PackedArrayIndexFieldData.PackedArrayEstimator
extends Object
implements AbstractIndexFieldData.PerValueEstimator

Estimator that wraps numeric field data loading in a RamAccountingTermsEnum, adjusting the breaker after data has been loaded

Constructor Summary

Constructors

Constructor and Description
PackedArrayIndexFieldData.PackedArrayEstimator(CircuitBreaker breaker, IndexNumericFieldData.NumericType type, String fieldName)

Method Summary

Methods

Modifier and Type	Method and Description
void	adjustForNoTerms(long actualUsed) Adjust the breaker when no terms were actually loaded, but the field data takes up space regardless.
void	afterLoad(org.apache.lucene.index.TermsEnum termsEnum, long actualUsed) Adjusts the breaker based on the aggregated value from the RamAccountingTermsEnum
org.apache.lucene.index.TermsEnum	beforeLoad(org.apache.lucene.index.Terms terms) Execute any pre-loading estimations for the terms.
long	bytesPerValue(org.apache.lucene.util.BytesRef term)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PackedArrayIndexFieldData.PackedArrayEstimator

public PackedArrayIndexFieldData.PackedArrayEstimator(CircuitBreaker breaker,
                                              IndexNumericFieldData.NumericType type,
                                              String fieldName)

Method Detail

bytesPerValue

public long bytesPerValue(org.apache.lucene.util.BytesRef term)

Specified by:

bytesPerValue in interface AbstractIndexFieldData.PerValueEstimator

Returns:

number of bytes per term, based on the NumericValue.requiredBits()

beforeLoad

public org.apache.lucene.index.TermsEnum beforeLoad(org.apache.lucene.index.Terms terms)
                                             throws IOException

Description copied from interface: AbstractIndexFieldData.PerValueEstimator

Execute any pre-loading estimations for the terms. May also optionally wrap a TermsEnum in a RamAccountingTermsEnum which will estimate the memory on a per-term basis.

Specified by:

beforeLoad in interface AbstractIndexFieldData.PerValueEstimator

Parameters:

terms - terms to be estimated

Returns:

A TermsEnum wrapped in a RamAccountingTermsEnum

Throws:

IOException

afterLoad

public void afterLoad(org.apache.lucene.index.TermsEnum termsEnum,
             long actualUsed)

Adjusts the breaker based on the aggregated value from the RamAccountingTermsEnum

Specified by:

afterLoad in interface AbstractIndexFieldData.PerValueEstimator

Parameters:

termsEnum - terms that were wrapped and loaded

actualUsed - actual field data memory usage

adjustForNoTerms

public void adjustForNoTerms(long actualUsed)

Adjust the breaker when no terms were actually loaded, but the field data takes up space regardless. For instance, when ordinals are used.

Parameters:

actualUsed - bytes actually used