de.bsvrz.pua.prot.processing.archivebuffer
Class RealArchiveElement

java.lang.Object
  extended by de.bsvrz.pua.prot.processing.ValueProvider
      extended by de.bsvrz.pua.prot.processing.archivebuffer.RealArchiveElement
Direct Known Subclasses:
RealArchiveAttribute, RealArchiveAttributeGroup

public abstract class RealArchiveElement
extends ValueProvider

Klasse die Methoden zur Bestimmung von Archiv-Werten für reale Attribute und Attributgruppen durchführt. Basisklasse für Attributgruppen oder Reales Attribute mit zusätzlichen Informationen für die Datenaufbereitung.

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

Field Summary
 
Fields inherited from class de.bsvrz.pua.prot.processing.ValueProvider
dataInformation, value
 
Constructor Summary
RealArchiveElement(ArchiveUser archiveUser, DataDescription dataDescription, SystemObject object, boolean deltaProtocol, boolean isShown, boolean padData)
          Konstruktor.
 
Method Summary
 void abort()
          Bricht die Datensammlung ab.
protected  boolean executeTake(long timeout)
          Holt den nächsten Datensatz aus dem Archivsystem.
protected  ArchiveUser getArchiveUser()
          Liefert eine Verbindung zum Archivsystem mit Standardparametern für die Archivanfrage.
 boolean hasNext()
          Zeigt an ob noch weitere Daten geliefert werden.
 void request()
          Führt eine Archivanfrage durch.
 java.lang.String toString()
           
 boolean updateDataInformation()
          Erzeugt die Markierungsinformation.
 
Methods inherited from class de.bsvrz.pua.prot.processing.ValueProvider
getDataInformation, getMostRecentDataIndex, getMostRecentTimeStamp, getUsedDataIndex, getUsedTimeStamp, getValue, isShown, isWinner, lost, reset, take, won
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RealArchiveElement

public RealArchiveElement(ArchiveUser archiveUser,
                          DataDescription dataDescription,
                          SystemObject object,
                          boolean deltaProtocol,
                          boolean isShown,
                          boolean padData)
Konstruktor.

Parameters:
archiveUser - Verbindung zum Archivsystem
dataDescription - Datenbeschreibung. Wichtig: Simulationsvariante muss explizit gesetzt werden! Sonst liefert dataDescription.getSimVar() ggf. -1, und das kann vom Archivsystem nicht verarbeitet werden.
object - Objekt für das die Archivanfrage gestellt werden soll.
deltaProtocol - Soll ein Änderungsprotokoll erzeugt werden?
isShown - Wird das Element im Spalten-Bereich verwendet? trueElement wird im Spalten Bereich verwendet.
padData - true falls Daten aufgefüllt werden dürfen.
Method Detail

request

public void request()
             throws FailureException,
                    java.lang.InterruptedException
Führt eine Archivanfrage durch. Dabei werden die im Konstruktor übergebenen Standardparameter von archiveUserverwendet. Nach dem erfolgreichen Ausführen dieser Methode wird hasNext() true zurückliefern.

Throws:
FailureException - Fehler bei der Archivanfrage
java.lang.InterruptedException - Warten auf Antwortdatensatz wurde unterbrochen.

executeTake

protected boolean executeTake(long timeout)
                       throws FailureException,
                              java.lang.InterruptedException
Holt den nächsten Datensatz aus dem Archivsystem.

Specified by:
executeTake in class ValueProvider
Parameters:
timeout - Hat keine Bedeutung
Returns:
true falls Daten empfangen wurde, false falls es keine Daten gibt.
Throws:
FailureException - Fehler bei der Archivanfrage
java.lang.InterruptedException - Warten auf Antwortdatensatz wurde unterbrochen.

updateDataInformation

public boolean updateDataInformation()
Description copied from class: ValueProvider
Erzeugt die Markierungsinformation.

Specified by:
updateDataInformation in class ValueProvider
Returns:
true: Es gibt einen Sprung im Datensatzindex. (Ist dies der Fall, muss muss ein leerer Datensatz eingefügt werden! Siehe TAnf V.1.1 S. 33, "Markierung Pot. Datenlücke"). Falls noch keine Daten vorliegen, wird false zurückgegeben.
See Also:
ValueProvider.updateDataInformation()

hasNext

public boolean hasNext()
Description copied from class: ValueProvider
Zeigt an ob noch weitere Daten geliefert werden. Der Wert wird nur durch einen Aufruf von ValueProvider.take(long) aktualisiert. false wird erst zurückgeliefert, wenn der Versuch weitere Daten mittels ValueProvider.take(long) abzurufen fehlschlägt.

Specified by:
hasNext in class ValueProvider
Returns:
true falls noch weitere Daten geliefert werden.false sonst.
See Also:
ValueProvider.hasNext()

getArchiveUser

protected ArchiveUser getArchiveUser()
Liefert eine Verbindung zum Archivsystem mit Standardparametern für die Archivanfrage.

Returns:
Liefert eine Verbindung zum Archivsystem

abort

public void abort()
Bricht die Datensammlung ab.

Specified by:
abort in class ValueProvider
See Also:
ArchiveDataStream#abort()

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.