org.obe.xpdl.model.data
Class FormalParameter

java.lang.Object
  org.obe.util.AbstractBean
      org.obe.xpdl.model.data.FormalParameter

All Implemented Interfaces:

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

Direct Known Subclasses:

EventParameter

public class FormalParameter

extends AbstractBean

FormalParameter defines input and output parameters which are passed to tools.

Author:

Adrian Price

See Also:

Serialized Form

Constructor Summary

FormalParameter()
Constructs a new FormalParameter object.

FormalParameter(java.lang.String id, java.lang.Integer index, ParameterMode mode, DataType dataType, java.lang.String description)
Constructs a new FormalParameter object.

FormalParameter(java.lang.String id, java.lang.String index, java.lang.String mode, DataType dataType, java.lang.String description)
Constructs a new FormalParameter object.

Method Summary

void	accept(PackageVisitor visitor)
DataType	getDataType()
java.lang.String	getDataTypeString()
java.lang.String	getDescription()
java.lang.String	getId() Get the unique id.
java.lang.Integer	getIndex()
ParameterMode	getMode() Get the parameter mode.
java.lang.String	getModeString() Returns the parameter mode as a string.
void	setDataType(DataType dataType)
void	setDataTypeString(java.lang.String basicType)
void	setDescription(java.lang.String description)
void	setId(java.lang.String id)
void	setIndex(java.lang.Integer index)
void	setIndex(java.lang.String index)
void	setMode(ParameterMode mode) Set the parameter mode.
void	setModeString(java.lang.String mode) Sets the parameter mode as a string.
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

FormalParameter

public FormalParameter()

Constructs a new FormalParameter object.

FormalParameter

public FormalParameter(java.lang.String id,
                       java.lang.String index,
                       java.lang.String mode,
                       DataType dataType,
                       java.lang.String description)

Constructs a new FormalParameter object.

Parameters:

id - The unique id

index - The index of the parameter

mode - The ParameterMode

dataType - The DataType

description - The name

FormalParameter

public FormalParameter(java.lang.String id,
                       java.lang.Integer index,
                       ParameterMode mode,
                       DataType dataType,
                       java.lang.String description)

Constructs a new FormalParameter object.

Parameters:

id - The unique id

index - The index of the parameter

mode - The ParameterMode

dataType - The DataType

description - The description

Method Detail

accept

public final void accept(PackageVisitor visitor)

getId

public final java.lang.String getId()

Get the unique id.

Returns:

The id

setId

public final void setId(java.lang.String id)

getDescription

public final java.lang.String getDescription()

setDescription

public final void setDescription(java.lang.String description)

getIndex

public final java.lang.Integer getIndex()

setIndex

public final void setIndex(java.lang.Integer index)

setIndex

public final void setIndex(java.lang.String index)

getDataType

public final DataType getDataType()

setDataType

public final void setDataType(DataType dataType)

getDataTypeString

public final java.lang.String getDataTypeString()

setDataTypeString

public final void setDataTypeString(java.lang.String basicType)

getMode

public final ParameterMode getMode()

Get the parameter mode. The default parameter mode of ParameterMode.IN.

Returns:

The parameter mode

setMode

public final void setMode(ParameterMode mode)

Set the parameter mode. If a null value is passed then the parameter mode will be treated as ParameterMode.IN.

Parameters:

mode - The new parameter mode

getModeString

public final java.lang.String getModeString()

Returns the parameter mode as a string.

Returns:

Parameter mode string.

setModeString

public final void setModeString(java.lang.String mode)

Sets the parameter mode as a string. If a null value is passed then the parameter mode will be reset to the default (ParameterMode.IN).

Parameters:

mode - The new parameter mode. Must be a valid ParameterMode.

toString

public java.lang.String toString()