de.bsvrz.pat.onlprot.standardProtocolModule
Class ProtocolModule

java.lang.Object
  extended by de.bsvrz.pat.onlprot.standardProtocolModule.ProtocolModule
All Implemented Interfaces:
ProtocolModuleInterface
Direct Known Subclasses:
StandardProtocoller

public abstract class ProtocolModule
extends Object
implements ProtocolModuleInterface

Abstrakte Klasse, die Funktionalität für Protokollierungsmodule zur Verfügung stellt.

Folgende Methoden werden zur Vergügung gestellt:

Author:
Kappich Systemberatung

Constructor Summary
protected ProtocolModule()
          Einziger Konstruktor.
 
Method Summary
abstract  void closeProtocol()
          Führt Aufräumarbeiten nach Beendigung des Protokollierens aus.
abstract  String getHelp()
          Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück
 PrintWriter getProtocolFileWriter()
          Zugriff auf den protocolFileWriter.
 ClientProtocollerInterface getProtocoller()
          Zugriff auf den protocoller.
 ClientReceiverInterface initProtocol(ArgumentList argumentList, PrintWriter protocolFile, String[] args)
          Führt die Initialisierungsschritte des Protokollierungsmoduls aus.
 void setProtocolFileWriter(PrintWriter pfw)
          Protokolldatei setzen.
 void setProtocoller(ClientProtocollerInterface cpi)
          Protokollierer setzen.
abstract  void update(ResultData[] results)
          Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes von den Datenverteiler-Applikationsfunktionen aufgerufen wird.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProtocolModule

protected ProtocolModule()
Einziger Konstruktor. (Für den üblicherweise impliziten Aufruf durch abgeleitete Klassen.)

Method Detail

closeProtocol

public abstract void closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Protokollierens aus.

Specified by:
closeProtocol in interface ProtocolModuleInterface

getHelp

public abstract String getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück

Specified by:
getHelp in interface ProtocolModuleInterface
Returns:
String mit der Beschreibung der erlaubten Aufrufparameter und deren erwartetes Format

getProtocolFileWriter

public PrintWriter getProtocolFileWriter()
Zugriff auf den protocolFileWriter.

Returns:
PrintWriter mit Namen der Protokolldatei

getProtocoller

public ClientProtocollerInterface getProtocoller()
Zugriff auf den protocoller.

Returns:
den registrierten Protokollierer.

initProtocol

public ClientReceiverInterface initProtocol(ArgumentList argumentList,
                                            PrintWriter protocolFile,
                                            String[] args)
Führt die Initialisierungsschritte des Protokollierungsmoduls aus.

Specified by:
initProtocol in interface ProtocolModuleInterface
Parameters:
argumentList - ArgumentList der noch nicht ausgewerteten Aufrufparameter der Applikation
protocolFile - PrintWriter der protokollierten Datensequenzen
args - String[] mit den Aufrufparametern der Applikation
Returns:
ClientReceiverInterface-Handle auf den benutzten Protokollierer

setProtocolFileWriter

public void setProtocolFileWriter(PrintWriter pfw)
Protokolldatei setzen.

Parameters:
pfw - PrintWriter mit Beschreibung der Protokolldatei

setProtocoller

public void setProtocoller(ClientProtocollerInterface cpi)
Protokollierer setzen.

Parameters:
cpi - Ausgewählter Protokollierer

update

public abstract void update(ResultData[] results)
Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes von den Datenverteiler-Applikationsfunktionen aufgerufen wird.

Parameters:
results - ResultData[] mit den empfangenen Ergebnisdatensätzen.
See Also:
ClientReceiverInterface.update(de.bsvrz.dav.daf.main.ResultData[])