com.ibatis.sqlmap.engine.mapping.sql.dynamic.elements

Class IterateContext

public class IterateContext extends Object implements Iterator

Author: Brandon Goodin

Constructor Summary
	IterateContext(Object collection, SqlTag tag, IterateContext parent)

Method Summary
protected Map	addIndex(String input, int startIndex) Adds index value to the first found property matching this Iteration starting at index startIndex.
String	addIndexToTagProperty(String tagProperty) Replaces value of a tag property to match it's value with current iteration and all other iterations.
String	getEndProperty() Returns the last property of any bean specified in this IterateContext.
int	getIndex()
IterateContext	getParent()
String	getProperty()
SqlTag	getTag()
boolean	hasNext()
boolean	isAllowNext()
boolean	isFinal()
boolean	isFirst()
boolean	isLast()
boolean	isPrependEnabled()
Object	next()
protected Map	processTagProperty(String tagProperty) Replaces value of a tag property to match it's value with current iteration and all other iterations.
void	remove()
void	setAllowNext(boolean performIterate)
void	setFinal(boolean aFinal) This attribute is used to mark whether an iterate tag is in it's final iteration.
void	setParent(IterateContext parent)
void	setPrependEnabled(boolean isPrependEnabled)
void	setProperty(String property) This property specifies whether to increment the iterate in the doEndFragment.
void	setSomeSubElementsHaveContent(boolean someSubElementsHaveContent)
void	setTag(SqlTag tag)
boolean	someSubElementsHaveContent()

Constructor Detail

IterateContext

public IterateContext(Object collection, SqlTag tag, IterateContext parent)

Method Detail

addIndex

protected Map addIndex(String input, int startIndex)

Adds index value to the first found property matching this Iteration starting at index startIndex.

Parameters: input The input String. startIndex The index where search for property begins.

Returns: A Map containing the modified tag property in PROCESS_STRING key and the index where the modification occured in PROCESS_INDEX key.

addIndexToTagProperty

public String addIndexToTagProperty(String tagProperty)

Replaces value of a tag property to match it's value with current iteration and all other iterations.

Parameters: tagProperty the property of a TagHandler.

Returns: The tag property with all "[]" replaced with the correct iteration value.

getEndProperty

public String getEndProperty()

Returns the last property of any bean specified in this IterateContext.

Returns: The last property of any bean specified in this IterateContext.

getProperty

public String getProperty()

Returns: Returns the property.

getTag

public SqlTag getTag()

Returns: Returns the tag.

isAllowNext

public boolean isAllowNext()

Returns: Returns the allowNext.

Deprecated: This method should not be used to decide whether or not to add prepend and open text to the generated statement. Rather, use the methods isPrependEnabled() and someSubElementsHaveContent().

Returns:

isLast

public boolean isLast()

isPrependEnabled

public boolean isPrependEnabled()

public Object next()

processTagProperty

protected Map processTagProperty(String tagProperty)

Replaces value of a tag property to match it's value with current iteration and all other iterations.

Parameters: tagProperty the property of a TagHandler.

Returns: A Map containing the modified tag property in PROCESS_STRING key and the index where the modification occured in PROCESS_INDEX key.

remove

public void remove()

setAllowNext

public void setAllowNext(boolean performIterate)

Parameters: performIterate The allowNext to set.

setFinal

public void setFinal(boolean aFinal)

This attribute is used to mark whether an iterate tag is in it's final iteration. Since the ConditionalTagHandler can increment the iterate the final iterate in the doEndFragment of the IterateTagHandler needs to know it is in it's final iterate.

Parameters: aFinal

Parameters: property The property to set.