Proxies another QAbstractXmlForwardIterator, and for each item, returns the Sequence returned from a mapping function. More...

#include <qabstractxmlnodemodel.h>

Inheritance diagram for QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >:

Public Functions
virtual QAbstractXmlForwardIterator< TResult >::Ptr	copy () const

virtual xsInteger	count ()
	Determines the number of items this QAbstractXmlForwardIterator represents. More...

virtual TResult	current () const
	Returns the current item in the sequence. More...

virtual TResult	next ()
	Returns the next item in the sequence, or a null object if the end has been reached. More...

virtual xsInteger	position () const
	Returns the current position in the sequence represented by this. More...

	SequenceMappingIterator (const TMapper &mapper, const typename QAbstractXmlForwardIterator< TSource >::Ptr &sourceIterator, const DynamicContext::Ptr &context)

Public Functions inherited from QAbstractXmlForwardIterator< TResult >
virtual bool	isEmpty ()
	Returns true if the sequence is empty. More...

virtual TResult	last ()
	Returns the item at the end of this QAbstractXmlForwardIterator. More...

	QAbstractXmlForwardIterator ()
	Default constructor. More...

virtual qint64	sizeHint () const
	Gives a hint to the size of the contained sequence. More...

virtual QList< TResult >	toList ()
	Performs a copy of this QAbstractXmlForwardIterator(with copy()), and returns its items in a QList. More...

virtual QAbstractXmlForwardIterator< TResult >::Ptr	toReversed ()
	Returns a reverse iterator for the sequence. More...

virtual	~QAbstractXmlForwardIterator ()
	Destructor. More...

Public Functions inherited from QSharedData
	QSharedData ()
	Constructs a QSharedData object with a reference count of 0. More...

	QSharedData (const QSharedData &)
	Constructs a QSharedData object with reference count 0. More...

Properties
const DynamicContext::Ptr	m_context

TResult	m_current

QAbstractXmlForwardIterator< TResult >::Ptr	m_currentIterator

QAbstractXmlForwardIterator< TSource >::Ptr	m_mainIterator

const TMapper	m_mapper

xsInteger	m_position

Additional Inherited Members
Public Types inherited from QAbstractXmlForwardIterator< TResult >
typedef QList< QExplicitlySharedDataPointer< QAbstractXmlForwardIterator< TResult > > >	List
	A QList containing QAbstractXmlForwardIterator::Ptr instances. More...

typedef QExplicitlySharedDataPointer< QAbstractXmlForwardIterator< TResult > >	Ptr
	A smart pointer wrapping an instance of a QAbstractXmlForwardIterator subclass. More...

typedef QVector< QExplicitlySharedDataPointer< QAbstractXmlForwardIterator< TResult > > >	Vector
	A QVector containing QAbstractXmlForwardIterator::Ptr instances. More...

Public Variables inherited from QSharedData
QAtomicInt	ref

Related Functions inherited from QAbstractXmlForwardIterator< TResult >
static QAbstractXmlForwardIterator< TResult >::Ptr	makeSequenceMappingIterator (const TMapper &mapper, const QExplicitlySharedDataPointer< QAbstractXmlForwardIterator< TSource > > &source, const DynamicContext::Ptr &context)
	An object generator for SequenceMappingIterator. More...

bool	qIsForwardIteratorEnd (const TResult &unit)
	The Callback QAbstractXmlForwardIterator uses for determining whether unit is the end of a sequence. More...

Detailed Description

template<typename TResult, typename TSource, typename TMapper>
class QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >

Proxies another QAbstractXmlForwardIterator, and for each item, returns the Sequence returned from a mapping function.

ItemMappingIterator is practical when the items in an QAbstractXmlForwardIterator needs to be translated to another sequence, while still doing it in a pipe-lined fashion. In contrast to ItemMappingIterator, SequenceMappingIterator maps each item into another QAbstractXmlForwardIterator, and where the SequenceMappingIterator's own result is the concatenation of all those Iterators. Hence, while ItemMappingIterator is better tailored for one-to-one or one-to-zero conversion, SequenceMappingIterator is more suitable for one-to-many conversion.

This is achieved by that SequenceMappingIterator's constructor takes an instance of a class, that must have the following member:

QAbstractXmlForwardIterator<TResult>::Ptr mapToSequence(const TSource::Ptr &item,

const DynamicContext::Ptr &context) const;

Author: Frans Englich frans.nosp@m..eng.nosp@m.lich@.nosp@m.noki.nosp@m.a.com

See also: ItemMappingIterator

Definition at line 76 of file qabstractxmlnodemodel.h.

Constructors and Destructors

◆ SequenceMappingIterator()

template<typename TResult , typename TSource , typename TMapper >

QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::SequenceMappingIterator	(	const TMapper &	mapper,
		const typename QAbstractXmlForwardIterator< TSource >::Ptr &	sourceIterator,
		const DynamicContext::Ptr &	context
	)

Constructs a SequenceMappingIterator.

Parameters

mapper	the object that has the mapToItem() sequence.
sourceIterator	the QAbstractXmlForwardIterator whose items should be mapped.
context	the DynamicContext that will be passed to the map function. May be null.

Definition at line 131 of file qsequencemappingiterator_p.h.

                                         : m_position(0),
                                           m_mainIterator(iterator),
                                           m_context(context),
                                           m_mapper(mapper)
     {
         Q_ASSERT(mapper);
         Q_ASSERT(iterator);
     }

Functions

◆ copy()

template<typename TResult , typename TSource , typename TMapper >

virtual QAbstractXmlForwardIterator<TResult>::Ptr QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::copy ( ) const

inlinevirtual

The reason the implementation is placed in line here, is due to a bug in MSVC-2005 version 14.00.50727.762. Note that it works with version 14.00.50727.42.

Reimplemented from QAbstractXmlForwardIterator< TResult >.

Definition at line 113 of file qsequencemappingiterator_p.h.

         {
             return typename QAbstractXmlForwardIterator<TResult>::Ptr
                     (new SequenceMappingIterator<TResult, TSource, TMapper>(m_mapper,
                                                                             m_mainIterator->copy(),
                                                                             m_context));
         }

◆ count()

template<typename TResult , typename TSource , typename TMapper >

xsInteger QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::count ( )

virtual

Determines the number of items this QAbstractXmlForwardIterator represents.

Warning: This function is not part of the public interface.

Note that this function is not const. It modifies the QAbstractXmlForwardIterator. The reason for this is efficiency. If this QAbstractXmlForwardIterator must not be changed, get a copy() before performing the count.

The default implementation simply calls next() until the end is reached. Hence, it may be of interest to override this function if the sub-class knows a better way of computing its count.

The number of items in the sequence is returned.

Reimplemented from QAbstractXmlForwardIterator< TResult >.

Definition at line 181 of file qsequencemappingiterator_p.h.

     {
         TSource unit(m_mainIterator->next());
         xsInteger c = 0;
 
         while(!qIsForwardIteratorEnd(unit))
         {
             const typename QAbstractXmlForwardIterator<TResult>::Ptr sit(m_mapper->mapToSequence(unit, m_context));
             c += sit->count();
             unit = m_mainIterator->next();
         }
 
         return c;
     }

◆ current()

template<typename TResult , typename TSource , typename TMapper >

TResult QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::current ( ) const

virtual

Returns the current item in the sequence.

If this function is called before the first call to next(), a null object is returned. If the end of the sequence has been reached, a null object is returned.

Implements QAbstractXmlForwardIterator< TResult >.

Definition at line 197 of file qsequencemappingiterator_p.h.

     {
         return m_current;
     }

◆ next()

template<typename TResult , typename TSource , typename TMapper >

TResult QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::next ( )

virtual

Returns the next item in the sequence, or a null object if the end has been reached.

Implements QAbstractXmlForwardIterator< TResult >.

Definition at line 145 of file qsequencemappingiterator_p.h.

     {
         /* This was once implemented with a recursive function, but the stack
          * got blown for some inputs by that approach. */
         while(true)
         {
             while(!m_currentIterator)
             {
                 const TSource mainItem(m_mainIterator->next());
 
                 if(qIsForwardIteratorEnd(mainItem)) /* We've reached the very end. */
                 {
                     m_position = -1;
                     m_current = TResult();
                     return TResult();
                 }
                 else
                     m_currentIterator = m_mapper->mapToSequence(mainItem, m_context);
             }
 
             m_current = m_currentIterator->next();
 
             if(qIsForwardIteratorEnd(m_current))
             {
                 m_currentIterator.reset();
                 continue;
             }
             else
             {
                 ++m_position;
                 return m_current;
             }
         }
     }

◆ position()

template<typename TResult , typename TSource , typename TMapper >

xsInteger QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::position ( ) const

virtual

Returns the current position in the sequence represented by this.

The first position is 1, not 0. If next() hasn't been called, 0 is returned. If this has reached the end, -1 is returned.

Implements QAbstractXmlForwardIterator< TResult >.

Definition at line 203 of file qsequencemappingiterator_p.h.

     {
         return m_position;
     }

Properties

◆ m_context

template<typename TResult , typename TSource , typename TMapper >

const DynamicContext::Ptr QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::m_context

private

Definition at line 126 of file qsequencemappingiterator_p.h.

Referenced by QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::copy(), QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::count(), and QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::next().

◆ m_current

template<typename TResult , typename TSource , typename TMapper >

TResult QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::m_current

private

Definition at line 123 of file qsequencemappingiterator_p.h.

Referenced by QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::current(), and QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::next().

◆ m_currentIterator

template<typename TResult , typename TSource , typename TMapper >

QAbstractXmlForwardIterator<TResult>::Ptr QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::m_currentIterator

private

Definition at line 125 of file qsequencemappingiterator_p.h.

Referenced by QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::next().

◆ m_mainIterator

template<typename TResult , typename TSource , typename TMapper >

QAbstractXmlForwardIterator<TSource>::Ptr QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::m_mainIterator

private

Definition at line 124 of file qsequencemappingiterator_p.h.

Referenced by QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::copy(), QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::count(), and QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::next().

◆ m_mapper

template<typename TResult , typename TSource , typename TMapper >

const TMapper QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::m_mapper

private

Definition at line 127 of file qsequencemappingiterator_p.h.

Referenced by QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::copy(), QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::count(), and QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::next().

◆ m_position

template<typename TResult , typename TSource , typename TMapper >

xsInteger QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::m_position

private

Definition at line 122 of file qsequencemappingiterator_p.h.

Referenced by QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::next(), and QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >::position().

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

/src/xmlpatterns/api/qabstractxmlnodemodel.h
/src/xmlpatterns/iterators/qsequencemappingiterator_p.h

Public Functions

Properties

Additional Inherited Members

Detailed Description

template<typename TResult, typename TSource, typename TMapper> class QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >

Constructors and Destructors

◆ SequenceMappingIterator()

Functions

◆ copy()

◆ count()

◆ current()

◆ next()

◆ position()

Properties

◆ m_context

◆ m_current

◆ m_currentIterator

◆ m_mainIterator

◆ m_mapper

◆ m_position

template<typename TResult, typename TSource, typename TMapper>
class QPatternist::SequenceMappingIterator< TResult, TSource, TMapper >