de.bsvrz.pua.prot.client
Class ProtocolResultStream

java.lang.Object
  extended by de.bsvrz.pua.prot.client.ProtocolResultStream

public class ProtocolResultStream
extends java.lang.Object

Klasse zum Abfragen der Ergebnisdatensätze.

Version:
$Revision: 1.2 $ / $Date: 2008/01/22 16:55:50 $ / ($Author: yvonnes $)
Author:
beck et al. projects GmbH, Martin Hilgers

Constructor Summary
ProtocolResultStream(ProtocolAnswerReceiver receiver, ProtocolRequestResult result)
           
 
Method Summary
 void abort()
          Meldet das Objekt beim Datenverteiler als Empfänger ab.
 int bufferedDataSize()
          Liefert die Anzahl der im Client-Puffer liegenden Datensätze.
 java.lang.String getErrorMsg()
           
 java.lang.Long getProtocolId()
          Liefert die Protokoll-Id zurück.
 boolean hasNext()
          Zeigt an dass keine weiteren Ergebnisdatensätze mehr eintreffen werden.
 boolean isComplete()
          Zeigt an ob das Protokoll vollständig und erfolgreich übertragen wurde.
 boolean isRequestSuccessful()
          Zeigt den Status der Aktion ab.
 ProtocolResult take()
          Liefert jeweils einen Antwortdatensatz.
 java.lang.String toString()
           
 boolean wasAborted()
          Zeigt ob die Protokollerstellung abgebrochen wurde.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProtocolResultStream

public ProtocolResultStream(ProtocolAnswerReceiver receiver,
                            ProtocolRequestResult result)
                     throws FailureException
Parameters:
receiver - Empfänger der Ergebnisdaten.
result - Zeigt ob das Absetzen des Auftrags zur Protokollerstellung erfolgreich war.
Throws:
FailureException - Fehler bei der Initialisierung.
Method Detail

isRequestSuccessful

public boolean isRequestSuccessful()
Zeigt den Status der Aktion ab. Der Status kann sich nach jedem Aufruf von take() verändern. Wird beispielsweise ein Protokoll erstellt, so ist wird die Methode true zurückliefern, wenn die Anfrage an den Server gesendet werden konnte. D.h. true bedeutet in diesem Fall nicht, dass das Protokoll erfolgreich erstellt wurde, sondern nur, dass die Anfrage an den Server gesendet wurde. Ruft man nun take() auf, und anschließend wieder isRequestSuccessful(), dann wird z.B. false geliefert, wenn es zu einem fehler bei der Protokollerstellung kam - etwa durch einen Syntaxfehler im Skript.

Returns:
True, falls die Aktion momentan keine Fehler meldet.

isComplete

public boolean isComplete()
Zeigt an ob das Protokoll vollständig und erfolgreich übertragen wurde.

Returns:
true falls das Protokoll vollständig übertragen wurde.false falls noch nicht alle Ergebnidatensätze eingetroffen sind oder das Protokoll abgebrochen wurde.

getErrorMsg

public java.lang.String getErrorMsg()
Returns:
Liefert eine Fehlermeldung zurück, falls es zu einem Fehler kam.

take

public ProtocolResult take()
                    throws java.lang.InterruptedException
Liefert jeweils einen Antwortdatensatz. Blockiert so lange, bis ein Antwortdatensatz vorliegt. Sobald der letzte Datensatz oder ein Fehler empfangen wurde, meldet sich das Objekt beim Datenverteiler als Empfänger ab.

Returns:
Antwortdatensatz. null falls bereits alle Antwortdatensätze ausgeliefert wurden.
Throws:
java.lang.InterruptedException - Warten auf Antwortdatensatz wurde unterbrochen.

hasNext

public boolean hasNext()
Zeigt an dass keine weiteren Ergebnisdatensätze mehr eintreffen werden. take() wird genau 1x null zurückliefern, bevor isDone true zurückliefert.

Returns:
true falls alle Ergebnisdatensätze abgeholt wurden.

abort

public void abort()
Meldet das Objekt beim Datenverteiler als Empfänger ab.


wasAborted

public boolean wasAborted()
Zeigt ob die Protokollerstellung abgebrochen wurde.

Returns:
true falls die Protokollerstellung abgebrochen wurde.

getProtocolId

public java.lang.Long getProtocolId()
Liefert die Protokoll-Id zurück. Wichtig: Wird diese Methode direkt nach dem Absetzen des Auftrages zur Protokollerstellung abgesetzt, ist die Protokoll-Id noch unbekannt, und es wird null zurückgegeben!

Returns:
Protokoll-Id oder null, falls die Protokoll-id noch unbekannt ist.

bufferedDataSize

public int bufferedDataSize()
Liefert die Anzahl der im Client-Puffer liegenden Datensätze.

Returns:
Anzahl der im Client-Puffer liegenden Datensätze.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()


Copyright © 2005-2008 beck et al. projects GmbH All Rights Reserved.