org.obe.xpdl.model.ext
Class ForEach

java.lang.Object
  org.obe.util.AbstractBean
      org.obe.xpdl.model.ext.LoopBody
          org.obe.xpdl.model.ext.ForEach

All Implemented Interfaces:

java.beans.beancontext.BeanContextChild, java.io.Serializable

public final class ForEach

extends LoopBody

Describes a FOR_EACH iterator loop.

Author:

Adrian Price

See Also:

Serialized Form

Field Summary

Fields inherited from class org.obe.xpdl.model.ext.LoopBody

FOR_EACH, NONE, UNTIL, WHILE

Constructor Summary

ForEach()
Constructs a ForEach loop body.

ForEach(java.lang.String dataField, java.lang.String expr)
Constructs a ForEach loop body.

Method Summary

java.lang.String	getDataField() Returns the name of the data field with which to iterate.
java.lang.String	getExpr() Returns an expression that defines the collection over which to iterate.
int	getType()
void	setDataField(java.lang.String dataField) Sets the name of the data field with which to iterate.
void	setExpr(java.lang.String expr) Sets the expression that defines the collection over which to iterate.
java.lang.String	toString()

Methods inherited from class org.obe.util.AbstractBean

add, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, clear, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, get, get, getBeanContext, getListModel, hasChangeListeners, hasVetoListeners, remove, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, set, set, setBeanContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ForEach

public ForEach()

Constructs a ForEach loop body.

ForEach

public ForEach(java.lang.String dataField,
               java.lang.String expr)

Constructs a ForEach loop body.

Parameters:

dataField - The data field name.

expr - The collection expression.

Method Detail

getDataField

public java.lang.String getDataField()

Returns the name of the data field with which to iterate.

Returns:

Data field name.

setDataField

public void setDataField(java.lang.String dataField)

Sets the name of the data field with which to iterate.

Parameters:

dataField - The data field name.

getExpr

public java.lang.String getExpr()

Returns an expression that defines the collection over which to iterate.

Returns:

The collection expression.

setExpr

public void setExpr(java.lang.String expr)

Sets the expression that defines the collection over which to iterate. The expression must yield an array, a collection or a map when evaluated.

Parameters:

expr - The collection expression.

getType

public int getType()

Specified by:

getType in class LoopBody

toString

public java.lang.String toString()