Package com._1c.g5.v8.dt.form.service.item

Class FormItemIterator

java.lang.Object

com._1c.g5.v8.dt.form.service.item.FormItemIterator

All Implemented Interfaces:

Iterator<FormItem>

public class FormItemIterator
extends Object
implements Iterator<FormItem>

The iterator for round of all a form items. Items in form object are structured as tree with respect thereto iterator has two search strategy:

• FormItemIterator.SearchStrategy.BreadthFirst - it is Breadth-first search algorithm for tree. It starts at the tree root and explores the neighbor nodes first, before moving to the next level neighbors.
• FormItemIterator.SearchStrategy.DepthFirst - it is Depth-first search algorithm for tree. One starts at the root and explores as far as possible along each branch before backtracking.

The iterator allows to use the custom implementation of round of a form item tree. For this purpose it is necessary you should extends this class(FormItemIterator), and override createSearchStrategy() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	FormItemIterator.ISearchStrategy	The search strategy is provider for iterator on current step.
static class	FormItemIterator.SearchStrategy	The enumerator of search strategy type for a default form item iterator

Field Summary

Fields

Modifier and Type	Field	Description
protected Iterator<FormItem>	current
protected FormItem	currentItem
protected LinkedList<Iterator<FormItem>>	iterators
protected FormItemIterator.ISearchStrategy	strategy

Constructor Summary

Constructors

Constructor	Description
FormItemIterator(FormItemContainer container)	Creates a new form item iterator, with default(FormItemIterator.SearchStrategy.BreadthFirst) search strategy
FormItemIterator(FormItemContainer container, FormItemIterator.SearchStrategy strategy)	Creates a new form item iterator.

Method Summary

Modifier and Type	Method	Description
protected Iterator<FormItem>	computationItemIterator(Object item)	The method creates sub iterator (if it is necessary) for item object.
protected FormItemIterator.ISearchStrategy	createSearchStrategy()	Create a search strategy.
boolean	hasNext()
FormItem	next()
void	remove()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

strategy

protected final FormItemIterator.ISearchStrategy strategy

iterators

protected final LinkedList<Iterator<FormItem>> iterators

current

protected Iterator<FormItem> current

currentItem

protected FormItem currentItem

Constructor Detail

FormItemIterator

public FormItemIterator(FormItemContainer container)

Creates a new form item iterator, with default(FormItemIterator.SearchStrategy.BreadthFirst) search strategy

Parameters:

container - the root element

FormItemIterator

public FormItemIterator(FormItemContainer container,
                        FormItemIterator.SearchStrategy strategy)

Creates a new form item iterator.

Parameters:

container - the root element

strategy - the search strategy, see FormItemIterator.SearchStrategy

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<FormItem>

next

public FormItem next()

Specified by:

next in interface Iterator<FormItem>

remove

public void remove()

Specified by:

remove in interface Iterator<FormItem>

createSearchStrategy

protected FormItemIterator.ISearchStrategy createSearchStrategy()

Create a search strategy. The default form item iterator implementation can creates two types of search : Depth-first and Breadth-first.

Returns:

the search strategy. see FormItemIterator.ISearchStrategy

computationItemIterator

protected Iterator<FormItem> computationItemIterator(Object item)

The method creates sub iterator (if it is necessary) for item object.

Parameters:

item - the current item

Returns:

the sub iterator for item object