Module org.apache.lucene.codecs

Package org.apache.lucene.codecs.simpletext

Class SimpleTextTermVectorsReader

java.lang.Object

org.apache.lucene.index.TermVectors

org.apache.lucene.codecs.TermVectorsReader

org.apache.lucene.codecs.simpletext.SimpleTextTermVectorsReader

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable

public class SimpleTextTermVectorsReader
extends TermVectorsReader

Reads plain-text term vectors.

FOR RECREATIONAL USE ONLY

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SimpleTextTermVectorsReader.SimpleTVDocsEnum
private static class	SimpleTextTermVectorsReader.SimpleTVFields
private static class	SimpleTextTermVectorsReader.SimpleTVPostings
private static class	SimpleTextTermVectorsReader.SimpleTVPostingsEnum
private static class	SimpleTextTermVectorsReader.SimpleTVTerms
private static class	SimpleTextTermVectorsReader.SimpleTVTermsEnum

Field Summary

Fields

Modifier and Type	Field	Description
private IndexInput	in
private long[]	offsets
private BytesRefBuilder	scratch
private CharsRefBuilder	scratchUTF16

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
SimpleTextTermVectorsReader(long[] offsets, IndexInput in)
SimpleTextTermVectorsReader(Directory directory, SegmentInfo si, IOContext context)

Method Summary

Modifier and Type	Method	Description
void	checkIntegrity()	Checks consistency of this reader.
TermVectorsReader	clone()	Create a clone that one caller at a time may use to read term vectors.
void	close()
Fields	get(int doc)	Returns term vectors for this document, or null if term vectors were not indexed.
private int	parseIntAt(int offset)
private void	readIndex(int maxDoc)
private void	readLine()
private String	readString(int offset, BytesRefBuilder scratch)
String	toString()

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

getMergeInstance

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

get

Methods inherited from class java.lang.Object

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

Field Details

offsets

private long[] offsets

in

private IndexInput in

scratch

private BytesRefBuilder scratch

scratchUTF16

private CharsRefBuilder scratchUTF16

Constructor Details

SimpleTextTermVectorsReader

public SimpleTextTermVectorsReader(Directory directory,
 SegmentInfo si,
 IOContext context)
                            throws IOException

Throws:

IOException

SimpleTextTermVectorsReader

SimpleTextTermVectorsReader(long[] offsets,
 IndexInput in)

Method Details

readIndex

private void readIndex(int maxDoc)
                throws IOException

Throws:

IOException

get

public Fields get(int doc)
           throws IOException

Description copied from class: TermVectors

Returns term vectors for this document, or null if term vectors were not indexed.

The returned Fields instance acts like a single-document inverted index (the docID will be 0). If offsets are available they are in an OffsetAttribute available from the PostingsEnum.

Specified by:

get in class TermVectors

Throws:

IOException

clone

public TermVectorsReader clone()

Description copied from class: TermVectorsReader

Create a clone that one caller at a time may use to read term vectors.

Specified by:

clone in class TermVectorsReader

close

public void close()
           throws IOException

Throws:

IOException

readLine

private void readLine()
               throws IOException

Throws:

IOException

parseIntAt

private int parseIntAt(int offset)

readString

private String readString(int offset,
 BytesRefBuilder scratch)

toString

public String toString()

Overrides:

toString in class Object

checkIntegrity

public void checkIntegrity()
                    throws IOException

Description copied from class: TermVectorsReader

Checks consistency of this reader.

Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

Specified by:

checkIntegrity in class TermVectorsReader

Throws:

IOException