Class ProtocolModule
- java.lang.Object
-
- de.bsvrz.pat.onlprot.standardProtocolModule.ProtocolModule
-
- All Implemented Interfaces:
ProtocolModuleInterface
- Direct Known Subclasses:
StandardProtocoller
public abstract class ProtocolModule extends java.lang.Object implements ProtocolModuleInterface
Abstrakte Klasse, die Funktionalität für Protokollierungsmodule zur Verfügung stellt.Folgende Methoden werden zur Vergügung gestellt:
-
initProtocol
- Initialisierung -
update
- Ausgabe der empfangenen Daten -
closeProtocol
- Abschluß der Protokollierung
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ProtocolModule()
Einziger Konstruktor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Protokollierens aus.abstract java.lang.String
getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurückjava.io.PrintWriter
getProtocolFileWriter()
Zugriff auf denprotocolFileWriter
.ClientProtocollerInterface
getProtocoller()
Zugriff auf denprotocoller
.de.bsvrz.dav.daf.main.ClientReceiverInterface
initProtocol(de.bsvrz.sys.funclib.commandLineArgs.ArgumentList argumentList, java.io.PrintWriter protocolFile, java.lang.String[] args)
Führt die Initialisierungsschritte des Protokollierungsmoduls aus.void
setProtocolFileWriter(java.io.PrintWriter pfw)
Protokolldatei setzen.void
setProtocoller(ClientProtocollerInterface cpi)
Protokollierer setzen.abstract void
update(de.bsvrz.dav.daf.main.ResultData[] results)
Aktualisierungsmethode, die nach Empfang eines angemeldeten Datensatzes von den Datenverteiler-Applikationsfunktionen aufgerufen wird.
-
-
-
Method Detail
-
closeProtocol
public abstract void closeProtocol()
Führt Aufräumarbeiten nach Beendigung des Protokollierens aus.- Specified by:
closeProtocol
in interfaceProtocolModuleInterface
-
getHelp
public abstract java.lang.String getHelp()
Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück- Specified by:
getHelp
in interfaceProtocolModuleInterface
- Returns:
- String mit der Beschreibung der erlaubten Aufrufparameter und deren erwartetes Format
-
getProtocolFileWriter
public java.io.PrintWriter getProtocolFileWriter()
Zugriff auf denprotocolFileWriter
.- Returns:
PrintWriter
mit Namen der Protokolldatei
-
setProtocolFileWriter
public void setProtocolFileWriter(java.io.PrintWriter pfw)
Protokolldatei setzen.- Parameters:
pfw
-PrintWriter
mit Beschreibung der Protokolldatei
-
getProtocoller
public ClientProtocollerInterface getProtocoller()
Zugriff auf denprotocoller
.- Returns:
- den registrierten Protokollierer.
-
setProtocoller
public void setProtocoller(ClientProtocollerInterface cpi)
Protokollierer setzen.- Parameters:
cpi
- Ausgewählter Protokollierer
-
initProtocol
public de.bsvrz.dav.daf.main.ClientReceiverInterface initProtocol(de.bsvrz.sys.funclib.commandLineArgs.ArgumentList argumentList, java.io.PrintWriter protocolFile, java.lang.String[] args)
Führt die Initialisierungsschritte des Protokollierungsmoduls aus.- Specified by:
initProtocol
in interfaceProtocolModuleInterface
- Parameters:
argumentList
-ArgumentList
der noch nicht ausgewerteten Aufrufparameter der ApplikationprotocolFile
- PrintWriter der protokollierten Datensequenzenargs
- String[] mit den Aufrufparametern der Applikation- Returns:
- ClientReceiverInterface-Handle auf den benutzten Protokollierer
-
update
public abstract void update(de.bsvrz.dav.daf.main.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[])
-
-