org.apache.lucene.search

クラス XFilteredDocIdSetIterator

java.lang.Object

org.apache.lucene.search.DocIdSetIterator

org.apache.lucene.search.XFilteredDocIdSetIterator

public abstract class XFilteredDocIdSetIterator
extends org.apache.lucene.search.DocIdSetIterator

Abstract decorator class of a DocIdSetIterator implementation that provides on-demand filter/validation mechanism on an underlying DocIdSetIterator. See FilteredDocIdSet.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected org.apache.lucene.search.DocIdSetIterator	_innerIter

クラスから継承されたフィールド org.apache.lucene.search.DocIdSetIterator

NO_MORE_DOCS

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
XFilteredDocIdSetIterator(org.apache.lucene.search.DocIdSetIterator innerIter) Constructor.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	advance(int target)
long	cost()
int	docID()
org.apache.lucene.search.DocIdSetIterator	getDelegate() Return the wrapped DocIdSetIterator.
protected abstract boolean	match(int doc) Validation method to determine whether a docid should be in the result set.
int	nextDoc()

クラスから継承されたメソッド org.apache.lucene.search.DocIdSetIterator

all, empty, slowAdvance

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

_innerIter

protected org.apache.lucene.search.DocIdSetIterator _innerIter

コンストラクタの詳細

XFilteredDocIdSetIterator

public XFilteredDocIdSetIterator(org.apache.lucene.search.DocIdSetIterator innerIter)

Constructor.

パラメータ:

innerIter - Underlying DocIdSetIterator.

メソッドの詳細

getDelegate

public org.apache.lucene.search.DocIdSetIterator getDelegate()

Return the wrapped DocIdSetIterator.

match

protected abstract boolean match(int doc)

Validation method to determine whether a docid should be in the result set.

パラメータ:

doc - docid to be tested

戻り値:

true if input docid should be in the result set, false otherwise.

例外:

CollectionTerminatedException - if the underlying iterator is exhausted.

関連項目:

XFilteredDocIdSetIterator(DocIdSetIterator)

docID

public int docID()

定義:

docID クラス内 org.apache.lucene.search.DocIdSetIterator

nextDoc

public int nextDoc()
            throws IOException

定義:

nextDoc クラス内 org.apache.lucene.search.DocIdSetIterator

例外:

IOException

advance

public int advance(int target)
            throws IOException

定義:

advance クラス内 org.apache.lucene.search.DocIdSetIterator

例外:

IOException

cost

public long cost()

定義:

cost クラス内 org.apache.lucene.search.DocIdSetIterator