Allgemein
Für die Regelprogrammierung müssen Informationen zu den Entitäten, den Statusmodellen und anderen Nuclos-Einheiten zur Verfügung stehen. Damit der Zugriff und die Verwendung möglichst einfach und fehlerfrei bleibt, werden diese Daten objektiviert als Java-Klassen bereit gestellt. Diese Java-Klassen können dann aus den Regeln heraus aufgerufen und benutzt werden.
Folgende Typen von unterstützenden Klassen gibt es:
Typ | Beschreibung | Suffix |
---|---|---|
BusinessObjekt | Ein BusinessObjekt repräsentiert eine NuclosEntität wie z.B. Auftrag oder Kunde. Die dazugehörenden Felder werden aus den Meta-Informationen gelesen und als Attribute in die Klasse geschrieben. Ja nach Art des Attributs und der Zugriffsrechte werden setter und getter-Methoden zum Setzen und Auslesen von Werten zur Verfügung gestellt. Wird mittels Entitäten-Wizzard eine neue Entität angelegt oder eine bestehende verändert oder gelöscht, werden mit dem erfolgreichen Abschluss des Speichervorgangs alle Änderungen in dem dazugehörenden BusinessObjekt vorgenommen und im Classloader abgelegt. Damit stehen die Änderungen sofort zur Verfügung. Allgemeine Konventionen:
Beispiel eines BusinessObjekts "Adresse": public class Adresse extends AbstractBusinessObject implements Modifiable { // Konstanten für den QueryProvider public static final Attribute<Boolean> Standard = new Attribute<Boolean>("Standard", "org.nuclet.basis", "Adresse", new Long(40005905), "standard", new Long(40006275), Boolean.class ); public static final StringAttribute<String> Postfach = new StringAttribute<String>("Postfach", "org.nuclet.basis", "Adresse", new Long(40005905), "postfach", new Long(40006271), String.class ); public java.lang.Boolean getStandard() { return getField("standard", java.lang.Boolean.class); } public void setStandard(java.lang.Boolean pStandard) { setField("standard", pStandard); } public java.lang.String getPostfach() { return getField("postfach", java.lang.String.class); } public void setPostfach(java.lang.String pPostfach) { setField("postfach", pPostfach); } } | -- |
Statusmodell-Klasse | Eine Statusmodell-Klasse ist eine Java-Klasse, die fachlich einem in Nuclos erstellen Statusmodell entspricht. Statusmodell-Klassen werden in der Regelprogrammierung verwendet, um eine einfache und sichere Gestaltung von beispielsweise Statuswechseln zu gewährleisten. Allgemeine Konventionen:
Beispiel der Statusmodell-Klasse "AuftragSM": public class AuftragSM{ public static State State_10 = new StateImpl(IdUtils.toLongId(40006496), "Entwurf", "Geplant", 10, IdUtils.toLongId(40006477)); public static State State_90 = new StateImpl(IdUtils.toLongId(40006497), "Abgeschlossen", "Abgeschlossen", 90, IdUtils.toLongId(40006477)); public static State State_50 = new StateImpl(IdUtils.toLongId(40006498), "Offen", "Offen", 50, IdUtils.toLongId(40006477)); public static State State_99 = new StateImpl(IdUtils.toLongId(40006499), "Storniert", "Storniert", 99, IdUtils.toLongId(40006477)); } Die hinterlegten Status können für manuelle Statuswechsel im StatemodelProvider verwendet werden. | SM |
Arbeitsschritt-Klasse | In Nuclos können Arbeitsschritte erstellt werden. Um auch innerhalb von Regeln Arbeitsschritte manuell ausführen zu können, werden nach dem erfolgreichen Speichern eines Arbeitsschrittes sogenannte Arbeitsschritt-Klassen oder auch Generation-Klassen erstellt. Diese können über den GenerationProvider gestartet werden. Eine Arbeitsschritt-Klasse ist mittels Generics typsicher aufgebaut und legt Quell- und Zielentitäten als BusinessObjekte fest. Allgemeine Konventionen:
Beispiel der Arbeitsschritt-Klasse "ErstelleRechnungAusAuftragGEN": public class ErstelleRechnungAusAuftragGEN implements Generation<Auftrag, Rechnung> { public Class<Auftrag> getSourceModule() { return Auftrag.class; } public Class<Rechnung> getTargetModule() { return Rechnung.class; } } | GEN |
Report-Klasse | Report-Klassen stellen objektivierte Datenquellen aus "Report und Formular" dar. Werden in Nuclos Quellen für Report und Formular angelegt, wird eine entsprechende Report-Klasse erstellt. Diese kann in der Regelprogrammierung als Quelle verwendet und über den DatasourceService aufgerufen werden. Allgemeine Konventionen:
Beispiel der Report-Klasse "ExportRechnungsdatenDS": public class ExportRechnungsdatenDS implements Datasource { public static final Long id = new Long(40016085); public static final String name = "Export: Rechnungsdaten"; public static final String description = "Export: Rechnungsdaten - für alle Kunden"; public Long getId() { return new Long(40016085);} } | DS |
Klassengenerierung und Regelkompilierung
Allgemein
Für die oben beschriebenen Klassen gelten bestimmte Regeln und Reihenfolgen, in der sie erstellt und bereitgestellt werden. Die Klassen werden je nach Typ kompiliert und gruppiert in einer eigenen Jar im CodeGenerator-Verzeichnis abgelegt. Von dort aus werden die Archive in den Classloader aufgenommen und können verwendet werden.
Typ | Klasse | Reihenfolge der Generierung |
---|---|---|
BusinessObjekte | BOEntities.jar | Die BusinessObjekte können als erstes erstellt werden, da sie lediglich auf die Meta-Informationen der Entitäten zurückgreifen müssen. |
Report-Klassen | ReportDSEntities.jar | Die Report-Klassen können unabhängig von anderen Klassen erstellt werden, da sie lediglich auf die Meta-Informationen der Statusmodelle zugreifen. |
Arbeitsschritt-Klasse | Generation.jar | Die Arbeitsschritte verwenden als Quell- und Zielentitäten BusinessObjekte. Die Arbeitsschritt-Klassen können somit erst erstellt und kompiliert werden, wenn die BusinessObjekte in der BOEntities.jar fehlerfrei gebaut wurden und zur Verfügung stehen. |
Statusmodell-Klasse | statemodels.jar | Die Statusmodell-Klassen können unabhängig von anderen Klassen erstellt werden, da sie lediglich auf die Meta-Informationen der Statusmodelle zugreifen. |
Regeln und Bibliotheken | Nuclet.jar | Die Regeln werden immer als letztes gebaut, das sie auf alle BusinessObjekte, Report-, Statusmodel- und Arbeitsschritt-Klassen zugreifen können. Die Generierung der genannten Klassen ist somit eine notwendige Vorbedingung zur Erstellung der Nuclet.jar. Sollte es im Vorfeld Fehler geben, wird die Nuclet.jar nicht gebaut. |
Zeitpunkt der Generierung
Systemstart
Bei Systemstart werden alle der genannten Klassen neu gebaut und im Classloader bereitgestellt. Dazu werden alle vorhanden Klassen und Archive aus dem Codegenerator-Verzeichnis gelöscht. Sollte es an dieser Stelle zu einem Fehler kommen, bleiben die Verzeichnisse (teilweise) leer. Der Server startet weiterhin.
Import eines Nuclets
Mit dem Import eines Nuclets ändert sich in Nuclos alles. Es werden neue Strukturen eingespielt, neue Entitäten, Statusmodelle, etc. Logischerweise müssen alle bereits erstellen Klassen gelöscht und der neuen Umgebung entsprechend generiert werden. Auch hier kann es bei ungültigen Daten zu Fehlern und somit zu Fehlermeldung bei der Kompilierung von Klassen kommen.
Laufzeit
Auch zur Laufzeit können sich Strukturen von Entitäten, Statusmodell, etc. ändern, was eine Anpassung und Neuerstellung der Java-Klassen notwendig macht. Wird eine Entität verändert, muss das entsprechende BusinessObjekt neu erstellt werden. Das Nuclet.jar und das Generation.jar mit den Arbeitsschritten im Anschluss ebenfalls, da sie mit dem betroffenen BusinessObjekt evtl. arbeiten. Für die Sicherstellung der Datenstrukturen ist das notwendig.
Report-Klassen, Arbeitsschritt-Klassen und Statusmodell-Klassen fordern ebenfalls eine Neugenerierung des Nuclet-jars, sollte im entsprechenden Editor das Modell verändert worden sein (löschen, anlegen oder aktualisieren).
Beispiel: In Nuclos wird ein Statusmodell im Editor geladen und dadurch verändert, dass ein Status hinzugefügt wird: Status 40 "Auftrag in Bearbeitung". Mit dem Speichern des Modells wird nun eine neue Statusmodell-Klasse "AuftragSM" erstellt, die diesen Status beinhaltet. Daraufhin erstellen wir eine Regel, die über den StatusmodelProvider eine gegebene Instanz eines Auftrags auf den neuen Status 40 anheben soll. Also einen Statuswechsel vornimmt. Nun muss aus nicht näher bekannten Gründen der neue Status ein anderes Numeral erhalten hat. Der Wert wird von 40 auf 50 gesetzt. Mit dem Speichern wird wie zuvor eine neue Statusmodell-Klasse erzeugt, die mit dem Status 50 aktuell ist. Dennoch erscheint jetzt eine Fehlermeldung, die besagt, dass eine Regel nicht kompiliert werden kann! Was ist passiert? Die Statusmodell-Klasse wurde zwar erfolgreich verändert und neu kompiliert. Unsere Regel möchte aber immer noch einen Auftrag auf den Status 40 anheben und findet diesen Status nun nicht mehr. Damit ist die Regel nicht mehr kompilierbar und die Nuclet.jar nicht baubar. Als Folge müssen alle Referenzen auf den Status 40 aktualisiert werden. In unseren Fall eine Regel.
Strukturell müssen alle Informationen korrekt sein und dürfen gegen keine Java-Konvention verstoßen, da sonst die Klassen nicht erstellt werden können. Weitere Informationen finden Sie unter Probleme und Lösungen.