de.digitalcollections.solrocr.lucene.byteoffset

Class ByteOffsetsEnum

java.lang.Object

de.digitalcollections.solrocr.lucene.byteoffset.ByteOffsetsEnum

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<ByteOffsetsEnum>

Direct Known Subclasses:

ByteOffsetsEnum.MultiByteOffsetsEnum, ByteOffsetsEnum.OfPostings

public abstract class ByteOffsetsEnum
extends Object
implements Comparable<ByteOffsetsEnum>, Closeable

Customization of OffsetsEnum to load the byte offset from payloads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ByteOffsetsEnum.MultiByteOffsetsEnum
static class	ByteOffsetsEnum.OfPostings

Field Summary

Fields

Modifier and Type	Field and Description
static ByteOffsetsEnum	EMPTY

Constructor Summary

Constructors

Constructor and Description
ByteOffsetsEnum()

Method Summary

Modifier and Type	Method and Description
abstract int	byteOffset()
void	close()
int	compareTo(ByteOffsetsEnum other)
abstract int	freq()
abstract org.apache.lucene.util.BytesRef	getTerm()
abstract boolean	nextPosition()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final ByteOffsetsEnum EMPTY

Constructor Detail

ByteOffsetsEnum

public ByteOffsetsEnum()

Method Detail

compareTo

public int compareTo(ByteOffsetsEnum other)

Specified by:

compareTo in interface Comparable<ByteOffsetsEnum>

nextPosition

public abstract boolean nextPosition()
                              throws IOException

Throws:

IOException

freq

public abstract int freq()
                  throws IOException

Throws:

IOException

getTerm

public abstract org.apache.lucene.util.BytesRef getTerm()
                                                 throws IOException

Throws:

IOException

byteOffset

public abstract int byteOffset()
                        throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object