de.bsvrz.dav.daf.communication.lowLevel.telegrams
Class ApplicationDataTelegram

java.lang.Object
  extended by de.bsvrz.dav.daf.communication.lowLevel.telegrams.DataTelegram
      extended by de.bsvrz.dav.daf.communication.lowLevel.telegrams.ApplicationDataTelegram
All Implemented Interfaces:
QueueableTelegram

public class ApplicationDataTelegram
extends DataTelegram

Diese Klasse enthält den Teil eines Datensatzes, der zu gross war um komplett versendet zu werden. Es werden alle Informationen gespeichert um dieses Stück des Datensatzes mit den anderen Stücken zu verbinden um den gesamten Datensatz wieder zusammen zu bauen.

Author:
Kappich Systemberatung

Field Summary
 
Fields inherited from class de.bsvrz.dav.daf.communication.lowLevel.telegrams.DataTelegram
APPLICATION_DATA_TELEGRAM_TYPE, AUTHENTIFICATION_ANSWER_TYPE, AUTHENTIFICATION_REQUEST_TYPE, AUTHENTIFICATION_TEXT_ANSWER_TYPE, AUTHENTIFICATION_TEXT_REQUEST_TYPE, CLOSING_TYPE, COM_PARAMETER_ANSWER_TYPE, COM_PARAMETER_REQUEST_TYPE, KEEP_ALIVE_TYPE, length, priority, PROTOCOL_VERSION_ANSWER_TYPE, PROTOCOL_VERSION_REQUEST_TYPE, RECEIVE_SUBSCRIPTION_TYPE, RECEIVE_UNSUBSCRIPTION_TYPE, REQUEST_SENDER_DATA_TYPE, SEND_SUBSCRIPTION_TYPE, SEND_UNSUBSCRIPTION_TYPE, TELEGRAM_TIME_ANSWER_TYPE, TELEGRAM_TIME_REQUEST_TYPE, TERMINATE_ORDER_TYPE, TRANSMITTER_AUTHENTIFICATION_ANSWER_TYPE, TRANSMITTER_AUTHENTIFICATION_REQUEST_TYPE, TRANSMITTER_AUTHENTIFICATION_TEXT_ANSWER_TYPE, TRANSMITTER_AUTHENTIFICATION_TEXT_REQUEST_TYPE, TRANSMITTER_BEST_WAY_UPDATE_TYPE, TRANSMITTER_CLOSING_TYPE, TRANSMITTER_COM_PARAMETER_ANSWER_TYPE, TRANSMITTER_COM_PARAMETER_REQUEST_TYPE, TRANSMITTER_DATA_SUBSCRIPTION_RECEIPT_TYPE, TRANSMITTER_DATA_SUBSCRIPTION_TYPE, TRANSMITTER_DATA_TELEGRAM_TYPE, TRANSMITTER_DATA_UNSUBSCRIPTION_TYPE, TRANSMITTER_KEEP_ALIVE_TYPE, TRANSMITTER_LISTS_DELIVERY_UNSUBSCRIPTION_TYPE, TRANSMITTER_LISTS_SUBSCRIPTION_TYPE, TRANSMITTER_LISTS_UNSUBSCRIPTION_TYPE, TRANSMITTER_LISTS_UPDATE_2_TYPE, TRANSMITTER_LISTS_UPDATE_TYPE, TRANSMITTER_PROTOCOL_VERSION_ANSWER_TYPE, TRANSMITTER_PROTOCOL_VERSION_REQUEST_TYPE, TRANSMITTER_TELEGRAM_TIME_ANSWER_TYPE, TRANSMITTER_TELEGRAM_TIME_REQUEST_TYPE, TRANSMITTER_TERMINATE_ORDER_TYPE, type
 
Constructor Summary
ApplicationDataTelegram()
           
ApplicationDataTelegram(BaseSubscriptionInfo _baseSubscriptionInfo, long _dataNumber, boolean _delayedDataFlag, byte _errorFlag, byte[] _attributesIndicator, byte[] _data, int _totalTelegramCount, int _telegramNumber, long _time)
           
ApplicationDataTelegram(BaseSubscriptionInfo _baseSubscriptionInfo, long _dataNumber, boolean _delayedDataFlag, byte _errorFlag, byte[] _attributesIndicator, byte _priority, byte[] _data, int _totalTelegramCount, int _telegramNumber, long _time)
           
 
Method Summary
 byte[] getAttributesIndicator()
          Gibt den Indikator zu den einzelnen Attributen der Attributegruppe zurück.
 BaseSubscriptionInfo getBaseSubscriptionInfo()
          Gibt die Basisanmeldeinformationen zurück.
 byte[] getData()
          Gibt den Bytestrom dieses Telegramms zurück.
 long getDataNumber()
          Gibt die Laufende Nummer des Datensatzes zurrück.
 long getDataTime()
          Der Zeitstempel der Datensätze.
 boolean getDelayedDataFlag()
          Gibt an, Datensätze nachgeliefert worden sind.
 byte getErrorFlag()
          Gibt die Fehlerinformation zurück.
 int getTelegramNumber()
          Gibt die Telegrammnummer dieses Teiltelegramms zurück.
 int getTotalTelegramsCount()
          Gibt die Gesamtzahl der Teiltelegramme des ursprunglichen Datensatzes zurück.
 String parseToString()
          Gibt eine String-Repräsentation dieses Datensatzes zurück.
 void read(DataInputStream in)
          Liest ein Telegramm vom übergegebenen DataInputStream.
 void setAttributesIndicator(byte[] newIndicators)
          Setzt den Indikator auf den neuen Wert.
 void setDataIndex(long _dataNumber)
          Setzt den Datensatz-Index .
 String toShortDebugParamString()
          Bestimmt eine kurze Beschreibung der Eigenschaften eines Telegramms.
 void write(DataOutputStream out)
          Schreibt ein Telegramm in den übergegebenen DataOutputStream.
 
Methods inherited from class de.bsvrz.dav.daf.communication.lowLevel.telegrams.DataTelegram
getLength, getPriority, getSize, getTelegram, getType, toShortDebugString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ApplicationDataTelegram

public ApplicationDataTelegram()

ApplicationDataTelegram

public ApplicationDataTelegram(BaseSubscriptionInfo _baseSubscriptionInfo,
                               long _dataNumber,
                               boolean _delayedDataFlag,
                               byte _errorFlag,
                               byte[] _attributesIndicator,
                               byte _priority,
                               byte[] _data,
                               int _totalTelegramCount,
                               int _telegramNumber,
                               long _time)
Parameters:
_baseSubscriptionInfo - Basisanmeldeinformation
_dataNumber - Laufende Nummer des Datensatzes
_delayedDataFlag - Sind die Daten nachgeliefert
_errorFlag - Fehlerkennung der Anwendungsdaten. 0: Daten vorhanden (kein fehler). 1: Quelle vorhanden aber Daten noch nicht lieferbar. 2: Quelle nicht vorhanden. 3: Keine Rechte 8: Unzulässige Anmeldung(2 quellen, 2 Senken, 1 Quelle 1 senke und umgekehrt)
_attributesIndicator - gibt an ob sich ein Attribut geändert hat
_priority - Priorität des Telegramms (CommunicationConstant )
_data - Teil des Datensatzes als Bytestrom
_totalTelegramCount - Anzahl aller Teiltelegramme, in die der gesamte Datensatz zerlegt wurde
_telegramNumber - Index des Teiltelegramms
_time - Datatime (Zeitpunkt, an dem der Datensatz erzeugt wurde)

ApplicationDataTelegram

public ApplicationDataTelegram(BaseSubscriptionInfo _baseSubscriptionInfo,
                               long _dataNumber,
                               boolean _delayedDataFlag,
                               byte _errorFlag,
                               byte[] _attributesIndicator,
                               byte[] _data,
                               int _totalTelegramCount,
                               int _telegramNumber,
                               long _time)
Parameters:
_baseSubscriptionInfo - Basisanmeldeinformation
_dataNumber - Laufende Nummer des Datensatzes
_delayedDataFlag - Sind die Daten nachgeliefert
_errorFlag - Fehlerkennung der Anwendungsdaten. 0: Daten vorhanden (kein fehler). 1: Quelle vorhanden aber Daten noch nicht lieferbar. 2: Quelle nicht vorhanden. 3: Keine Rechte 8: Unzulässige Anmeldung(2 quellen, 2 Senken, 1 Quelle 1 senke und umgekehrt)
_attributesIndicator - gibt an ob sich ein Attribut geändert hat
_data - Teil des Datensatzes als Bytestrom
_totalTelegramCount - Anzahl aller Teiltelegramme, in die der gesamte Datensatz zerlegt wurde
_telegramNumber - Index des Teiltelegramms
_time - Datatime (Zeitpunkt, an dem der Datensatz erzeugt wurde)
Method Detail

getBaseSubscriptionInfo

public final BaseSubscriptionInfo getBaseSubscriptionInfo()
Gibt die Basisanmeldeinformationen zurück.

Returns:
Basisanmeldeinformationen

getDelayedDataFlag

public final boolean getDelayedDataFlag()
Gibt an, Datensätze nachgeliefert worden sind. True-> verspätet, false-> nicht verspätet

Returns:
True wenn Daten nachgeliefert sind.

getDataNumber

public final long getDataNumber()
Gibt die Laufende Nummer des Datensatzes zurrück.

Returns:
Fortlaufende Nummer

getDataTime

public final long getDataTime()
Der Zeitstempel der Datensätze.

Returns:
Zeitstempel

getErrorFlag

public final byte getErrorFlag()
Gibt die Fehlerinformation zurück. Fehlerkennung der Anwendungsdaten:
0: Daten vorhanden (kein fehler).
1: Quelle vorhanden aber Daten noch nicht lieferbar.
2: Quelle nicht vorhanden.
3: Keine Rechte
8: Unzulässige Anmeldung(2 quellen, 2 Senken, 1 Quelle 1 senke und umgekehrt)

Returns:
Fehlercode

getAttributesIndicator

public final byte[] getAttributesIndicator()
Gibt den Indikator zu den einzelnen Attributen der Attributegruppe zurück.

Returns:
Indikator

setAttributesIndicator

public final void setAttributesIndicator(byte[] newIndicators)
Setzt den Indikator auf den neuen Wert.

Parameters:
newIndicators - enthält Informationen, welche Attribute sich geändert haben.

getTotalTelegramsCount

public final int getTotalTelegramsCount()
Gibt die Gesamtzahl der Teiltelegramme des ursprunglichen Datensatzes zurück.

Returns:
Gesamte Länge des Telegramms in Teiltelegrammen

getTelegramNumber

public final int getTelegramNumber()
Gibt die Telegrammnummer dieses Teiltelegramms zurück.

Returns:
Telegrammnummer

getData

public final byte[] getData()
Gibt den Bytestrom dieses Telegramms zurück.

Returns:
Bytestrom

setDataIndex

public final void setDataIndex(long _dataNumber)
Setzt den Datensatz-Index .

Parameters:
_dataNumber - Fortlaufende Nummer

toShortDebugParamString

public String toShortDebugParamString()
Description copied from class: DataTelegram
Bestimmt eine kurze Beschreibung der Eigenschaften eines Telegramms.

Overrides:
toShortDebugParamString in class DataTelegram
Returns:
Beschreibung der Eigenschaften eines Telegramms

parseToString

public final String parseToString()
Description copied from class: DataTelegram
Gibt eine String-Repräsentation dieses Datensatzes zurück.

Specified by:
parseToString in class DataTelegram
Returns:
Eine String-Repräsentation dieses Datensatzes.

write

public final void write(DataOutputStream out)
                 throws IOException
Description copied from class: DataTelegram
Schreibt ein Telegramm in den übergegebenen DataOutputStream.

Specified by:
write in class DataTelegram
Parameters:
out - Der DataOutputStream.
Throws:
IOException - Falls der Datensatz nicht in den Stream geschrieben werden kann.

read

public final void read(DataInputStream in)
                throws IOException
Description copied from class: DataTelegram
Liest ein Telegramm vom übergegebenen DataInputStream.

Specified by:
read in class DataTelegram
Parameters:
in - Der DataInputStream.
Throws:
IOException - Falls der Datensatz nicht aus dem Stream gelesen werden kann.