org.apache.lucene.codecs.simpletext

Class SimpleTextTermVectorsReader

java.lang.Object

org.apache.lucene.codecs.TermVectorsReader

org.apache.lucene.codecs.simpletext.SimpleTextTermVectorsReader

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, Accountable

public class SimpleTextTermVectorsReader
extends TermVectorsReader

Reads plain-text term vectors.

FOR RECREATIONAL USE ONLY

Constructor Summary

Constructors

Constructor and Description
SimpleTextTermVectorsReader(Directory directory, SegmentInfo si, IOContext context)

Method Summary

Modifier and Type	Method and 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.
Collection<Accountable>	getChildResources() Returns nested resources of this class.
long	ramBytesUsed() Return the memory usage of this object in bytes.
String	toString()

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

getMergeInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleTextTermVectorsReader

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

Throws:

IOException

Method Detail

get

public Fields get(int doc)
           throws IOException

Description copied from class: TermVectorsReader

Returns term vectors for this document, or null if term vectors were not indexed. If offsets are available they are in an OffsetAttribute available from the PostingsEnum.

Specified by:

get in class TermVectorsReader

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

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

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