Module org.apache.lucene.core

Package org.apache.lucene.index

Class TermVectorsConsumerPerField

java.lang.Object

org.apache.lucene.index.TermsHashPerField

org.apache.lucene.index.TermVectorsConsumerPerField

All Implemented Interfaces:

Comparable<TermsHashPerField>

final class TermVectorsConsumerPerField
extends TermsHashPerField

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	TermVectorsConsumerPerField.TermVectorsPostingsArray

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	doVectorOffsets
private boolean	doVectorPayloads
private boolean	doVectorPositions
private boolean	doVectors
private final FieldInfo	fieldInfo
private final FieldInvertState	fieldState
private boolean	hasPayloads
private OffsetAttribute	offsetAttribute
private PayloadAttribute	payloadAttribute
private final BytesRefBlockPool	termBytePool
private TermFrequencyAttribute	termFreqAtt
private final TermVectorsConsumer	termsWriter
private TermVectorsConsumerPerField.TermVectorsPostingsArray	termVectorsPostingsArray

Fields inherited from class org.apache.lucene.index.TermsHashPerField

bytePool, indexOptions, postingsArray

Constructor Summary

Constructors

Constructor	Description
TermVectorsConsumerPerField(FieldInvertState invertState, TermVectorsConsumer termsHash, FieldInfo fieldInfo)

Method Summary

Modifier and Type	Method	Description
(package private) void	addTerm(int termID, int docID)	Called when a previously seen term is seen again.
(package private) ParallelPostingsArray	createPostingsArray(int size)	Creates a new postings array of the specified size.
(package private) void	finish()	Called once per field per document if term vectors are enabled, to write the vectors to RAMOutputStream, which is then quickly flushed to the real term vectors files in the Directory.
(package private) void	finishDocument()
private int	getTermFreq()
void	newPostingsArray()	Called when the postings array is initialized or resized.
(package private) void	newTerm(int termID, int docID)	Called when a term is seen for the first time.
(package private) boolean	start(IndexableField field, boolean first)	Start adding a new field instance; first is true if this is the first time this field name was seen in the document.
(package private) void	writeProx(TermVectorsConsumerPerField.TermVectorsPostingsArray postings, int termID)

Methods inherited from class org.apache.lucene.index.TermsHashPerField

add, compareTo, getFieldName, getNextPerField, getNumTerms, getSortedTermIDs, initReader, reinitHash, reset, sortTerms, writeByte, writeBytes, writeVInt

Methods inherited from class java.lang.Object

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

Field Details

termVectorsPostingsArray

private TermVectorsConsumerPerField.TermVectorsPostingsArray termVectorsPostingsArray

termsWriter

private final TermVectorsConsumer termsWriter

fieldState

private final FieldInvertState fieldState

fieldInfo

private final FieldInfo fieldInfo

doVectors

private boolean doVectors

doVectorPositions

private boolean doVectorPositions

doVectorOffsets

private boolean doVectorOffsets

doVectorPayloads

private boolean doVectorPayloads

offsetAttribute

private OffsetAttribute offsetAttribute

payloadAttribute

private PayloadAttribute payloadAttribute

termFreqAtt

private TermFrequencyAttribute termFreqAtt

termBytePool

private final BytesRefBlockPool termBytePool

hasPayloads

private boolean hasPayloads

Constructor Details

TermVectorsConsumerPerField

TermVectorsConsumerPerField(FieldInvertState invertState,
 TermVectorsConsumer termsHash,
 FieldInfo fieldInfo)

Method Details

finish

void finish()

Called once per field per document if term vectors are enabled, to write the vectors to RAMOutputStream, which is then quickly flushed to the real term vectors files in the Directory.

Overrides:

finish in class TermsHashPerField

finishDocument

void finishDocument()
             throws IOException

Throws:

IOException

start

boolean start(IndexableField field,
 boolean first)

Description copied from class: TermsHashPerField

Start adding a new field instance; first is true if this is the first time this field name was seen in the document.

Overrides:

start in class TermsHashPerField

writeProx

void writeProx(TermVectorsConsumerPerField.TermVectorsPostingsArray postings,
 int termID)

newTerm

void newTerm(int termID,
 int docID)

Description copied from class: TermsHashPerField

Called when a term is seen for the first time.

Specified by:

newTerm in class TermsHashPerField

addTerm

void addTerm(int termID,
 int docID)

Description copied from class: TermsHashPerField

Called when a previously seen term is seen again.

Specified by:

addTerm in class TermsHashPerField

getTermFreq

private int getTermFreq()

newPostingsArray

public void newPostingsArray()

Description copied from class: TermsHashPerField

Called when the postings array is initialized or resized.

Specified by:

newPostingsArray in class TermsHashPerField

createPostingsArray

ParallelPostingsArray createPostingsArray(int size)

Description copied from class: TermsHashPerField

Creates a new postings array of the specified size.

Specified by:

createPostingsArray in class TermsHashPerField