Package org.apache.lucene.search.spans
Class ConjunctionSpans
- java.lang.Object
-
- org.apache.lucene.search.DocIdSetIterator
-
- org.apache.lucene.search.spans.Spans
-
- org.apache.lucene.search.spans.ConjunctionSpans
-
- Direct Known Subclasses:
ContainSpans
,NearSpansOrdered
,NearSpansUnordered
abstract class ConjunctionSpans extends Spans
Common super class for multiple sub spans required in a document.
-
-
Field Summary
Fields Modifier and Type Field Description (package private) boolean
atFirstInCurrentDoc
(package private) DocIdSetIterator
conjunction
(package private) boolean
oneExhaustedInCurrentDoc
(package private) Spans[]
subSpans
-
Fields inherited from class org.apache.lucene.search.spans.Spans
NO_MORE_POSITIONS
-
Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS
-
-
Constructor Summary
Constructors Constructor Description ConjunctionSpans(java.util.List<Spans> subSpans)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description int
advance(int target)
Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.TwoPhaseIterator
asTwoPhaseIterator()
Return aTwoPhaseIterator
view of this ConjunctionSpans.long
cost()
Returns the estimated cost of thisDocIdSetIterator
.int
docID()
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.Spans[]
getSubSpans()
int
nextDoc()
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.float
positionsCost()
Return an estimation of the cost of using the positions of thisSpans
for any single document, but only afterSpans.asTwoPhaseIterator()
returnednull
.(package private) int
toMatchDoc()
(package private) abstract boolean
twoPhaseCurrentDocMatches()
-
Methods inherited from class org.apache.lucene.search.spans.Spans
collect, doCurrentSpans, doStartCurrentDoc, endPosition, nextStartPosition, startPosition, toString, width
-
Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance
-
-
-
-
Field Detail
-
subSpans
final Spans[] subSpans
-
conjunction
final DocIdSetIterator conjunction
-
atFirstInCurrentDoc
boolean atFirstInCurrentDoc
-
oneExhaustedInCurrentDoc
boolean oneExhaustedInCurrentDoc
-
-
Constructor Detail
-
ConjunctionSpans
ConjunctionSpans(java.util.List<Spans> subSpans)
-
-
Method Detail
-
docID
public int docID()
Description copied from class:DocIdSetIterator
Returns the following:-1
ifDocIdSetIterator.nextDoc()
orDocIdSetIterator.advance(int)
were not called yet.DocIdSetIterator.NO_MORE_DOCS
if the iterator has exhausted.- Otherwise it should return the doc ID it is currently on.
- Specified by:
docID
in classDocIdSetIterator
-
cost
public long cost()
Description copied from class:DocIdSetIterator
Returns the estimated cost of thisDocIdSetIterator
.This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.
- Specified by:
cost
in classDocIdSetIterator
-
nextDoc
public int nextDoc() throws java.io.IOException
Description copied from class:DocIdSetIterator
Advances to the next document in the set and returns the doc it is currently on, orDocIdSetIterator.NO_MORE_DOCS
if there are no more docs in the set.
NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.- Specified by:
nextDoc
in classDocIdSetIterator
- Throws:
java.io.IOException
-
advance
public int advance(int target) throws java.io.IOException
Description copied from class:DocIdSetIterator
Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returnsDocIdSetIterator.NO_MORE_DOCS
if target is greater than the highest document number in the set.The behavior of this method is undefined when called with
target ≤ current
, or after the iterator has exhausted. Both cases may result in unpredicted behavior.When
target > current
it behaves as if written:int advance(int target) { int doc; while ((doc = nextDoc()) < target) { } return doc; }
Some implementations are considerably more efficient than that.NOTE: this method may be called with
DocIdSetIterator.NO_MORE_DOCS
for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.- Specified by:
advance
in classDocIdSetIterator
- Throws:
java.io.IOException
-
toMatchDoc
int toMatchDoc() throws java.io.IOException
- Throws:
java.io.IOException
-
twoPhaseCurrentDocMatches
abstract boolean twoPhaseCurrentDocMatches() throws java.io.IOException
- Throws:
java.io.IOException
-
asTwoPhaseIterator
public TwoPhaseIterator asTwoPhaseIterator()
Return aTwoPhaseIterator
view of this ConjunctionSpans.- Overrides:
asTwoPhaseIterator
in classSpans
- See Also:
Scorer.twoPhaseIterator()
-
positionsCost
public float positionsCost()
Description copied from class:Spans
Return an estimation of the cost of using the positions of thisSpans
for any single document, but only afterSpans.asTwoPhaseIterator()
returnednull
. Otherwise this method should not be called. The returned value is independent of the current document.- Specified by:
positionsCost
in classSpans
-
getSubSpans
public Spans[] getSubSpans()
-
-