Xpace
Xpace::SinkBase Class Reference

The non-LOC part of a Sink. More...

#include <data.h>

Inheritance diagram for Xpace::SinkBase:
Xpace::Sink< const Location & > Xpace::Sink< const String8 & > Xpace::Sink< int > Xpace::Sink< LOC > Xpace::Sink< uint > Xpace::Sink< LOC, RET > Xpace::Store::Sink Xpace::Store::Sink Xpace::Store::Sink Xpace::Table::Sink Xpace::JavaStoreSink Xpace::JavaStoreSink Xpace::JavaStoreSink Xpace::JavaTableSink Xpace::TableSinkToStore

Public Member Functions

virtual ~SinkBase ()
 
virtual bool setCount (uint64 docs)
 Inform the Sink how many documents/records/rows to expect. More...
 
virtual int64 start (uint64 docNum)
 Begin a new document/record/row, committing current one (if any) More...
 
virtual void close ()
 We're finshed with this Sink. More...
 

Protected Member Functions

 SinkBase ()
 

Detailed Description

The non-LOC part of a Sink.

Definition at line 260 of file data.h.

Constructor & Destructor Documentation

virtual Xpace::SinkBase::~SinkBase ( )
inlinevirtual

Definition at line 265 of file data.h.

Xpace::SinkBase::SinkBase ( )
inlineprotected

Definition at line 295 of file data.h.

Member Function Documentation

virtual bool Xpace::SinkBase::setCount ( uint64  docs)
inlinevirtual

Inform the Sink how many documents/records/rows to expect.

Parameters
docsthe number of documents/records/rows
Returns
true to receive, false to stop

Reimplemented in Xpace::JavaTableSink, and Xpace::JavaStoreSink.

Definition at line 273 of file data.h.

virtual int64 Xpace::SinkBase::start ( uint64  docNum)
inlinevirtual

Begin a new document/record/row, committing current one (if any)

Parameters
docNuma suggested document
Returns
-1 to stop, otherwise a document number

Reimplemented in Xpace::JavaTableSink, Xpace::TableSinkToStore, and Xpace::JavaStoreSink.

Definition at line 282 of file data.h.

Referenced by Xpace::TableSinkToStore::BadCode::BadCode().

virtual void Xpace::SinkBase::close ( )
inlinevirtual

We're finshed with this Sink.

Reimplemented in Xpace::JavaStoreSink, Xpace::JavaTableSink, and Xpace::TableSinkToStore.

Definition at line 289 of file data.h.


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

current as of Wed Jun 10 2026 12:00:06