("START");
+
+ /**
+ *
+ * Global end event that can be used to indicate the end of a sequence.
+ */
public static final Event ENDEVENT = new Event("END");
-
+
/**
*
@@ -16,11 +37,10 @@
*/
private String type;
-
- /**
- *
- * Target of the event.
+
+ /**
+ *
Target of the event.
*/
private String target = null;
-
+
/**
*
@@ -30,9 +50,19 @@
private String targetShort = null;
-
+ /**
+ * Further information about the event that shall be included in its Id.
+ */
private String idInfo = "";
-
+
+ /**
+ *
+ * Constructor. Creates a new Event with a given type.
+ *
+ *
+ * @param type
+ * type of the event
+ */
public Event(String type) {
- if( type==null ) {
+ if (type == null) {
throw new InvalidParameterException("Event type must not be null");
}
@@ -40,17 +70,30 @@
}
+ /**
+ *
+ * Two events are equal, if their {@link #type} and {@link #target} are
+ * equal.
+ *
+ *
+ * See {@link Object#equals(Object)} for further information.
+ *
+ *
+ * @param other
+ * Event that is compared to this
+ * @return true, if events are equal, false otherwise
+ */
@Override
public boolean equals(Object other) {
- if( this==other ) {
+ if (this == other) {
return true;
}
if (other instanceof Event) {
Event otherEvent = (Event) other;
- if( target!=null ) {
+ if (target != null) {
return type.equals(otherEvent.type)
- && target.equals(otherEvent.target);
+ && target.equals(otherEvent.target);
} else {
return type.equals(otherEvent.type)
- && otherEvent.target==null;
+ && otherEvent.target == null;
}
} else {
@@ -58,5 +101,12 @@
}
}
-
+
+ /**
+ *
+ * Returns {@link #getStandardId()} as String representation of the event.
+ *
+ *
+ * @return String represenation of the event
+ */
@Override
public String toString() {
@@ -64,14 +114,31 @@
}
+ /**
+ * Informations about the event important for its Id that is neither target
+ * nor type.
+ *
+ * @return {@link #idInfo} of the event
+ */
public String getIdInfo() {
return idInfo;
}
+ /**
+ *
+ * If {@link #targetShort} is set, a shortend version of the Id is returned
+ * of the form {@link #targetShort}.{@link #type}.{@link #idInfo} is
+ * returned. Otherwise the standard Id is returned (see
+ * {@link #getStandardId()}).
+ *
+ *
+ * @return if available, shortend Id string; {@link #getStandardId()}
+ * otherwise
+ */
public String getShortId() {
String shortId = null;
- if (targetShort!=null) {
- shortId = targetShort+"."+getType();
- if ( !"".equals(idInfo)) {
- shortId += "."+idInfo;
+ if (targetShort != null) {
+ shortId = targetShort + "." + getType();
+ if (!"".equals(idInfo)) {
+ shortId += "." + idInfo;
}
} else {
@@ -81,11 +148,19 @@
}
+ /**
+ *
+ * Returns the Id string of the event. It has the form {@link #target}.
+ * {@link #type}.{@link #idInfo};
+ *
+ *
+ * @return Id string of the event
+ */
public String getStandardId() {
String id = "";
- if( target!=null ) {
+ if (target != null) {
id += target + ".";
}
id += getType();
- if ( !"".equals(idInfo) ) {
+ if (!"".equals(idInfo)) {
id += "." + idInfo;
}
@@ -93,16 +168,42 @@
}
+ /**
+ *
+ * Returns the {@link #target} of the event.
+ *
+ *
+ * @return {@link #target} of the event
+ */
public String getTarget() {
return target;
}
-
- public String getTargetShort() {
+
+ /**
+ *
+ * Returns the {@link #targetShort} of the event.
+ *
+ *
+ * @return {@link #targetShort} of the event
+ */
+ protected String getTargetShort() {
return targetShort;
}
+ /**
+ *
+ * Returns the {@link #type} of the event.
+ *
+ *
+ * @return {@link #type} of the event
+ */
public String getType() {
return type;
}
+ /*
+ * (non-Javadoc)
+ *
+ * @see java.lang.Object#hashCode()
+ */
@Override
public int hashCode() {
@@ -110,5 +211,5 @@
int hash = 42;
hash = multiplier * hash + type.hashCode();
- if( target!=null ) {
+ if (target != null) {
hash = multiplier * hash + target.hashCode();
}
@@ -117,17 +218,29 @@
}
+ /**
+ *
+ * Sets the {@link #idInfo} of the event. The idInfo is optional and
+ * contains information important for the event's Id that is neither target
+ * nor type.
+ *
+ *
+ * @param info
+ * {@link #idInfo} of the event
+ */
public void setIdInfo(String info) {
idInfo = info;
}
-
+
/**
*
* Sets the target of the event. Once set, the target cannot be changed.
- *
- * @param target target of the event
+ *
+ *
+ * @param target
+ * target of the event
* @return true, if target was changed, false otherwise
*/
public boolean setTarget(String target) {
- if( this.target!=null ) {
+ if (this.target != null) {
return false;
}
@@ -135,14 +248,17 @@
return true;
}
-
- /**
- *
- * Sets the short description of the event target. Once set, the target cannot be changed.
- *
- * @param targetShort short target description
+
+ /**
+ *
+ * Sets the short description of the event target. Once set, the target
+ * cannot be changed.
+ *
+ *
+ * @param targetShort
+ * short target description
* @return true, if target was changed, false otherwise
*/
public boolean setTargetShort(String targetShort) {
- if( this.targetShort!=null ) {
+ if (this.targetShort != null) {
return false;
}
Index: trunk/EventBenchCore/src/de/ugoe/cs/eventbench/data/IReplayable.java
===================================================================
--- trunk/EventBenchCore/src/de/ugoe/cs/eventbench/data/IReplayable.java (revision 78)
+++ trunk/EventBenchCore/src/de/ugoe/cs/eventbench/data/IReplayable.java (revision 79)
@@ -1,8 +1,33 @@
package de.ugoe.cs.eventbench.data;
+/**
+ *
+ * This interface is used by {@link ReplayableEvent}to describe how events can
+ * be replayed. It can be used to define a sequence of fine-grained platform
+ * events that make up an abstract event.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ */
public interface IReplayable {
-
+
+ /**
+ *
+ * Returns a string to be written to the replay script that describes the
+ * replayable platform event.
+ *
+ *
+ * @return string for the replay script
+ */
String getReplayXml();
-
+
+ /**
+ *
+ * Returns the target of the replayable.
+ *
+ *
+ * @return target of the replayable
+ */
String getTarget();
}
Index: trunk/EventBenchCore/src/de/ugoe/cs/eventbench/data/ReplayableEvent.java
===================================================================
--- trunk/EventBenchCore/src/de/ugoe/cs/eventbench/data/ReplayableEvent.java (revision 78)
+++ trunk/EventBenchCore/src/de/ugoe/cs/eventbench/data/ReplayableEvent.java (revision 79)
@@ -6,52 +6,141 @@
import de.ugoe.cs.eventbench.IReplayDecorator;
+/**
+ *
+ * Subclass of {@link Event} for events that contain all informations required
+ * for replaying them, i.e., generating scripts that can used for automated
+ * software execution.
+ *
+ *
+ * @author Steffen Herbold
+ * @version 1.0
+ *
+ * @param
+ * Allows only types that extend {@link IReplayable} and is used to
+ * define a list of replayables that describe the replay of the
+ * event.
+ */
public class ReplayableEvent extends Event {
+ /**
+ *
+ * List of {@link IReplayable}s of type T that describes the replay of an
+ * event. The {@link IReplayable}s can be interpreted as sub-events
+ * on the platform level that make up the abstract event.
+ *
+ */
private List replayEvents = new LinkedList();;
+ /**
+ *
+ * Defines whether the replay is valid or invalid. It may be invalid, e.g.,
+ * due to errors during the generation of the event or lack of vital
+ * information.
+ *
+ */
private boolean replayValid = true;
-
+
+ /**
+ *
+ * {@link IReplayDecorator} used when replays of this type are written.
+ *
+ */
private IReplayDecorator decorator = null;
-
+
+ /**
+ *
+ * Constructor. Creates a new event with the given type.
+ *
+ *
+ * @param type
+ * type of the event
+ * @see Event#Event(String)
+ */
public ReplayableEvent(String type) {
super(type);
}
-
+
+ /**
+ *
+ * Adds a new {@link IReplayable} of type T to the replay sequence.
+ *
+ *
+ * @param replayable
+ * element that is added to the sequence
+ */
+ public void addReplayEvent(T replayable) {
+ replayEvents.add(replayable);
+ }
+
+ /**
+ *
+ * Adds a {@link List}ist of {@link IReplayable} to the replay sequence.
+ *
+ *
+ * @param generatedReplaySeq
+ * {@link List} that is added to the sequence
+ */
public void addReplaySequence(List generatedReplaySeq) {
replayEvents.addAll(generatedReplaySeq);
}
- public void addReplayEvent(T replayable) {
- replayEvents.add(replayable);
+ /**
+ *
+ * Returns the {@link IReplayDecorator} of the event.
+ *
+ *
+ * @return {@link IReplayDecorator} of the event; null if no decorator has
+ * been set
+ */
+ public IReplayDecorator getReplayDecorator() {
+ return decorator;
}
-
+
/**
*
* Returns a the list of replay events.
- *
+ *
*
* The return value is a copy of the list used internally!
*
- * @return list of replay events.
+ *
+ * @return list of replay events.
*/
public List getReplayMessages() {
return new LinkedList(replayEvents);
}
-
+
+ /**
+ *
+ * Returns whether the replay is valid or not.
+ *
+ *
+ * @return true, if replay is valid; false otherwise.
+ */
public boolean hasValidReplay() {
return replayValid;
}
+ /**
+ *
+ * Marks the replay as invalid. Once marked as invalid, it remains so and
+ * cannot be changed back to valid.
+ *
+ */
public void invalidateReplay() {
replayValid = false;
}
+ /**
+ *
+ * Sets the {@link IReplayDecorator} associated with the event.
+ *
+ *
+ * @param decorator
+ * decorator associated with the event
+ */
public void setDecorator(IReplayDecorator decorator) {
this.decorator = decorator;
}
-
- public IReplayDecorator getReplayDecorator() {
- return decorator;
- }
}