de.morknet.mrw.batch

Class Batch

java.lang.Object

de.morknet.mrw.batch.Batch

public class Batch
extends java.lang.Object

Diese Klasse repräsentiert einen Stapel von Kommandos. Die Kommandos werden als MRW-Meldung repräsentiert. Zur MRW-Meldung passt genau ein Gerät. Beides wird als BatchElement in diesem Batch gehalten. Sinn dieses Batches ist, dass alle Kommandos dieses Batches erfolgreich ausgeführt sein muss, bevor der nächste Batch verarbeitet werden darf.

Author:

smork

Constructor Summary

Constructors

Constructor and Description
Batch(BatchExecuter executer) Erzeugt einen neuen Batch.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBatchElement(DeviceUnit device, MrwMessage msg) Fügt ein Kommando dem Batch hinzu.
void	clear() Löscht alle Kommandos aus diesem Batch.
java.lang.Object	getElementCount() Diese Methode gibt die Zahl der Schaltkommandos in diesem Batch zurück.
int	getId() Diese Methode gibt die ID dieses Batches zurück.
java.lang.String	getIdString() Diese Methode bildet einen Text, der die IDs dieses Batches und des dazugehörigen BatchExecuter enthält.
boolean	hasError() Prüft, ob Fehler aufgetreten sind.
boolean	isComplete() Prüft, ob im Batch alle Kommandos zu einer erfolgreichen Rückmeldung geführt haben, oder ob noch Rückmeldungen ausstehen.
boolean	isEmpty() Prüft, ob überhaupt Kommandos zum Versenden anstehen.
(package private) boolean	processResult(MrwMessage msg, BatchElement element) Diese Methode verarbeitet eine MRW-Meldung gemäß ihrem Rückmelde-Code.
void	removeBatchElement(BatchElement element) Entfernt ein BatchElement aus diesem Batch.
(package private) void	sendBatch(Connection connection) Diese Methode sendet diesen Batch über die angegebene Verbindung.
void	setDelay(long delay) Setzt eine Wartezeit, die nach erfolgreichem Versenden der Kommandos gewartet wird.

Methods inherited from class java.lang.Object

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

Constructor Detail

Batch

Batch(BatchExecuter executer)

Erzeugt einen neuen Batch. Dieser Batch kann nur vollständig OK verarbeitet werden oder er führt zu einem Abbruch der weiteren Verarbeitung.

Parameters:

executer - Der übergeordnete BatchExecuter.

Method Detail

addBatchElement

public void addBatchElement(DeviceUnit device,
                   MrwMessage msg)

Fügt ein Kommando dem Batch hinzu. Dieses Kommando wird mittels eines Gerätes zu einem BatchElement verbunden.

Parameters:

device - Das zum Kommando passende Gerät.

msg - Das Kommando als MRW-Meldung.

removeBatchElement

public void removeBatchElement(BatchElement element)

Entfernt ein BatchElement aus diesem Batch. Dies passiert, wenn ein Kommando erfolgreich ausgeführt wurde.

Parameters:

element - Das BatchElement, das entfernt werden soll.

setDelay

public void setDelay(long delay)

Setzt eine Wartezeit, die nach erfolgreichem Versenden der Kommandos gewartet wird.

Parameters:

delay - Das Wartequantum in Millisekunden.

isEmpty

public boolean isEmpty()

Prüft, ob überhaupt Kommandos zum Versenden anstehen.

Returns:

Ob die Kommandoliste leer ist.

sendBatch

void sendBatch(Connection connection)
         throws java.io.IOException

Diese Methode sendet diesen Batch über die angegebene Verbindung. Die Methode wartet, bis ein Timeout erreicht wurde. Kommt als Rückmeldecode MSG_QUEUED, wird der Timeout um eine Sekunde hochgesetzt.

Parameters:

connection - Die Verbindung, über die die Kommandos dieses Batches gesendet werden soll.

Throws:

java.io.IOException - Wird bei Sendefehlern geworfen.

processResult

boolean processResult(MrwMessage msg,
                    BatchElement element)

Diese Methode verarbeitet eine MRW-Meldung gemäß ihrem Rückmelde-Code. Der Code MSG_OK markiert ein BatchElement als erfolgreich verarbeitet. Ein MSG_QUEUED setzt den Timeout um eine Sekunde hoch. Die Rückmelde-Codes

• MSG_NO_UNITNO_DEFINED
• MSG_UNIT_NOT_FOUND
• MSG_UNITNO_MISSING
• MSG_UNITTYPE_WRONG
• MSG_NOT_CONFIGURED_YET
• MSG_SWITCH_FAILED

erhöhen den Fehlerzähler.

Parameters:

msg - Die verarbeitende MRW-Meldung.

Returns:

Ob die Meldung verarbeitet wurde.

hasError

public boolean hasError()

Prüft, ob Fehler aufgetreten sind.

Returns:

True, falls es zu fehlern kam

isComplete

public boolean isComplete()

Prüft, ob im Batch alle Kommandos zu einer erfolgreichen Rückmeldung geführt haben, oder ob noch Rückmeldungen ausstehen.

Returns:

Zustand, ob alle Rückmeldungen erfolgreich eingetroffen sind.

clear

public void clear()

Löscht alle Kommandos aus diesem Batch.

getIdString

public java.lang.String getIdString()

Diese Methode bildet einen Text, der die IDs dieses Batches und des dazugehörigen BatchExecuter enthält.

Returns:

Der Text mit den ID-Informationen

getId

public int getId()

Diese Methode gibt die ID dieses Batches zurück.

Returns:

Die ID dieses Batches.

getElementCount

public java.lang.Object getElementCount()

Diese Methode gibt die Zahl der Schaltkommandos in diesem Batch zurück.

Returns:

Die Zahl der Schaltkommandos in diesem Batch.