Class ClientModul

  • All Implemented Interfaces:
    de.bsvrz.dav.daf.main.ClientReceiverInterface, de.bsvrz.dav.daf.main.config.MutableSetChangeListener

    public class ClientModul
    extends Modul
    implements de.bsvrz.dav.daf.main.config.MutableSetChangeListener, de.bsvrz.dav.daf.main.ClientReceiverInterface
    die Repräsentation eines UdaModuls in einem Client einer Uda-Applikation.
    • Method Summary

      Modifier and Type Method Description
      void addClientListener​(ModulListener listener)
      einen ModulListener hinzufügen, der bei Änderungen der Mengen der Skripte bzw.
      void addLaufListener​(SkriptLaufListener listener)
      fügt der Menge der Listener, die bei einer Änderung des Skriptlaufs benachrichtigt werden den übergebenen hinzu.
      void addSkriptListener​(SkriptListener listener)
      fügt der Menge der Listener, die bei einer Änderung des Skripts benachrichtigt werden den übergebenen hinzu.
      ClientSkript erzeugeSkript​(java.lang.String name, java.lang.String username)
      die Funktion erzeugt ein neues Skriptobjekt für das Uda-Modul innerhalb der Datenverteiler-Konfiguration.
      Es wird ein neues dynamisches Objekt des entsprechenden Typs angelegt.
      ClientSkriptLauf erzeugeSkriptLauf​(SkriptLaufDaten daten, java.lang.String benutzer, java.lang.String grund)
      die Funktion erzeugt ein neues Skriptlaufobjekt für das Uda-Modul innerhalb der Datenverteiler-Konfiguration.
      Es wird ein neues dynamisches Objekt des entsprechenden Typs angelegt.
      Skript getSkript​(java.lang.String pid)
      ermittelt das Skript innerhalb des Moduls, das durch das Systemobjekt mit der übergebenen PID repräsentiert wird.
      java.util.Collection<ClientSkriptLauf> getSkriptLaeufe()
      liefert die Repräsentation der Menge aller Skriptläufe des Moduls zurück.
      ClientSkript[] getSkripts()
      liefert die Repräsentation der Menge aller Skripte des Moduls zurück.
      Skript getSkriptWithName​(java.lang.String name)
      ermittelt das Skript mit dem angegebenen Namen oder null, wenn keines gefunden wurde.
      boolean isValid()
      ermittelt, ob das Modul gültig ist.
      Das UdaModul-Objekt wird als gültig betrachtet, wenn eine Anwendung vom Typ "Umfassende Datenanalyse" für dieses Objekt angemeldet ist.
      ClientSkript loadSkript​(java.lang.String name)
      liefert des Skript mit dem angegebenen Namen.
      Da Namen für Skripte nicht eindeutig sind, wird jeweils das zuerst gefundene geliefert.
      void removeClientListener​(ModulListener listener)
      einen ModulListener vom Modul abmelden.
      Der übergebene Listener muss nicht in der Menge enthalten sein.
      void removeLauf​(ClientSkriptLauf lauf)
      entfernt den angegebenen Skriptlauf.
      void removeLaufListener​(SkriptLaufListener listener)
      entfernt einen Listener für den Skriptlauf.
      void removeSkript​(ClientSkript skript)
      entfernt das Skript vom Modul.
      Das Skript wird aus der Menge der Skripte innerhalb der Datenverteilerkonfiguration entfernt und das Objekt wird als ungültig erklärt.
      void removeSkriptListener​(SkriptListener listener)
      entfernt einen Listener für das Skript.
      void update​(de.bsvrz.dav.daf.main.config.MutableSet set, de.bsvrz.dav.daf.main.config.SystemObject[] added, de.bsvrz.dav.daf.main.config.SystemObject[] removed)
      .
      Die Funktion erwartet neue oder gelöschte Einträge innerhalb der Liste der Skripte bzw. der Skriptläufe und legt entsprechende interne Objekte zur Repräsentation an bzw. entfernt diese.
      void update​(de.bsvrz.dav.daf.main.ResultData[] results)
      .
      Die Funktion aktualisiert den von der "Umfassenden Datenanalyse" bereitgestellten öffentlichen Schlüssel.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • addLaufListener

        public void addLaufListener​(SkriptLaufListener listener)
        fügt der Menge der Listener, die bei einer Änderung des Skriptlaufs benachrichtigt werden den übergebenen hinzu.
        Parameters:
        listener - der neue Listener
        See Also:
        removeLaufListener(SkriptLaufListener)
      • addSkriptListener

        public void addSkriptListener​(SkriptListener listener)
        fügt der Menge der Listener, die bei einer Änderung des Skripts benachrichtigt werden den übergebenen hinzu.
        Parameters:
        listener - der neue Listener
        See Also:
        removeSkriptListener(SkriptListener)
      • erzeugeSkript

        public ClientSkript erzeugeSkript​(java.lang.String name,
                                          java.lang.String username)
                                   throws ClientException
        die Funktion erzeugt ein neues Skriptobjekt für das Uda-Modul innerhalb der Datenverteiler-Konfiguration.
        Es wird ein neues dynamisches Objekt des entsprechenden Typs angelegt. Das Objekt wird in die Menge des UdaModuls eingetragen. Nach der Rückmeldung der Mengenänderung und der Erzeugung eines internen Skriptobjektes, wird diese mit den Daten des Nutzers, dem Skriptnamen und einem initialen Quelltext versorgt.
        Parameters:
        name - der Name des Skripts
        username - der Name des Nutzers der das Skript anlegt
        Returns:
        das Skript das Objekt, das das angelegte Skript innerhalb des Clients repräsentiert.
        Throws:
        ClientException - das Skript konnte nicht angelegt werden
      • erzeugeSkriptLauf

        public ClientSkriptLauf erzeugeSkriptLauf​(SkriptLaufDaten daten,
                                                  java.lang.String benutzer,
                                                  java.lang.String grund)
                                           throws ClientException
        die Funktion erzeugt ein neues Skriptlaufobjekt für das Uda-Modul innerhalb der Datenverteiler-Konfiguration.
        Es wird ein neues dynamisches Objekt des entsprechenden Typs angelegt. Das Objekt wird in die Menge des UdaModuls eingetragen. Nach der Rückmeldung der Mengenänderung und der Erzeugung eines internen Skriptobjektes, wird diese mit den entsprechenden Daten versorgt.
        Parameters:
        daten - die Daten des anzulegenden Skriptlaufs
        benutzer - der Name des Benutzers, der eine Änderung vornimmt
        grund - der Grund für die Änderung
        Returns:
        das Skript das Objekt, das das angelegte Skript innerhalb des Clients repräsentiert.
        Throws:
        ClientException - der Skriptlauf konnte nicht angelegt werden
      • getSkript

        public Skript getSkript​(java.lang.String pid)
        ermittelt das Skript innerhalb des Moduls, das durch das Systemobjekt mit der übergebenen PID repräsentiert wird.
        Specified by:
        getSkript in class Modul
        Parameters:
        pid - die PID des Systemobjekts
        Returns:
        das ermittelte Skript oder null, wenn kein solches existiert
      • getSkriptLaeufe

        public java.util.Collection<ClientSkriptLauf> getSkriptLaeufe()
        liefert die Repräsentation der Menge aller Skriptläufe des Moduls zurück.
        Returns:
        die Liste der Skriptläufe
      • getSkripts

        public ClientSkript[] getSkripts()
        liefert die Repräsentation der Menge aller Skripte des Moduls zurück.
        Returns:
        die Liste der Skripte
      • getSkriptWithName

        public Skript getSkriptWithName​(java.lang.String name)
        ermittelt das Skript mit dem angegebenen Namen oder null, wenn keines gefunden wurde.
        Parameters:
        name - der Name des gesuchten Skripts
        Returns:
        das Skript oder null
      • isValid

        public boolean isValid()
        ermittelt, ob das Modul gültig ist.
        Das UdaModul-Objekt wird als gültig betrachtet, wenn eine Anwendung vom Typ "Umfassende Datenanalyse" für dieses Objekt angemeldet ist.
        Returns:
        true, wenn das Modul gültig ist
      • loadSkript

        public ClientSkript loadSkript​(java.lang.String name)
        liefert des Skript mit dem angegebenen Namen.
        Da Namen für Skripte nicht eindeutig sind, wird jeweils das zuerst gefundene geliefert. Welches Skript bei mehreren mit gleichem Namen zuerst gefunden wird ist nicht deinfiert. Existiert kein Skript mit dem gesuchten Namen, wird der Wert null zurückgeliefert.
        Parameters:
        name - der Name der Name des gesuchten Skripts
        Returns:
        das Skript oder null, wenn keines existiert
      • removeClientListener

        public void removeClientListener​(ModulListener listener)
        einen ModulListener vom Modul abmelden.
        Der übergebene Listener muss nicht in der Menge enthalten sein. Dieser Fall wird ignoriert.
        Parameters:
        listener - der abzumeldende Listener
        See Also:
        addClientListener(ModulListener)
      • removeLauf

        public void removeLauf​(ClientSkriptLauf lauf)
                        throws de.bsvrz.dav.daf.main.config.ConfigurationChangeException
        entfernt den angegebenen Skriptlauf.
        Parameters:
        lauf - der Skriptlauf
        Throws:
        de.bsvrz.dav.daf.main.config.ConfigurationChangeException - der Lauf konnte nicht entfernt werden
      • removeSkript

        public void removeSkript​(ClientSkript skript)
                          throws de.bsvrz.dav.daf.main.config.ConfigurationChangeException
        entfernt das Skript vom Modul.
        Das Skript wird aus der Menge der Skripte innerhalb der Datenverteilerkonfiguration entfernt und das Objekt wird als ungültig erklärt. Die Entfernung des Skripts aus der internen Liste des Moduls innerhalb des Clients erfolgt über die Rückmeldung der Mengenänderung.
        Parameters:
        skript - das zu entfernende Skript
        Throws:
        de.bsvrz.dav.daf.main.config.ConfigurationChangeException - beim Entfernen des Sktipts ist ein Fehler aufgetreten
      • update

        public void update​(de.bsvrz.dav.daf.main.config.MutableSet set,
                           de.bsvrz.dav.daf.main.config.SystemObject[] added,
                           de.bsvrz.dav.daf.main.config.SystemObject[] removed)
        .
        Die Funktion erwartet neue oder gelöschte Einträge innerhalb der Liste der Skripte bzw. der Skriptläufe und legt entsprechende interne Objekte zur Repräsentation an bzw. entfernt diese. Die Übertragung der Daten erfolgt über die entsprechenden Attributgruppen der Objekte selbst.
        Specified by:
        update in interface de.bsvrz.dav.daf.main.config.MutableSetChangeListener
        See Also:
        MutableSetChangeListener.update(de.bsvrz.dav.daf.main.config.MutableSet, de.bsvrz.dav.daf.main.config.SystemObject[], de.bsvrz.dav.daf.main.config.SystemObject[])
      • update

        public void update​(de.bsvrz.dav.daf.main.ResultData[] results)
        .
        Die Funktion aktualisiert den von der "Umfassenden Datenanalyse" bereitgestellten öffentlichen Schlüssel.
        Specified by:
        update in interface de.bsvrz.dav.daf.main.ClientReceiverInterface
        See Also:
        ClientReceiverInterface.update(de.bsvrz.dav.daf.main.ResultData[])