apache::geode::client::SelectResults Class Reference

Inherits apache::geode::client::SharedBase.

Inherited by apache::geode::client::CqResults, and apache::geode::client::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

Iterator

typedef CacheableVector::Iterator apache::geode::client::SelectResults::Iterator

Interface of an iterator for SelectResults.

Member Function Documentation

begin()

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

pure virtual

Get an iterator pointing to the start of vector.

end()

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

pure virtual

Get an iterator pointing to the end of vector.

getIterator()

virtual SelectResultsIterator apache::geode::client::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 apache::geode::client::StructSet, and apache::geode::client::ResultSet.

isModifiable()

virtual bool apache::geode::client::SelectResults::isModifiable ( ) const

pure virtual

Check whether the SelectResults is modifiable.

Returns

false always at this time.

Implemented in apache::geode::client::ResultSet, and apache::geode::client::StructSet.

operator[]()

virtual const SerializablePtr apache::geode::client::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 apache::geode::client::ResultSet, and apache::geode::client::StructSet.

preserveSB()

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

inherited

Atomically increment reference count.

refCount()

int32_t apache::geode::client::SharedBase::refCount ( )

inlineinherited

Returns

the reference count

releaseSB()

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.

size()

virtual int32_t apache::geode::client::SelectResults::size ( ) const

pure virtual

Get the size of the SelectResults.

Returns

the number of items in the SelectResults.

Implemented in apache::geode::client::ResultSet, and apache::geode::client::StructSet.