Jazz 1.25.+
Loading...
Searching...
No Matches
Private Member Functions | Private Attributes
jazz_bebop::RowSelection Class Reference

RowSelection: An iterator over the rows of a Space. More...

#include <space.h>

Private Member Functions

 RowSelection (pChar query, pSpace p_space)
 The constructor for a RowSelection.
 
virtual bool restart ()
 Restart the iterator.
 
virtual RowNumber next ()
 Get the next row.
 

Private Attributes

bool is_valid = false
 True if the iterator was created by a successful query.
 

Detailed Description

RowSelection: An iterator over the rows of a Space.

This is an abstract class that provides the interface of an iterator over rows. The where() method of a Space returns a RowSelection descendant that is compatible with this interface.

See also
Space

Constructor & Destructor Documentation

◆ RowSelection()

jazz_bebop::RowSelection::RowSelection ( pChar  query,
pSpace  p_space 
)
inlineprivate

The constructor for a RowSelection.

Parameters
queryA query string that is understood by the descendant. In Bop, this is the content of a WHERE clause with a syntax that depends on how the Space is indexed (Time, categorical, Embedding storage, ...).
p_spaceThe Space that created the object is required because the descendant may need to call .get_index_data() or other methods.

Member Function Documentation

◆ restart()

virtual bool jazz_bebop::RowSelection::restart ( )
inlineprivatevirtual

Restart the iterator.

Returns
True if the iterator was successfully restarted, false if it is not possible.

◆ next()

virtual RowNumber jazz_bebop::RowSelection::next ( )
inlineprivatevirtual

Get the next row.

Returns
The next row number or SPACE_ROW_STOP_ITERATOR if the iteration is exhausted.

The documentation for this class was generated from the following file: