com.basecmp.core.usecase
Class UsecaseStep

java.lang.Object
  com.basecmp.core.usecase.UsecaseStep

Direct Known Subclasses:

BaseCmpUsecaseStep, CallNode, EndNode, JumpNode, StartNode

public abstract class UsecaseStep

extends java.lang.Object

Abstrakte Basis-Implementierung (anstatt Interface) eines UsecaseStep.

Alle selbstentwickelten UsecaseStep-Klassen müssen direkt oder indirekt von dieser Klasse abgeleitet werden. UsecaseMgr übernimmt Framework-intern die Instanzierung der registrieten UscaseStep-Klassen zur Laufzeit. Aus diesem Grund gib es nur einen einfachen Konstruktor und eine davon getrennte Initialisierungs-Methode initStep().

Hinweise und Konventionen zur Entwicklung von UsecaseSteps

• UsecaseStep sollten aus Gründen der Thread-Sicherheit keine Instanz-Variablen. Wenn von diesem Grundsatz abgewichen wird, kann dies zwischen mehreren Threads unter Umständen zu inkonsistenten Zuständen dieser Instanzvariablen kommen (Race-Conditions).
• UsecaseStep sollten die Context-Argumente und -Attribute, die in der Execute-Methode verarbeitet oder erzeugt werden im JavaDoc-Kommentar der Klasse dokumentieren.
• Die Namen der verwendeten oder erzeugten Argumente und Attribute sollten über symbolische String-Variablen referenziert werden. Dazu kann z.B. ein Interface pro Step-Package dienen (siehe UsecaseContextEntries.

Created on 15.09.2003

See Also:

BaseCmpUsecaseStep

Author:

Wolfgang Schröder

Field Summary

protected java.lang.Integer

stepId

Constructor Summary

UsecaseStep()
Standard-Konstruktor.

Method Summary

java.util.Iterator	getConfigKeys() Liefert einen Iterator über alle in der XML-Usecase-Definition definierten Keys.
java.lang.String	getConfigValue(java.lang.String key) Liefert den Konfigurationswert aus der XML-Usecase-Definition zum angegebenen Key.
protected void	initStep(java.lang.Integer stepId) Package-interne Initialisierungs-Methode.
abstract boolean	isCallNode()
abstract boolean	isEndNode()
protected boolean	isInitialized()
abstract boolean	isJumpNode()
abstract boolean	isStartNode()
void	setConfigValue(java.lang.String key, java.lang.String value) Methode zum setzen von Konfigurationswerten, die in der XML-Usecase-Definition statisch gesetzt wurden.

Methods inherited from class java.lang.Object

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

Field Detail

stepId

protected java.lang.Integer stepId

Constructor Detail

UsecaseStep

public UsecaseStep()

Standard-Konstruktor.

Method Detail

getConfigKeys

public java.util.Iterator getConfigKeys()

Liefert einen Iterator über alle in der XML-Usecase-Definition definierten Keys.

getConfigValue

public java.lang.String getConfigValue(java.lang.String key)

Liefert den Konfigurationswert aus der XML-Usecase-Definition zum angegebenen Key. Null, wenn nicht vorhanden.

initStep

protected void initStep(java.lang.Integer stepId)

Package-interne Initialisierungs-Methode. Setzt das Init-Flag.

isCallNode

public abstract boolean isCallNode()

Returns:

True, wenn der Step als CallNode fungieren darf.

isEndNode

public abstract boolean isEndNode()

Returns:

True, wenn der Step als EndNode fungieren darf.

isInitialized

protected boolean isInitialized()

Returns:

True, wenn die Step-Instanz fertig initialisiert wurde.

isJumpNode

public abstract boolean isJumpNode()

Returns:

True, wenn der Step als JumpNode fungieren darf.

isStartNode

public abstract boolean isStartNode()

Returns:

True, wenn der Step als StartNode fungieren darf.

setConfigValue

public void setConfigValue(java.lang.String key,
                           java.lang.String value)

Methode zum setzen von Konfigurationswerten, die in der XML-Usecase-Definition statisch gesetzt wurden. Wird von UsecaseMetaData beim nachträglichen initialisieren benutzt.

Parameters:

key -

value -