Pivotal GemFire Native Client Cache Reference  9.0.6
gemfire::SelectResults Class Referenceabstract

A SelectResults is obtained by executing a Query on the server. More...

Inherits gemfire::SharedBase.

Inherited by gemfire::CqResults, and gemfire::ResultSet.

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 SelectResults. More...
 
virtual bool isModifiable () const =0
 Check whether the SelectResults is modifiable. More...
 
virtual const SerializablePtr operator[] (int32_t index) const =0
 Index operator to directly access an item in the SelectResults. 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 SelectResults. More...
 

Detailed Description

A SelectResults is obtained by executing a Query on the server.

This can either be a ResultSet or a StructSet.

Member Typedef Documentation

Member Function Documentation

virtual Iterator gemfire::SelectResults::begin ( ) const
pure virtual

Get an iterator pointing to the start of vector.

virtual Iterator gemfire::SelectResults::end ( ) const
pure virtual

Get an iterator pointing to the end of vector.

virtual SelectResultsIterator gemfire::SelectResults::getIterator ( )
pure virtual

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

Returns
The SelectResultsIterator with which to iterate.

Implemented in gemfire::StructSet, and gemfire::ResultSet.

virtual bool gemfire::SelectResults::isModifiable ( ) const
pure virtual

Check whether the SelectResults is modifiable.

Returns
false always at this time.

Implemented in gemfire::ResultSet, and gemfire::StructSet.

virtual const SerializablePtr gemfire::SelectResults::operator[] ( int32_t  index) const
pure virtual

Index operator to directly access an item in the SelectResults.

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

Implemented in gemfire::ResultSet, and gemfire::StructSet.

void gemfire::SharedBase::preserveSB ( ) const
inherited

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount ( )
inlineinherited
Returns
the reference count
void gemfire::SharedBase::releaseSB ( ) const
inherited

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

virtual int32_t gemfire::SelectResults::size ( ) const
pure virtual

Get the size of the SelectResults.

Returns
the number of items in the SelectResults.

Implemented in gemfire::ResultSet, and gemfire::StructSet.


GemFire C++ Cache API Documentation