org.apache.lucene.codecs
Class TermVectorsReader

java.lang.Object
  extended by org.apache.lucene.codecs.TermVectorsReader
All Implemented Interfaces:
Closeable, Cloneable
Direct Known Subclasses:
CompressingTermVectorsReader, Lucene40TermVectorsReader

public abstract class TermVectorsReader
extends Object
implements Cloneable, Closeable

Codec API for reading term vectors:

WARNING: This API is experimental and might change in incompatible ways in the next release.

Constructor Summary
protected TermVectorsReader()
          Sole constructor.
 
Method Summary
abstract  TermVectorsReader clone()
          Create a clone that one caller at a time may use to read term vectors.
abstract  Fields get(int doc)
          Returns term vectors for this document, or null if term vectors were not indexed.
abstract  long ramBytesUsed()
          Returns approximate RAM bytes used
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.io.Closeable
close
 

Constructor Detail

TermVectorsReader

protected TermVectorsReader()
Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

get

public abstract Fields get(int doc)
                    throws IOException
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 DocsAndPositionsEnum.

Throws:
IOException

ramBytesUsed

public abstract long ramBytesUsed()
Returns approximate RAM bytes used


clone

public abstract TermVectorsReader clone()
Create a clone that one caller at a time may use to read term vectors.

Overrides:
clone in class Object


Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.