Module org.apache.lucene.core

Package org.apache.lucene.index

Class FieldUpdatesBuffer

java.lang.Object

org.apache.lucene.index.FieldUpdatesBuffer

final class FieldUpdatesBuffer
extends Object

This class efficiently buffers numeric and binary field updates and stores terms, values and metadata in a memory efficient way without creating large amounts of objects. Update terms are stored without de-duplicating the update term. In general we try to optimize for several use-cases. For instance we try to use constant space for update terms field since the common case always updates on the same field. Also for docUpTo we try to optimize for the case when updates should be applied to all docs ie. docUpTo=Integer.MAX_VALUE. In other cases each update will likely have a different docUpTo. Along the same lines this impl optimizes the case when all updates have a value. Lastly, if all updates share the same value for a numeric field we only store the value once.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	FieldUpdatesBuffer.BufferedUpdate	Struct like class that is used to iterate over all updates in this buffer
(package private) class	FieldUpdatesBuffer.BufferedUpdateIterator	An iterator that iterates over all updates in insertion order

Field Summary

Fields

Modifier and Type	Field	Description
private final Counter	bytesUsed
private final BytesRefArray	byteValues
private int[]	docsUpTo
private String[]	fields
private boolean	finished
private FixedBitSet	hasValues
private final boolean	isNumeric
private long	maxNumeric
private long	minNumeric
private long[]	numericValues
private int	numUpdates
private static final long	SELF_SHALLOW_SIZE
private static final long	STRING_SHALLOW_SIZE
private BytesRefArray.SortState	termSortState
private final BytesRefArray	termValues

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	FieldUpdatesBuffer(Counter bytesUsed, DocValuesUpdate.BinaryDocValuesUpdate initialValue, int docUpTo)
(package private)	FieldUpdatesBuffer(Counter bytesUsed, DocValuesUpdate.NumericDocValuesUpdate initialValue, int docUpTo)
private	FieldUpdatesBuffer(Counter bytesUsed, DocValuesUpdate initialValue, int docUpTo, boolean isNumeric)

Method Summary

Modifier and Type	Method	Description
(package private) void	add(String field, int docUpTo, int ord, boolean hasValue)
(package private) void	addNoValue(Term term, int docUpTo)
(package private) void	addUpdate(Term term, long value, int docUpTo)
(package private) void	addUpdate(Term term, BytesRef value, int docUpTo)
private int	append(Term term)
private boolean	assertTermAndDocInOrder()
(package private) void	finish()
private static int	getArrayIndex(int arrayLength, int index)
(package private) long	getMaxNumeric()
(package private) long	getMinNumeric()
(package private) long	getNumericValue(int idx)
(package private) boolean	hasSingleValue()
(package private) boolean	isNumeric()
(package private) FieldUpdatesBuffer.BufferedUpdateIterator	iterator()
private static long	sizeOfString(String string)

Methods inherited from class java.lang.Object

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

Field Details

SELF_SHALLOW_SIZE

private static final long SELF_SHALLOW_SIZE

STRING_SHALLOW_SIZE

private static final long STRING_SHALLOW_SIZE

bytesUsed

private final Counter bytesUsed

numUpdates

private int numUpdates

termValues

private final BytesRefArray termValues

termSortState

private BytesRefArray.SortState termSortState

byteValues

private final BytesRefArray byteValues

docsUpTo

private int[] docsUpTo

numericValues

private long[] numericValues

hasValues

private FixedBitSet hasValues

maxNumeric

private long maxNumeric

minNumeric

private long minNumeric

fields

private String[] fields

isNumeric

private final boolean isNumeric

finished

private boolean finished

Constructor Details

FieldUpdatesBuffer

private FieldUpdatesBuffer(Counter bytesUsed,
 DocValuesUpdate initialValue,
 int docUpTo,
 boolean isNumeric)

FieldUpdatesBuffer

FieldUpdatesBuffer(Counter bytesUsed,
 DocValuesUpdate.NumericDocValuesUpdate initialValue,
 int docUpTo)

FieldUpdatesBuffer

FieldUpdatesBuffer(Counter bytesUsed,
 DocValuesUpdate.BinaryDocValuesUpdate initialValue,
 int docUpTo)

Method Details

sizeOfString

private static long sizeOfString(String string)

getMaxNumeric

long getMaxNumeric()

getMinNumeric

long getMinNumeric()

add

void add(String field,
 int docUpTo,
 int ord,
 boolean hasValue)

addUpdate

void addUpdate(Term term,
 long value,
 int docUpTo)

addNoValue

void addNoValue(Term term,
 int docUpTo)

addUpdate

void addUpdate(Term term,
 BytesRef value,
 int docUpTo)

append

private int append(Term term)

finish

void finish()

assertTermAndDocInOrder

private boolean assertTermAndDocInOrder()

iterator

FieldUpdatesBuffer.BufferedUpdateIterator iterator()

isNumeric

boolean isNumeric()

hasSingleValue

boolean hasSingleValue()

getNumericValue

long getNumericValue(int idx)

getArrayIndex

private static int getArrayIndex(int arrayLength,
 int index)