gemfire::SelectResults Class Reference

Inherits gemfire::SharedBase.

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


Detailed Description

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

This can either be a ResultSet or a StructSet.

Public Types

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

Public Member Functions

virtual Iterator begin () const =0
 Get an iterator pointing to the start of vector.
virtual Iterator end () const =0
 Get an iterator pointing to the end of vector.
virtual
SelectResultsIterator 
getIterator ()=0
 Get a SelectResultsIterator with which to iterate over the items in the SelectResults.
virtual bool isModifiable () const =0
 Check whether the SelectResults is modifiable.
virtual const
SerializablePtr 
operator[] (int32_t index) const =0
 Index operator to directly access an item in the SelectResults.
void preserveSB () const
 Atomically increment reference count.
int32_t refCount ()
 
Returns:
the reference count

void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.
virtual int32_t size () const =0
 Get the size of the SelectResults.


Member Typedef Documentation

typedef CacheableVector::Iterator gemfire::SelectResults::Iterator

Interface of an iterator for SelectResults.


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::ResultSet, and gemfire::StructSet.

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:
index the index number of the required item.
Exceptions:
IllegalArgumentException if 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 (  )  [inline, inherited]

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