Package org.apache.lucene.codecs.compressing

Class CompressingTermVectorsReader.TVTerms

java.lang.Object

org.apache.lucene.index.Terms

org.apache.lucene.codecs.compressing.CompressingTermVectorsReader.TVTerms

Enclosing class:

CompressingTermVectorsReader

private static class CompressingTermVectorsReader.TVTerms
extends Terms

Field Summary

Fields

Modifier and Type	Field	Description
private int	flags
private int[]	lengths
private int	numTerms
private BytesRef	payloadBytes
private int[]	payloadIndex
private int[]	positionIndex
private int[]	positions
private int[]	prefixLengths
private int[]	startOffsets
private int[]	suffixLengths
private BytesRef	termBytes
private int[]	termFreqs
private long	totalTermFreq

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
TVTerms(int numTerms, int flags, int[] prefixLengths, int[] suffixLengths, int[] termFreqs, int[] positionIndex, int[] positions, int[] startOffsets, int[] lengths, int[] payloadIndex, BytesRef payloadBytes, BytesRef termBytes)

Method Summary

Modifier and Type	Method	Description
int	getDocCount()	Returns the number of documents that have at least one term for this field.
long	getSumDocFreq()	Returns the sum of TermsEnum.docFreq() for all terms in this field.
long	getSumTotalTermFreq()	Returns the sum of TermsEnum.totalTermFreq() for all terms in this field.
boolean	hasFreqs()	Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).
boolean	hasOffsets()	Returns true if documents in this field store offsets.
boolean	hasPayloads()	Returns true if documents in this field store payloads.
boolean	hasPositions()	Returns true if documents in this field store positions.
TermsEnum	iterator()	Returns an iterator that will step through all terms.
long	size()	Returns the number of terms for this field, or -1 if this measure isn't stored by the codec.

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

getMax, getMin, getStats, intersect

Methods inherited from class java.lang.Object

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

Field Detail

numTerms

private final int numTerms

flags

private final int flags

totalTermFreq

private final long totalTermFreq

prefixLengths

private final int[] prefixLengths

suffixLengths

private final int[] suffixLengths

termFreqs

private final int[] termFreqs

positionIndex

private final int[] positionIndex

positions

private final int[] positions

startOffsets

private final int[] startOffsets

lengths

private final int[] lengths

payloadIndex

private final int[] payloadIndex

termBytes

private final BytesRef termBytes

payloadBytes

private final BytesRef payloadBytes

Constructor Detail

TVTerms

TVTerms(int numTerms,
        int flags,
        int[] prefixLengths,
        int[] suffixLengths,
        int[] termFreqs,
        int[] positionIndex,
        int[] positions,
        int[] startOffsets,
        int[] lengths,
        int[] payloadIndex,
        BytesRef payloadBytes,
        BytesRef termBytes)

Method Detail

iterator

public TermsEnum iterator()
                   throws java.io.IOException

Description copied from class: Terms

Returns an iterator that will step through all terms. This method will not return null.

Specified by:

iterator in class Terms

Throws:

java.io.IOException

size

public long size()
          throws java.io.IOException

Description copied from class: Terms

Returns the number of terms for this field, or -1 if this measure isn't stored by the codec. Note that, just like other term measures, this measure does not take deleted documents into account.

Specified by:

size in class Terms

Throws:

java.io.IOException

getSumTotalTermFreq

public long getSumTotalTermFreq()
                         throws java.io.IOException

Description copied from class: Terms

Returns the sum of TermsEnum.totalTermFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.

Specified by:

getSumTotalTermFreq in class Terms

Throws:

java.io.IOException

getSumDocFreq

public long getSumDocFreq()
                   throws java.io.IOException

Description copied from class: Terms

Returns the sum of TermsEnum.docFreq() for all terms in this field. Note that, just like other term measures, this measure does not take deleted documents into account.

Specified by:

getSumDocFreq in class Terms

Throws:

java.io.IOException

getDocCount

public int getDocCount()
                throws java.io.IOException

Description copied from class: Terms

Returns the number of documents that have at least one term for this field. Note that, just like other term measures, this measure does not take deleted documents into account.

Specified by:

getDocCount in class Terms

Throws:

java.io.IOException

hasFreqs

public boolean hasFreqs()

Description copied from class: Terms

Returns true if documents in this field store per-document term frequency (PostingsEnum.freq()).

Specified by:

hasFreqs in class Terms

hasOffsets

public boolean hasOffsets()

Description copied from class: Terms

Returns true if documents in this field store offsets.

Specified by:

hasOffsets in class Terms

hasPositions

public boolean hasPositions()

Description copied from class: Terms

Returns true if documents in this field store positions.

Specified by:

hasPositions in class Terms

hasPayloads

public boolean hasPayloads()

Description copied from class: Terms

Returns true if documents in this field store payloads.

Specified by:

hasPayloads in class Terms