Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextSkipReader

java.lang.Object

org.apache.lucene.codecs.MultiLevelSkipListReader

org.apache.lucene.codecs.simpletext.SimpleTextSkipReader

All Implemented Interfaces:

Closeable, AutoCloseable

class SimpleTextSkipReader
extends MultiLevelSkipListReader

This class reads skip lists with multiple levels.

See SimpleTextFieldsWriter for the information about the encoding of the multi level skip lists.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	hasSkipList
private Impacts	impacts
private long	nextSkipDocFP
private int	numLevels
private List<List<Impact>>	perLevelImpacts
private final BytesRefBuilder	scratch
private final CharsRefBuilder	scratchUTF16

Fields inherited from class org.apache.lucene.codecs.MultiLevelSkipListReader

maxNumberOfSkipLevels, numberOfSkipLevels, skipDoc

Constructor Summary

Constructors

Constructor	Description
SimpleTextSkipReader(IndexInput skipStream)

Method Summary

Modifier and Type	Method	Description
(package private) Impacts	getImpacts()
(package private) int	getNextSkipDoc()
(package private) long	getNextSkipDocFP()
(package private) boolean	hasSkipList()
private void	init()
protected long	readChildPointer(IndexInput skipStream)	read the child pointer written via MultiLevelSkipListWriter.writeChildPointer(long, DataOutput).
protected long	readLevelLength(IndexInput skipStream)	read the length of the current level written via MultiLevelSkipListWriter.writeLevelLength(long, IndexOutput).
protected int	readSkipData(int level, IndexInput skipStream)	Subclasses must implement the actual skip data encoding in this method.
(package private) void	reset(long skipPointer, int docFreq)
int	skipTo(int target)	Skips entries to the first beyond the current whose document number is greater than or equal to target.

Methods inherited from class org.apache.lucene.codecs.MultiLevelSkipListReader

close, getDoc, init, seekChild, setLastSkipData

Methods inherited from class java.lang.Object

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

Field Details

scratchUTF16

private final CharsRefBuilder scratchUTF16

scratch

private final BytesRefBuilder scratch

impacts

private Impacts impacts

perLevelImpacts

private List<List<Impact>> perLevelImpacts

nextSkipDocFP

private long nextSkipDocFP

numLevels

private int numLevels

hasSkipList

private boolean hasSkipList

Constructor Details

SimpleTextSkipReader

SimpleTextSkipReader(IndexInput skipStream)

Method Details

skipTo

public int skipTo(int target)
           throws IOException

Description copied from class: MultiLevelSkipListReader

Skips entries to the first beyond the current whose document number is greater than or equal to target. Returns the current doc count.

Overrides:

skipTo in class MultiLevelSkipListReader

Throws:

IOException

readSkipData

protected int readSkipData(int level,
 IndexInput skipStream)
                    throws IOException

Description copied from class: MultiLevelSkipListReader

Subclasses must implement the actual skip data encoding in this method.

Specified by:

readSkipData in class MultiLevelSkipListReader

Parameters:

level - the level skip data shall be read from

skipStream - the skip stream to read from

Throws:

IOException

readLevelLength

protected long readLevelLength(IndexInput skipStream)
                        throws IOException

Description copied from class: MultiLevelSkipListReader

read the length of the current level written via MultiLevelSkipListWriter.writeLevelLength(long, IndexOutput).

Overrides:

readLevelLength in class MultiLevelSkipListReader

Parameters:

skipStream - the IndexInput the length shall be read from

Returns:

level length

Throws:

IOException

readChildPointer

protected long readChildPointer(IndexInput skipStream)
                         throws IOException

Description copied from class: MultiLevelSkipListReader

read the child pointer written via MultiLevelSkipListWriter.writeChildPointer(long, DataOutput).

Overrides:

readChildPointer in class MultiLevelSkipListReader

Parameters:

skipStream - the IndexInput the child pointer shall be read from

Returns:

child pointer

Throws:

IOException

reset

void reset(long skipPointer,
 int docFreq)
    throws IOException

Throws:

IOException

init

private void init()

getImpacts

Impacts getImpacts()

getNextSkipDocFP

long getNextSkipDocFP()

getNextSkipDoc

int getNextSkipDoc()

hasSkipList

boolean hasSkipList()