Die DLE Java API dient als direkte Java-Schnittstelle zur DLE. Die API ist eine Fassade zur DLE Session, die die zentrale Klasse der DLE ist.
Wird die DLE innerhalb der gleichen virtuellen Java-Maschine ausgeführt, kann die API dazu verwendet werden, einfach die DLE zu konfigurieren, Logik auszuführen und die Ergebnisse zu verarbeiten.
Dabei gliedert sich die Benutzung der API in fünf Hauptaufgaben:
- Initialisieren der API
- Übergabe von Daten an die DLE
- Setzen der Ausführungsparameter
- Aufruf der DLE
- Verarbeitung der Ergebnisse
Dabei sollte die API wenn möglich nur einmal initialisiert werden und diese Instanz dann immer wieder benutzt werden, da die DLE dann die Zugriffe auf häufig verwendete Ressourcen wie Metadaten, Datenbanken, Übersetzungen, etc. optimieren kann.
Für eine korrekte Verarbeitung der Werte und Ergebnisse sind nur die hier dokumentierten Methoden und Strukturen zu verwenden. Methoden und Strukturen, die hier nicht beschrieben sind, dienen allein der internen Verarbeitung der DLE und können bei falscher Benutzung zu fehlerhaften Ergebnissen führen.