VMware GemFire Native C++ Reference  9.1
apache::geode::client::ResultSet Class Referenceabstract

A ResultSet may be obtained after executing a Query which is obtained from a QueryService which in turn is obtained from a Cache. More...

Inherits apache::geode::client::SelectResults.

Public Types

typedef CacheableVector::Iterator Iterator
 Interface of an iterator for SelectResults. More...
 

Public Member Functions

virtual Iterator begin () const =0
 Get an iterator pointing to the start of vector. More...
 
virtual Iterator end () const =0
 Get an iterator pointing to the end of vector. More...
 
virtual SelectResultsIterator getIterator ()=0
 Get a SelectResultsIterator with which to iterate over the items in the ResultSet. More...
 
virtual bool isModifiable () const =0
 Check whether the ResultSet is modifiable. More...
 
virtual const SerializablePtr operator[] (int32_t index) const =0
 Index operator to directly access an item in the ResultSet. More...
 
void preserveSB () const
 Atomically increment reference count. More...
 
int32_t refCount ()
 
void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero. More...
 
virtual int32_t size () const =0
 Get the size of the ResultSet. More...
 
virtual ~ResultSet ()
 Destructor. More...
 

Detailed Description

A ResultSet may be obtained after executing a Query which is obtained from a QueryService which in turn is obtained from a Cache.

Member Typedef Documentation

Constructor & Destructor Documentation

virtual apache::geode::client::ResultSet::~ResultSet ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual Iterator apache::geode::client::SelectResults::begin ( ) const
pure virtualinherited

Get an iterator pointing to the start of vector.

virtual Iterator apache::geode::client::SelectResults::end ( ) const
pure virtualinherited

Get an iterator pointing to the end of vector.

virtual SelectResultsIterator apache::geode::client::ResultSet::getIterator ( )
pure virtual

Get a SelectResultsIterator with which to iterate over the items in the ResultSet.

Returns
The SelectResultsIterator with which to iterate.

Implements apache::geode::client::SelectResults.

virtual bool apache::geode::client::ResultSet::isModifiable ( ) const
pure virtual

Check whether the ResultSet is modifiable.

Returns
false always at this time.

Implements apache::geode::client::SelectResults.

virtual const SerializablePtr apache::geode::client::ResultSet::operator[] ( int32_t  index) const
pure virtual

Index operator to directly access an item in the ResultSet.

Parameters
indexthe index number of the required item.
Exceptions
IllegalArgumentExceptionif the index is out of bounds.
Returns
A smart pointer to the item indexed.

Implements apache::geode::client::SelectResults.

void apache::geode::client::SharedBase::preserveSB ( ) const
inherited

Atomically increment reference count.

int32_t apache::geode::client::SharedBase::refCount ( )
inlineinherited
Returns
the reference count
void apache::geode::client::SharedBase::releaseSB ( ) const
inherited

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.

virtual int32_t apache::geode::client::ResultSet::size ( ) const
pure virtual

Get the size of the ResultSet.

Returns
the number of items in the ResultSet.

Implements apache::geode::client::SelectResults.


Pivotal GemFire C++ Cache API Documentation