ULDictionaryIterator Class Reference

ULDictionaryIterator is a wrapper for a pointer to a ULDictionaryDataSourceIterator subclass object. Its only purpose is to enable the ULDictionary begin, find, and end methods to return a polymorphic object without forcing the caller to take responsibility for deleting that object. More...

#include <uldictionaryiterator.h>

Public Member Functions
	ULDictionaryIterator ()
	ULDictionaryIterator (const ULDictionaryIterator &other)
	ULDictionaryIterator (ULDictionaryDataSourceIterator *ddsIterator)
virtual	~ULDictionaryIterator ()
ULDictionaryIterator &	operator= (const ULDictionaryIterator &other)
virtual void	clear ()
virtual ULDictionaryDataSource *	getDataSource () const
virtual void	setDataSource (ULDictionaryDataSource *source)
ULDictionaryIterator *	clone () const
void	setDataSourceIterator (ULDictionaryDataSourceIterator *iterator)
virtual const ULDictionaryNode &	operator* ()
virtual void	operator++ ()
virtual void	operator++ (int)
virtual void	operator-- ()
virtual void	operator-- (int)
virtual bool	operator== (const ULDictionaryDataSourceIterator &iterator) const
virtual bool	operator== (const ULDictionaryIterator &iterator) const
virtual uluint32	hash (uluint32 tableSize) const
virtual const ULDictionaryNode &	getData ()
virtual void	increment ()
virtual void	decrement ()
virtual void	toNextTopLevelNode ()
virtual void	toCurrentTopLevelNode ()
virtual void	toPreviousTopLevelNode ()
virtual bool	hasParent ()
virtual void	toParent ()
virtual bool	hasChildren ()
virtual void	toFirstChild ()
virtual bool	hasNextSibling ()
virtual void	toNextSibling ()
virtual bool	hasPreviousSibling ()
virtual void	toPreviousSibling ()
virtual bool	hasNextCousin ()
virtual void	toNextCousin ()
virtual bool	hasPreviousCousin ()
virtual void	toPreviousCousin ()
virtual int	getLevel ()
virtual uluint32	getType ()
virtual bool	isAtEnd () const
virtual bool	isAtBeginning () const
virtual bool	isInFirstTree () const
virtual bool	isInLastTree () const
virtual ULString	getIndexKey ()
virtual const ULLanguage &	getLanguage () const
virtual const ULLanguage &	getSearchLanguage () const
virtual const ULLanguage &	getTranslationLanguage () const

Detailed Description

ULDictionaryIterator is a wrapper for a pointer to a ULDictionaryDataSourceIterator subclass object. Its only purpose is to enable the ULDictionary begin, find, and end methods to return a polymorphic object without forcing the caller to take responsibility for deleting that object.

Note that ULDictionaryIterator both is a and has a ULDictionaryDataSourceIterator. A ULDictionaryIterator object's own copies of the ULDictionaryDataSourceIterator instance variables are always empty/null. Thus, when you're debugging, you'll want to look not at the ULDictionaryIterator's own instance variables (which are null), but rather at the instance variables of this->dictionaryDataSourceIterator.

Constructor & Destructor Documentation

ULDictionaryIterator::ULDictionaryIterator

(

)

Default constructor.

ULDictionaryIterator::ULDictionaryIterator

(

const ULDictionaryIterator &

other

)

Copy constructor.

ULDictionaryIterator::ULDictionaryIterator

(

ULDictionaryDataSourceIterator *

ddsIterator

)

Constructor from dictionary data source iterator.

ULDictionaryIterator::~ULDictionaryIterator ( )

virtual

Destructor.

Member Function Documentation

void ULDictionaryIterator::clear ( )

virtual

Sets this iterator to its default state, freeing any dynamically allocated memory in the process.

ULDictionaryIterator * ULDictionaryIterator::clone

(

)

const

void ULDictionaryIterator::decrement ( )

virtual

Non-operator synonym for operator–(). This method is here principally to simplify the Python interface generated by SWIG.

const ULDictionaryNode & ULDictionaryIterator::getData ( )

virtual

Non-operator synonym for operator*. This method is here principally to simplify the Python interface generated by SWIG.

ULDictionaryDataSource * ULDictionaryIterator::getDataSource ( ) const

virtual

ULString ULDictionaryIterator::getIndexKey ( )

virtual

const ULLanguage & ULDictionaryIterator::getLanguage ( ) const

virtual

int ULDictionaryIterator::getLevel ( )

virtual

const ULLanguage & ULDictionaryIterator::getSearchLanguage ( ) const

virtual

const ULLanguage & ULDictionaryIterator::getTranslationLanguage ( ) const

virtual

uluint32 ULDictionaryIterator::getType ( )

virtual

bool ULDictionaryIterator::hasChildren ( )

virtual

uluint32 ULDictionaryIterator::hash ( uluint32  tableSize ) const

virtual

bool ULDictionaryIterator::hasNextCousin ( )

virtual

bool ULDictionaryIterator::hasNextSibling ( )

virtual

bool ULDictionaryIterator::hasParent ( )

virtual

bool ULDictionaryIterator::hasPreviousCousin ( )

virtual

bool ULDictionaryIterator::hasPreviousSibling ( )

virtual

void ULDictionaryIterator::increment ( )

virtual

Non-operator synonym for operator++(). This method is here principally to simplify the Python interface generated by SWIG.

bool ULDictionaryIterator::isAtBeginning ( ) const

virtual

bool ULDictionaryIterator::isAtEnd ( ) const

virtual

bool ULDictionaryIterator::isInFirstTree ( ) const

virtual

bool ULDictionaryIterator::isInLastTree ( ) const

virtual

const ULDictionaryNode & ULDictionaryIterator::operator* ( )

virtual

void ULDictionaryIterator::operator++ ( )

virtual

void ULDictionaryIterator::operator++ ( int  )

virtual

void ULDictionaryIterator::operator-- ( )

virtual

void ULDictionaryIterator::operator-- ( int  )

virtual

ULDictionaryIterator & ULDictionaryIterator::operator=

(

const ULDictionaryIterator &

other

)

Assignment operator.

bool ULDictionaryIterator::operator== ( const ULDictionaryDataSourceIterator &  iterator ) const

virtual

bool ULDictionaryIterator::operator== ( const ULDictionaryIterator &  iterator ) const

virtual

void ULDictionaryIterator::setDataSource ( ULDictionaryDataSource *  source )

virtual

void ULDictionaryIterator::setDataSourceIterator

(

ULDictionaryDataSourceIterator *

iterator

)

Sets the data source iterator being wrapped by this ULDictionaryIterator.

Parameters

[in]

iterator

A pointer to the iterator to be wrapped.

void ULDictionaryIterator::toCurrentTopLevelNode ( )

virtual

void ULDictionaryIterator::toFirstChild ( )

virtual

void ULDictionaryIterator::toNextCousin ( )

virtual

void ULDictionaryIterator::toNextSibling ( )

virtual

void ULDictionaryIterator::toNextTopLevelNode ( )

virtual

void ULDictionaryIterator::toParent ( )

virtual

void ULDictionaryIterator::toPreviousCousin ( )

virtual

void ULDictionaryIterator::toPreviousSibling ( )

virtual

void ULDictionaryIterator::toPreviousTopLevelNode ( )

virtual

---

The documentation for this class was generated from the following files:

• uldictionaryiterator.h
• uldictionaryiterator.cpp