Package org.apache.lucene.index

Class DefaultIndexingChain

java.lang.Object

org.apache.lucene.index.DocConsumer

org.apache.lucene.index.DefaultIndexingChain

All Implemented Interfaces:

Accountable

final class DefaultIndexingChain
extends DocConsumer

Default general purpose indexing chain, which handles indexing all types of fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	DefaultIndexingChain.IntBlockAllocator
private final class	DefaultIndexingChain.PerField	NOTE: not static: accesses at least docState, termsHash.

Field Summary

Fields

Modifier and Type	Field	Description
private final Consumer<Throwable>	abortingExceptionConsumer
private final ByteBlockPool.Allocator	byteBlockAllocator
(package private) final Counter	bytesUsed
private DefaultIndexingChain.PerField[]	fieldHash
(package private) final FieldInfos.Builder	fieldInfos
private DefaultIndexingChain.PerField[]	fields
private boolean	hasHitAbortingException
private int	hashMask
private final int	indexCreatedVersionMajor
private final LiveIndexWriterConfig	indexWriterConfig
private final InfoStream	infoStream
private long	nextFieldGen
(package private) final StoredFieldsConsumer	storedFieldsConsumer
(package private) final TermsHash	termsHash
(package private) final TermVectorsConsumer	termVectorsWriter
private int	totalFieldCount

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
DefaultIndexingChain(int indexCreatedVersionMajor, SegmentInfo segmentInfo, Directory directory, FieldInfos.Builder fieldInfos, LiveIndexWriterConfig indexWriterConfig, Consumer<Throwable> abortingExceptionConsumer)

Method Summary

Modifier and Type	Method	Description
void	abort()
private void	finishStoredFields()	Calls StoredFieldsWriter.finishDocument, aborting the segment if it hits any exception.
Sorter.DocMap	flush(SegmentWriteState state)
Collection<Accountable>	getChildResources()	Returns nested resources of this class.
private LeafReader	getDocValuesLeafReader()
(package private) DocIdSetIterator	getHasDocValues(String field)	Returns a DocIdSetIterator for the given field or null if the field doesn't have doc values.
private DefaultIndexingChain.PerField	getOrAddField(String name, IndexableFieldType fieldType, boolean invert)	Returns a previously created DefaultIndexingChain.PerField, absorbing the type information from FieldType, and creates a new DefaultIndexingChain.PerField if this field name wasn't seen yet.
private DefaultIndexingChain.PerField	getPerField(String name)	Returns a previously created DefaultIndexingChain.PerField, or null if this field name wasn't seen yet.
private void	indexDocValue(int docID, DefaultIndexingChain.PerField fp, DocValuesType dvType, IndexableField field)	Called from processDocument to index one field's doc value
private void	indexPoint(int docID, DefaultIndexingChain.PerField fp, IndexableField field)	Called from processDocument to index one field's point
private void	initIndexOptions(FieldInfo info, IndexOptions indexOptions)
private Sorter.DocMap	maybeSortSegment(SegmentWriteState state)
private void	onAbortingException(Throwable th)
void	processDocument(int docID, Iterable<? extends IndexableField> document)
private int	processField(int docID, IndexableField field, long fieldGen, int fieldCount)
long	ramBytesUsed()	Return the memory usage of this object in bytes.
private void	rehash()
private void	startStoredFields(int docID)	Calls StoredFieldsWriter.startDocument, aborting the segment if it hits any exception.
private void	validateIndexSortDVType(Sort indexSort, String fieldToValidate, DocValuesType dvType)
private static void	verifyUnIndexedFieldType(String name, IndexableFieldType ft)
private void	writeDocValues(SegmentWriteState state, Sorter.DocMap sortMap)	Writes all buffered doc values (called from flush(org.apache.lucene.index.SegmentWriteState)).
private void	writeNorms(SegmentWriteState state, Sorter.DocMap sortMap)
private void	writePoints(SegmentWriteState state, Sorter.DocMap sortMap)	Writes all buffered points.

Methods inherited from class java.lang.Object

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

Field Details

bytesUsed

final Counter bytesUsed

fieldInfos

final FieldInfos.Builder fieldInfos

termsHash

final TermsHash termsHash

storedFieldsConsumer

final StoredFieldsConsumer storedFieldsConsumer

termVectorsWriter

final TermVectorsConsumer termVectorsWriter

fieldHash

private DefaultIndexingChain.PerField[] fieldHash

hashMask

private int hashMask

totalFieldCount

private int totalFieldCount

nextFieldGen

private long nextFieldGen

fields

private DefaultIndexingChain.PerField[] fields

infoStream

private final InfoStream infoStream

byteBlockAllocator

private final ByteBlockPool.Allocator byteBlockAllocator

indexWriterConfig

private final LiveIndexWriterConfig indexWriterConfig

indexCreatedVersionMajor

private final int indexCreatedVersionMajor

abortingExceptionConsumer

private final Consumer<Throwable> abortingExceptionConsumer

hasHitAbortingException

private boolean hasHitAbortingException

Constructor Details

DefaultIndexingChain

DefaultIndexingChain(int indexCreatedVersionMajor,
 SegmentInfo segmentInfo,
 Directory directory,
 FieldInfos.Builder fieldInfos,
 LiveIndexWriterConfig indexWriterConfig,
 Consumer<Throwable> abortingExceptionConsumer)

Method Details

onAbortingException

private void onAbortingException(Throwable th)

getDocValuesLeafReader

private LeafReader getDocValuesLeafReader()

maybeSortSegment

private Sorter.DocMap maybeSortSegment(SegmentWriteState state)
                                throws IOException

Throws:

IOException

flush

public Sorter.DocMap flush(SegmentWriteState state)
                    throws IOException

Specified by:

flush in class DocConsumer

Throws:

IOException

writePoints

private void writePoints(SegmentWriteState state,
 Sorter.DocMap sortMap)
                  throws IOException

Writes all buffered points.

Throws:

IOException

writeDocValues

private void writeDocValues(SegmentWriteState state,
 Sorter.DocMap sortMap)
                     throws IOException

Writes all buffered doc values (called from flush(org.apache.lucene.index.SegmentWriteState)).

Throws:

IOException

writeNorms

private void writeNorms(SegmentWriteState state,
 Sorter.DocMap sortMap)
                 throws IOException

Throws:

IOException

abort

public void abort()
           throws IOException

Specified by:

abort in class DocConsumer

Throws:

IOException

rehash

private void rehash()

startStoredFields

private void startStoredFields(int docID)
                        throws IOException

Calls StoredFieldsWriter.startDocument, aborting the segment if it hits any exception.

Throws:

IOException

finishStoredFields

private void finishStoredFields()
                         throws IOException

Calls StoredFieldsWriter.finishDocument, aborting the segment if it hits any exception.

Throws:

IOException

processDocument

public void processDocument(int docID,
 Iterable<? extends IndexableField> document)
                     throws IOException

Specified by:

processDocument in class DocConsumer

Throws:

IOException

processField

private int processField(int docID,
 IndexableField field,
 long fieldGen,
 int fieldCount)
                  throws IOException

Throws:

IOException

verifyUnIndexedFieldType

private static void verifyUnIndexedFieldType(String name,
 IndexableFieldType ft)

indexPoint

private void indexPoint(int docID,
 DefaultIndexingChain.PerField fp,
 IndexableField field)

Called from processDocument to index one field's point

validateIndexSortDVType

private void validateIndexSortDVType(Sort indexSort,
 String fieldToValidate,
 DocValuesType dvType)
                              throws IOException

Throws:

IOException

indexDocValue

private void indexDocValue(int docID,
 DefaultIndexingChain.PerField fp,
 DocValuesType dvType,
 IndexableField field)
                    throws IOException

Called from processDocument to index one field's doc value

Throws:

IOException

getPerField

private DefaultIndexingChain.PerField getPerField(String name)

Returns a previously created DefaultIndexingChain.PerField, or null if this field name wasn't seen yet.

getOrAddField

private DefaultIndexingChain.PerField getOrAddField(String name,
 IndexableFieldType fieldType,
 boolean invert)

Returns a previously created DefaultIndexingChain.PerField, absorbing the type information from FieldType, and creates a new DefaultIndexingChain.PerField if this field name wasn't seen yet.

initIndexOptions

private void initIndexOptions(FieldInfo info,
 IndexOptions indexOptions)

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

getChildResources

public Collection<Accountable> getChildResources()

Description copied from interface: Accountable

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

See Also:

• Accountables

getHasDocValues

DocIdSetIterator getHasDocValues(String field)

Description copied from class: DocConsumer

Returns a DocIdSetIterator for the given field or null if the field doesn't have doc values.

Specified by:

getHasDocValues in class DocConsumer