org.sindice.siren.index

Class SirenDocsEnum

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.index.DocsEnum

org.apache.lucene.index.DocsAndPositionsEnum

org.sindice.siren.index.SirenDocsEnum

public abstract class SirenDocsEnum
extends org.apache.lucene.index.DocsAndPositionsEnum

This DocsAndPositionsEnum extension acts as a decorator over a DocsNodesAndPositionsEnum.

It enables to provide a DocsNodesAndPositionsEnum instance to a NodeQuery.

Subclasses must wrap a DocsNodesAndPositionsEnum instance and implements the method getDocsNodesAndPositionsEnum() to return the wrapped instance.

Field Summary

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

FLAG_OFFSETS, FLAG_PAYLOADS

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

FLAG_FREQS

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

Constructor Summary

Constructors

Constructor and Description
SirenDocsEnum()

Method Summary

Methods

Modifier and Type	Method and Description
abstract DocsNodesAndPositionsEnum	getDocsNodesAndPositionsEnum()
static DocsNodesAndPositionsEnum	map(org.apache.lucene.index.DocsAndPositionsEnum docsEnum) Helper method to map a Lucene's DocsAndPositionsEnum to a SIREn's DocsNodesAndPositionsEnum.

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

endOffset, getPayload, nextPosition, startOffset

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

attributes, freq

Methods inherited from class org.apache.lucene.search.DocIdSetIterator

advance, docID, nextDoc

Methods inherited from class java.lang.Object

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

Constructor Detail

SirenDocsEnum

public SirenDocsEnum()

Method Detail

getDocsNodesAndPositionsEnum

public abstract DocsNodesAndPositionsEnum getDocsNodesAndPositionsEnum()

map

public static DocsNodesAndPositionsEnum map(org.apache.lucene.index.DocsAndPositionsEnum docsEnum)

Helper method to map a Lucene's DocsAndPositionsEnum to a SIREn's DocsNodesAndPositionsEnum.