Module org.apache.lucene.queries

Package org.apache.lucene.queries.intervals

Record Class DisjunctionIntervalsSource.DisjunctionMatchesIterator

java.lang.Object

java.lang.Record

org.apache.lucene.queries.intervals.DisjunctionIntervalsSource.DisjunctionMatchesIterator

All Implemented Interfaces:

IntervalMatchesIterator, MatchesIterator

Enclosing class:

DisjunctionIntervalsSource

private static record DisjunctionIntervalsSource.DisjunctionMatchesIterator(DisjunctionIntervalsSource.DisjunctionIntervalIterator it, List<IntervalMatchesIterator> subs)
extends Record
implements IntervalMatchesIterator

Field Summary

Fields

Modifier and Type	Field	Description
private final DisjunctionIntervalsSource.DisjunctionIntervalIterator	it	The field for the it record component.
private final List<IntervalMatchesIterator>	subs	The field for the subs record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DisjunctionMatchesIterator(DisjunctionIntervalsSource.DisjunctionIntervalIterator it, List<IntervalMatchesIterator> subs)	Creates an instance of a DisjunctionMatchesIterator record class.

Method Summary

Modifier and Type	Method	Description
int	endOffset()	The ending offset of the current match, or -1 if offsets are not available
int	endPosition()	The end position of the current match, or -1 if positions are not available
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	gaps()	The number of top-level gaps inside the current match
Query	getQuery()	Returns the Query causing the current match
MatchesIterator	getSubMatches()	Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match
final int	hashCode()	Returns a hash code value for this object.
DisjunctionIntervalsSource.DisjunctionIntervalIterator	it()	Returns the value of the it record component.
boolean	next()	Advance the iterator to the next match position
int	startOffset()	The starting offset of the current match, or -1 if offsets are not available
int	startPosition()	The start position of the current match, or -1 if positions are not available
List<IntervalMatchesIterator>	subs()	Returns the value of the subs record component.
final String	toString()	Returns a string representation of this record class.
int	width()	The width of the current match

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

it

private final DisjunctionIntervalsSource.DisjunctionIntervalIterator it

The field for the it record component.

subs

private final List<IntervalMatchesIterator> subs

The field for the subs record component.

Constructor Details

DisjunctionMatchesIterator

private DisjunctionMatchesIterator(DisjunctionIntervalsSource.DisjunctionIntervalIterator it,
 List<IntervalMatchesIterator> subs)

Creates an instance of a DisjunctionMatchesIterator record class.

Parameters:

it - the value for the it record component

subs - the value for the subs record component

Method Details

next

public boolean next()
             throws IOException

Description copied from interface: MatchesIterator

Advance the iterator to the next match position

Specified by:

next in interface MatchesIterator

Returns:

true if matches have not been exhausted

Throws:

IOException

startPosition

public int startPosition()

Description copied from interface: MatchesIterator

The start position of the current match, or -1 if positions are not available

Should only be called after MatchesIterator.next() has returned true

Specified by:

startPosition in interface MatchesIterator

endPosition

public int endPosition()

Description copied from interface: MatchesIterator

The end position of the current match, or -1 if positions are not available

Should only be called after MatchesIterator.next() has returned true

Specified by:

endPosition in interface MatchesIterator

startOffset

public int startOffset()
                throws IOException

Description copied from interface: MatchesIterator

The starting offset of the current match, or -1 if offsets are not available

Should only be called after MatchesIterator.next() has returned true

Specified by:

startOffset in interface MatchesIterator

Throws:

IOException

endOffset

public int endOffset()
              throws IOException

Description copied from interface: MatchesIterator

The ending offset of the current match, or -1 if offsets are not available

Should only be called after MatchesIterator.next() has returned true

Specified by:

endOffset in interface MatchesIterator

Throws:

IOException

getSubMatches

public MatchesIterator getSubMatches()
                              throws IOException

Description copied from interface: MatchesIterator

Returns a MatchesIterator that iterates over the positions and offsets of individual terms within the current match

Returns null if there are no submatches (ie the current iterator is at the leaf level)

Should only be called after MatchesIterator.next() has returned true

Specified by:

getSubMatches in interface MatchesIterator

Throws:

IOException

getQuery

public Query getQuery()

Description copied from interface: MatchesIterator

Returns the Query causing the current match

If this MatchesIterator has been returned from a MatchesIterator.getSubMatches() call, then returns a TermQuery equivalent to the current match

Should only be called after MatchesIterator.next() has returned true

Specified by:

getQuery in interface MatchesIterator

gaps

public int gaps()

Description copied from interface: IntervalMatchesIterator

The number of top-level gaps inside the current match

Specified by:

gaps in interface IntervalMatchesIterator

See Also:

• IntervalIterator.gaps()

width

public int width()

Description copied from interface: IntervalMatchesIterator

The width of the current match

Specified by:

width in interface IntervalMatchesIterator

See Also:

• IntervalIterator.width()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

it

public DisjunctionIntervalsSource.DisjunctionIntervalIterator it()

Returns the value of the it record component.

Returns:

the value of the it record component

subs

public List<IntervalMatchesIterator> subs()

Returns the value of the subs record component.

Returns:

the value of the subs record component