org.obe.xpdl.model.data
Class DataField

java.lang.Object
  org.obe.util.AbstractBean
      org.obe.xpdl.model.misc.AbstractWFElement
          org.obe.xpdl.model.data.DataField

All Implemented Interfaces:

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

public final class DataField

extends AbstractWFElement

The DataField class represents a data field which is placed in the workflow relevant data when a workflow process executes.

Author:

Adrian Price

See Also:

Serialized Form

Constructor Summary

DataField()

DataField(java.lang.String id, java.lang.String name)

DataField(java.lang.String id, java.lang.String name, DataType dataType)
Construct a new DataField.

Method Summary

void	accept(PackageVisitor visitor)
DataType	getDataType() Get the field's data type.
java.lang.String	getInitialValue() Get the field's initial value.
int	getLength() Get the length of the data field if the field represents an array or list.
boolean	isArray() Return true if the data field is an array.
void	setArray(boolean array) Set the flag indicating that the field is an array.
void	setDataType(DataType dataType) Set the field's data type.
void	setInitialValue(java.lang.String initialValue) Set the field's initial value.
void	setLength(int length) Set the length of the data field.
java.lang.String	toString()

Methods inherited from class org.obe.xpdl.model.misc.AbstractWFElement

createExtendedAttributes, equals, getDescription, getExtendedAttributes, getId, getName, hashCode, setDescription, setExtendedAttributes, setId, setName

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataField

public DataField()

DataField

public DataField(java.lang.String id,
                 java.lang.String name)

DataField

public DataField(java.lang.String id,
                 java.lang.String name,
                 DataType dataType)

Construct a new DataField.

Parameters:

id - The data field id

name - The data field name

dataType - The data type

Method Detail

accept

public void accept(PackageVisitor visitor)

getDataType

public DataType getDataType()

Get the field's data type.

Returns:

The DataType

setDataType

public void setDataType(DataType dataType)

Set the field's data type. The data type must not be null.

Parameters:

dataType - The data type

getInitialValue

public java.lang.String getInitialValue()

Get the field's initial value.

Returns:

The initial value

setInitialValue

public void setInitialValue(java.lang.String initialValue)

Set the field's initial value.

Parameters:

initialValue - The new initial value

getLength

public int getLength()

Get the length of the data field if the field represents an array or list. If the field is a single value then this method should return 0.

Returns:

The field's length for arrays or 0

setLength

public void setLength(int length)

Set the length of the data field.

Parameters:

length - The length

isArray

public boolean isArray()

Return true if the data field is an array.

Returns:

True if the data field is an array

setArray

public void setArray(boolean array)

Set the flag indicating that the field is an array.

Parameters:

array - True to indicate that the field is an array

toString

public java.lang.String toString()

Overrides:

toString in class AbstractWFElement