BCatalogDelegate::IteratorDelegate

BCatalogDelegate::IteratorDelegate Class Reference
[Data Model]

#include <storage/CatalogDelegate.h>

Inheritance diagram for BCatalogDelegate::IteratorDelegate:

BGenericIterable::GenericIterator BnRandomIterator SSQLBuilder IRandomIterator BBinder IIterator IBinder IInterface SAtom SAtom List of all members.

Detailed Description

Generic base class implementation of a BGenericIterable's iterator.

You will need to create your own concete subclass.


Bookkeeping

Creation, destruction, locking, etc.

virtual SValue Inspect (const sptr< IBinder > &caller, const SValue &which, uint32_t flags)
 Return IIterator, and IRandomIterator if the base supports it.
 IteratorDelegate (const SContext &context, const sptr< BGenericIterable > &owner)
 Return IIterator, and IRandomIterator if the base supports it.
virtual status_t StatusCheck () const
 Propagate error code back from base NewIterator() call.
virtual ~IteratorDelegate ()
 Return IIterator, and IRandomIterator if the base supports it.

Public Member Functions

virtual size_t Count () const
 Calls through to base iterator.
virtual status_t Next (IIterator::ValueList *keys, IIterator::ValueList *values, uint32_t flags, size_t count)
 Call through to pass iterator.
virtual status_t NextLocked (uint32_t flags, SValue *key, SValue *entry)
 Stubbed out because Next() just calls to base iterator.
virtual SValue Options () const
 Return options from base iterator.
virtual status_t ParseArgs (const SValue &args)
 Create the delegate iterator with the given arguments.
virtual size_t Position () const
 Calls through to base iterator.
virtual status_t Remove ()
 Calls through to base iterator.
virtual void SetPosition (size_t p)
 Calls through to base iterator.

Constructor & Destructor Documentation

IteratorDelegate (  const SContext &  context,
const sptr< BGenericIterable > &  owner
) 
 

Return IIterator, and IRandomIterator if the base supports it.

~IteratorDelegate (   )  [protected, virtual]
 

Return IIterator, and IRandomIterator if the base supports it.

Member Function Documentation

size_t Count (   )  const [virtual]
 

Calls through to base iterator.

Reimplemented from BGenericIterable::GenericIterator.

SValue Inspect (  const sptr< IBinder > &  caller,
const SValue &  which,
uint32_t  flags
)  [virtual]
 

Return IIterator, and IRandomIterator if the base supports it.

Reimplemented from BGenericIterable::GenericIterator.

status_t Next (  IIterator::ValueList *  keys,
IIterator::ValueList *  values,
uint32_t  flags,
size_t  count
)  [virtual]
 

Call through to pass iterator.

To modify the results, you can override this, call through to this implementation, and the munge the data in the keys and/or values vectors. If you want more control over the results being generated, you can reimplement this to call to the normal GenericIterator::Next() implementation and generate results in NextLock().

Reimplemented from BGenericIterable::GenericIterator.

status_t NextLocked (  uint32_t  flags,
SValue *  key,
SValue *  entry
)  [virtual]
 

Stubbed out because Next() just calls to base iterator.

Implements BGenericIterable::GenericIterator.

SValue Options (   )  const [virtual]
 

Return options from base iterator.

Reimplemented from BGenericIterable::GenericIterator.

status_t ParseArgs (  const SValue &  args  )  [virtual]
 

Create the delegate iterator with the given arguments.

Reimplemented from BGenericIterable::GenericIterator.

size_t Position (   )  const [virtual]
 

Calls through to base iterator.

Reimplemented from BGenericIterable::GenericIterator.

status_t Remove (   )  [virtual]
 

Calls through to base iterator.

Reimplemented from BGenericIterable::GenericIterator.

void SetPosition (  size_t  p  )  [virtual]
 

Calls through to base iterator.

Reimplemented from BGenericIterable::GenericIterator.

status_t StatusCheck (   )  const [virtual]
 

Propagate error code back from base NewIterator() call.

Reimplemented from BGenericIterable::GenericIterator.

The documentation for this class was generated from the following files:
Generated on Wed Dec 28 22:33:29 2005 by Doxygen 1.4.4 for OpenBinder Documentation Version 1.0

PalmSource, Inc. © 2005