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 protectedProtocolModule()Einziger Konstruktor. -
Method Summary
Modifier and Type Method Description abstract voidcloseProtocol()Führt Aufräumarbeiten nach Beendigung des Protokollierens aus.abstract java.lang.StringgetHelp()Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurückjava.io.PrintWritergetProtocolFileWriter()Zugriff auf denprotocolFileWriter.ClientProtocollerInterfacegetProtocoller()Zugriff auf denprotocoller.de.bsvrz.dav.daf.main.ClientReceiverInterfaceinitProtocol(de.bsvrz.sys.funclib.commandLineArgs.ArgumentList argumentList, java.io.PrintWriter protocolFile, java.lang.String[] args)Führt die Initialisierungsschritte des Protokollierungsmoduls aus.voidsetProtocolFileWriter(java.io.PrintWriter pfw)Protokolldatei setzen.voidsetProtocoller(ClientProtocollerInterface cpi)Protokollierer setzen.abstract voidupdate(de.bsvrz.dav.daf.main.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 Details
-
ProtocolModule
protected ProtocolModule()Einziger Konstruktor. (Für den üblicherweise impliziten Aufruf durch abgeleitete Klassen.)
-
-
Method Details
-
closeProtocol
public abstract void closeProtocol()Führt Aufräumarbeiten nach Beendigung des Protokollierens aus.- Specified by:
closeProtocolin interfaceProtocolModuleInterface
-
getHelp
public abstract java.lang.String getHelp()Gibt Information über die Aufrufparameter des Protokollierungsmoduls zurück- Specified by:
getHelpin interfaceProtocolModuleInterface- Returns:
- String mit der Beschreibung der erlaubten Aufrufparameter und deren erwartetes Format
-
getProtocolFileWriter
public java.io.PrintWriter getProtocolFileWriter()Zugriff auf denprotocolFileWriter.- Returns:
PrintWritermit Namen der Protokolldatei
-
setProtocolFileWriter
public void setProtocolFileWriter(java.io.PrintWriter pfw)Protokolldatei setzen.- Parameters:
pfw-PrintWritermit Beschreibung der Protokolldatei
-
getProtocoller
Zugriff auf denprotocoller.- Returns:
- den registrierten Protokollierer.
-
setProtocoller
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:
initProtocolin interfaceProtocolModuleInterface- Parameters:
argumentList-ArgumentListder 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[])
-