IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.automaton
Class TransitionDescriptor

java.lang.Object
  extended by com.ibm.btt.automaton.TransitionDescriptor
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
HtmlTransitionDescriptor

@ATTR(value={"id#String#REQUIRED","propagateEvent#Boolean#IMPLIED","ignoreEntryActions#Boolean#IMPLIED"})
public class TransitionDescriptor
extends java.lang.Object
implements Externalizable

A transitionDescriptor describes the flow that potentially could be produced in response to an event fired while in a state. The result may be a move to a new state, but could also be the transition to another action within the same state. (as a result of one of the actions).

See Also:
Serialized Form

Field Summary
protected  Vector actionsTags
           
protected  boolean ignoreEntryActions
           
protected  boolean ignoreExitActions
           
protected  java.lang.String name
           
protected  boolean propagateEvent
           
protected  java.lang.String targetStateName
           
 
Constructor Summary
TransitionDescriptor()
          Creates an instance of type TransitionDescriptor.
 
Method Summary
 Externalizer externalizer()
          This method gets the externalizer instance used to build.
 Vector getActionsTags()
          Returns a vector of actions Tags.
 java.lang.String getName()
          Returns the value of the name property (the name of the event that triggers this transition).
 java.util.Hashtable getParms()
          Returns the java.util.Hashtable value of the parms property.
 boolean getPropagateEvent()
          Returns the boolean value of the propagateEvent property.
 java.lang.String getTargetStateName()
          Returns the value of the targetStateName property.
 java.lang.Object initializeFrom(Tag aTag)
          Initializes a TransitionDescriptor from its Tag with its id, targetState, and propogateEvent attributes.
 boolean isIgnoreEntryActions()
          Returns the value of the ignoreEntryActions flag.
 boolean isIgnoreExitActions()
          Returns the value of the ignoreExitActions flag.
 void readExternal()
          This method will find the tag that corresponds to the name of THIS entity.
 void readExternal(java.io.ObjectInput in)
          Invokes the object creation from an ObjectInput.
 void removeExternal()
          Removes the Externalizer.
 void setActionsTags(Vector newActions)
          Sets the value of the actions property.
 void setIgnoreEntryActions(boolean newIgnoreEntryActions)
          Sets the value of the ignoreEntryActions flag.
 void setIgnoreExitActions(boolean newIgnoreExitActions)
          Sets the value of the ignoreExitActions flag.
 void setName(java.lang.String newName)
          Sets the value of the name property (the name of the event that triggers this transition).
 void setPropagateEvent(boolean newpropagateEventValue)
          Sets the value of the propagateEvent property.
 void setTargetStateName(java.lang.String newTargetStateName)
          Returns the value of the targetStateName property.
 java.lang.String toString()
          Returns a String representing the transition descriptor.
 Vector toStrings()
          Returns a Vector with the String representation of the object.
 Vector toTags()
          Returns a Vector with the object represented as a Tag.
 void writeExternal()
          Writes this instance (converted into tags) to a file.
 void writeExternal(java.io.ObjectOutput out)
          Provides concrete serialization handling for TransitionDescriptor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

actionsTags

protected Vector actionsTags

targetStateName

protected java.lang.String targetStateName

name

protected java.lang.String name

propagateEvent

protected boolean propagateEvent

ignoreEntryActions

protected boolean ignoreEntryActions

ignoreExitActions

protected boolean ignoreExitActions
Constructor Detail

TransitionDescriptor

public TransitionDescriptor()
Creates an instance of type TransitionDescriptor.

Method Detail

externalizer

public Externalizer externalizer()
                          throws java.io.IOException
This method gets the externalizer instance used to build. This method is an Externalizable interface method.

Returns:
com.ibm.btt.base.Externalizer
Throws:
java.lang.IOException
java.io.IOException

getActionsTags

public Vector getActionsTags()
Returns a vector of actions Tags.

Returns:
com.ibm.btt.base.Vector - a Vector holding the tags for the actions

getName

public java.lang.String getName()
Returns the value of the name property (the name of the event that triggers this transition).

Returns:
java.lang.String

getPropagateEvent

public boolean getPropagateEvent()
Returns the boolean value of the propagateEvent property.

Returns:
boolean

getTargetStateName

public java.lang.String getTargetStateName()
Returns the value of the targetStateName property.

Returns:
java.lang.String

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException,
                                       DSEException
Initializes a TransitionDescriptor from its Tag with its id, targetState, and propogateEvent attributes. Then its action subtags are extracted and stored in a hashtable of actionTags to be instantiated at time of execution. This method is an Externalizable interface method. This method is an Externalizable interface method.

Parameters:
aTag - com.ibm.btt.base.Tag Contains the name and attributes of the object to be created.
Returns:
Object - An instance of TransitionDescriptor.
Throws:
java.io.IOException - The object can not be created.
DSEException

isIgnoreEntryActions

public boolean isIgnoreEntryActions()
Returns the value of the ignoreEntryActions flag.

Returns:
boolean

isIgnoreExitActions

public boolean isIgnoreExitActions()
Returns the value of the ignoreExitActions flag.

Returns:
boolean

readExternal

public void readExternal()
                  throws java.io.IOException
This method will find the tag that corresponds to the name of THIS entity. Then it will initialize THIS entity with the contents of the tag

Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Invokes the object creation from an ObjectInput.

Specified by:
readExternal in interface java.io.Externalizable
Parameters:
in - java.io.ObjectInput
Throws:
java.io.IOException
java.lang.ClassNotFoundException

removeExternal

public void removeExternal()
                    throws java.io.IOException
Removes the Externalizer. This method is an Externalizable interface method.

Throws:
java.lang.IOException
java.io.IOException

setActionsTags

public void setActionsTags(Vector newActions)
Sets the value of the actions property.

Parameters:
newActions - com.ibm.btt.base.Vector

setIgnoreEntryActions

public void setIgnoreEntryActions(boolean newIgnoreEntryActions)
Sets the value of the ignoreEntryActions flag.

Parameters:
newIgnoreEntryActions - boolean

setIgnoreExitActions

public void setIgnoreExitActions(boolean newIgnoreExitActions)
Sets the value of the ignoreExitActions flag.

Parameters:
newIgnoreEntryActions - boolean

setName

public void setName(java.lang.String newName)
Sets the value of the name property (the name of the event that triggers this transition).

Parameters:
newName - java.lang.String

setPropagateEvent

public void setPropagateEvent(boolean newpropagateEventValue)
Sets the value of the propagateEvent property.

Parameters:
newpropagateEventValue - boolean

setTargetStateName

public void setTargetStateName(java.lang.String newTargetStateName)
Returns the value of the targetStateName property.

Parameters:
newNextStateName - java.lang.String

toString

public java.lang.String toString()
Returns a String representing the transition descriptor.

Overrides:
toString in class java.lang.Object
Returns:
java.lang.String.

toStrings

public Vector toStrings()
Returns a Vector with the String representation of the object. This method is an Externalizable interface method.

Returns:
com.ibm.btt.base.Vector

toTags

public Vector toTags()
              throws java.io.IOException
Returns a Vector with the object represented as a Tag. This method is an Externalizable interface method.

Returns:
com.ibm.btt.base.Vector
Throws:
java.io.IOException

writeExternal

public void writeExternal()
                   throws java.io.IOException
Writes this instance (converted into tags) to a file. This method is an Externalizable interface method.

Throws:
java.io.IOException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Provides concrete serialization handling for TransitionDescriptor.

Specified by:
writeExternal in interface java.io.Externalizable
Parameters:
out - java.io.ObjectOutput
Throws:
java.io.IOException

getParms

public java.util.Hashtable getParms()
Returns the java.util.Hashtable value of the parms property.

Returns:
java.util.Hashtable

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2010