Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.milligan.eccles.tags
Class ForEachTag  view ForEachTag download ForEachTag.java

java.lang.Object
  extended byorg.milligan.eccles.Tag
      extended byorg.milligan.eccles.tags.ForEachTag

public class ForEachTag
extends org.milligan.eccles.Tag

Loop over items in a collection


Field Summary
private  java.lang.String collection
           
private  java.lang.String index
           
protected static java.lang.String PROP_ITERATOR
           
private  java.lang.String property
           
 
Fields inherited from class org.milligan.eccles.Tag
CONTINUE_PROCESSING, EXCEPTION_PROPERTY, log, PROCESS_CHILDREN, SIMPLE_BREAK, SKIP_CHILDREN, UNDERLYING_EXCEPTION_PROPERTY
 
Constructor Summary
ForEachTag()
           
 
Method Summary
 org.milligan.eccles.EcclesReturnValue doAfterChildren(org.milligan.eccles.RunState state)
          Called after children have been processed.
 org.milligan.eccles.EcclesReturnValue doStartTag(org.milligan.eccles.RunState state)
          Called at the start of tag processing.
 java.lang.String getCollection()
           
 java.lang.String getIndex()
           
 java.lang.String getProperty()
           
 java.lang.String getTagName()
          Name of the tag as it appears in the config file.
 void setCollection(java.lang.String collection)
           
 void setIndex(java.lang.String index)
           
 void setProperty(java.lang.String property)
           
 
Methods inherited from class org.milligan.eccles.Tag
addChildTag, doEndTag, doFinishChildren, doInitChildren, getChildren, getId, getName, getParent, getPropertiesString, getTagPropertiesForDisplay, hasChildren, isEmpty, isReportingTag, populateElement, populateElementPropertiesFromTag, setChildren, setId, setName, validate, validateHasNoChildren, validateNotEmptyProperties, validateNotEmptyProperties, validateNotEmptyProperties, validateNotEmptyProperty, validateProperties, validateProperties, validateProperties, validateProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROP_ITERATOR

protected static final java.lang.String PROP_ITERATOR
See Also:
Constant Field Values

property

private java.lang.String property

collection

private java.lang.String collection

index

private java.lang.String index
Constructor Detail

ForEachTag

public ForEachTag()
Method Detail

getTagName

public java.lang.String getTagName()
Description copied from class: org.milligan.eccles.Tag
Name of the tag as it appears in the config file. Used for exception & status reporting


setProperty

public void setProperty(java.lang.String property)

getProperty

public java.lang.String getProperty()

setCollection

public void setCollection(java.lang.String collection)

getCollection

public java.lang.String getCollection()

doStartTag

public org.milligan.eccles.EcclesReturnValue doStartTag(org.milligan.eccles.RunState state)
                                                 throws org.milligan.eccles.EcclesException
Description copied from class: org.milligan.eccles.Tag
Called at the start of tag processing. Return either PROCESS_CHILDREN (to process the children) or SKIP_CHILDREN


doAfterChildren

public org.milligan.eccles.EcclesReturnValue doAfterChildren(org.milligan.eccles.RunState state)
                                                      throws org.milligan.eccles.EcclesException
Description copied from class: org.milligan.eccles.Tag
Called after children have been processed. Valid return values are PROCESS_CHILDREN (to go through the loop and process the children again) or SKIP_CHILDREN


setIndex

public void setIndex(java.lang.String index)

getIndex

public java.lang.String getIndex()