gemfire::StructSet Class Reference

Inherits gemfire::CqResults.

---

Detailed Description

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

It is the parent of a Struct which contains the field values.

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 int32_t	getFieldIndex (const char *fieldname)=0
	Get the index number of the specified field name in the StructSet.
virtual const char *	getFieldName (int32_t index)=0
	Get the field name of the StructSet from the specified index number.
virtual SelectResultsIterator	getIterator ()=0
	Get a SelectResultsIterator with which to iterate over the items in the StructSet.
virtual bool	isModifiable () const =0
	Check whether the StructSet is modifiable.
virtual const SerializablePtr	operator[] (int32_t index) const =0
	Index operator to directly access an item in the StructSet.
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 StructSet.
virtual	~StructSet ()
	Destructor.

---

Member Typedef Documentation

typedef CacheableVector::Iterator gemfire::SelectResults::Iterator [inherited]

Interface of an iterator for SelectResults.

---

Constructor & Destructor Documentation

virtual gemfire::StructSet::~StructSet

(

)

[inline, virtual]

Destructor.

---

Member Function Documentation

virtual Iterator gemfire::SelectResults::begin

(

)

const [pure virtual, inherited]

Get an iterator pointing to the start of vector.

virtual Iterator gemfire::SelectResults::end

(

)

const [pure virtual, inherited]

Get an iterator pointing to the end of vector.

virtual int32_t gemfire::StructSet::getFieldIndex

(

const char *

fieldname

)

[pure virtual]

Get the index number of the specified field name in the StructSet.

Parameters:

fieldname

the field name for which the index is required.

Returns:

the index number of the specified field name.

Exceptions:

IllegalArgumentException

if the field name is not found.

virtual const char* gemfire::StructSet::getFieldName

(

int32_t

index

)

[pure virtual]

Get the field name of the StructSet from the specified index number.

Parameters:

index

the index number of the field name to get.

Returns:

the field name from the specified index number or NULL if not found.

virtual SelectResultsIterator gemfire::StructSet::getIterator

(

)

[pure virtual]

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

Returns:

The SelectResultsIterator with which to iterate.

Implements gemfire::SelectResults.

virtual bool gemfire::StructSet::isModifiable

(

)

const [pure virtual]

Check whether the StructSet is modifiable.

Returns:

false always at this time.

Implements gemfire::SelectResults.

virtual const SerializablePtr gemfire::StructSet::operator[]

(

int32_t

index

)

const [pure virtual]

Index operator to directly access an item in the StructSet.

Parameters:

index

the index number of the item to get.

Exceptions:

IllegalArgumentException

if the index is out of bounds.

Returns:

A smart pointer to the item indexed.

Implements gemfire::SelectResults.

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::StructSet::size

(

)

const [pure virtual]

Get the size of the StructSet.

Returns:

the number of items in the StructSet.

Implements gemfire::SelectResults.

---