Class Overview
Base class for filtering TermPositions
implementations.
Summary
Public Methods |
byte[]
|
getPayload(byte[] data, int offset)
Returns the payload data at the current term position.
|
int
|
getPayloadLength()
Returns the length of the payload at the current term position.
|
boolean
|
isPayloadAvailable()
Checks if a payload can be loaded at this position.
|
int
|
nextPosition()
Returns next position in the current document.
|
[Expand]
Inherited Methods |
From class
org.apache.lucene.index.FilterIndexReader.FilterTermDocs
void
|
close()
Frees associated resources.
|
int
|
doc()
Returns the current document number.
|
int
|
freq()
Returns the frequency of the term within the current document.
|
boolean
|
next()
Moves to the next pair in the enumeration.
|
int
|
read(int[] docs, int[] freqs)
Attempts to read multiple entries from the enumeration, up to length of
docs.
|
void
|
seek(TermEnum termEnum)
Sets this to the data for the current term in a TermEnum .
|
void
|
seek(Term term)
Sets this to the data for a term.
|
boolean
|
skipTo(int i)
Skips entries to the first beyond the current whose document number is
greater than or equal to target.
|
|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
|
From interface
java.io.Closeable
|
From interface
org.apache.lucene.index.TermDocs
abstract
void
|
close()
Frees associated resources.
|
abstract
int
|
doc()
Returns the current document number.
|
abstract
int
|
freq()
Returns the frequency of the term within the current document.
|
abstract
boolean
|
next()
Moves to the next pair in the enumeration.
|
abstract
int
|
read(int[] docs, int[] freqs)
Attempts to read multiple entries from the enumeration, up to length of
docs.
|
abstract
void
|
seek(TermEnum termEnum)
Sets this to the data for the current term in a TermEnum .
|
abstract
void
|
seek(Term term)
Sets this to the data for a term.
|
abstract
boolean
|
skipTo(int target)
Skips entries to the first beyond the current whose document number is
greater than or equal to target.
|
|
From interface
org.apache.lucene.index.TermPositions
abstract
byte[]
|
getPayload(byte[] data, int offset)
Returns the payload data at the current term position.
|
abstract
int
|
getPayloadLength()
Returns the length of the payload at the current term position.
|
abstract
boolean
|
isPayloadAvailable()
Checks if a payload can be loaded at this position.
|
abstract
int
|
nextPosition()
Returns next position in the current document.
|
|
Public Constructors
Public Methods
public
byte[]
getPayload
(byte[] data, int offset)
Returns the payload data at the current term position.
This is invalid until nextPosition()
is called for
the first time.
This method must not be called more than once after each call
of nextPosition()
. However, payloads are loaded lazily,
so if the payload data for the current position is not needed,
this method may not be called at all for performance reasons.
Parameters
data
| the array into which the data of this payload is to be
stored, if it is big enough; otherwise, a new byte[] array
is allocated for this purpose. |
offset
| the offset in the array into which the data of this payload
is to be stored. |
Returns
- a byte[] array containing the data of this payload
public
int
getPayloadLength
()
Returns the length of the payload at the current term position.
This is invalid until nextPosition()
is called for
the first time.
Returns
- length of the current payload in number of bytes
public
boolean
isPayloadAvailable
()
Checks if a payload can be loaded at this position.
Payloads can only be loaded once per call to
nextPosition()
.
Returns
- true if there is a payload available at this position that can be loaded
public
int
nextPosition
()
Returns next position in the current document. It is an error to call
this more than freq()
times
without calling next()
This is
invalid until next()
is called for
the first time.