GemStone::GemFire::Cache::StructSet Class Reference

Inherits GemStone::GemFire::Cache::ISelectResults.

---

Detailed Description

Encapsulates a query struct set.

Public Member Functions
virtual System::Collections::Generic::IEnumerator < IGFSerializable^ >^	GetEnumerator ()
size_t	GetFieldIndex (String^ fieldName)
String^	GetFieldName (size_t index)
virtual SelectResultsIterator^	GetIterator ()
Properties
virtual bool	IsModifiable [get]
virtual IGFSerializable^	Item [get]
virtual size_t	Size [get]

---

Member Function Documentation

virtual System::Collections::Generic::IEnumerator<IGFSerializable^> ^ GemStone::GemFire::Cache::StructSet::GetEnumerator

(

)

[virtual]

Returns an enumerator that iterates through the StructSet.

Returns:

A System.Collections.Generic.IEnumerator that can be used to iterate through the StructSet.

size_t GemStone::GemFire::Cache::StructSet::GetFieldIndex

(

String^

fieldName

)

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.

String ^ GemStone::GemFire::Cache::StructSet::GetFieldName

(

size_t

index

)

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 ^ GemStone::GemFire::Cache::StructSet::GetIterator

(

)

[virtual]

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

Returns:

The SelectResultsIterator with which to iterate.

Implements GemStone::GemFire::Cache::ISelectResults.

---

Property Documentation

virtual bool GemStone::GemFire::Cache::StructSet::IsModifiable [get]

True if this StructSet is modifiable.

Returns:

returns false always at this time.

Implements GemStone::GemFire::Cache::ISelectResults.

virtual IGFSerializable^ GemStone::GemFire::Cache::StructSet::Item [get]

Index operator to directly access an item in the StructSet.

Exceptions:

IllegalArgumentException

if the index is out of bounds.

Returns:

Item at the given index.

Implements GemStone::GemFire::Cache::ISelectResults.

virtual size_t GemStone::GemFire::Cache::StructSet::Size [get]

The size of the StructSet.

Returns:

the number of items in the StructSet.

Implements GemStone::GemFire::Cache::ISelectResults.

---