Skriptobjekte (Codeanalyse-API)

Überblick

Unter Rückgriff auf die Skriptobjekt-Erweiterungen können die zurückgegebenen Skriptobjekte z. B. für die Auslösung einer Codeanalse oder den Zugriff auf die Konventions- oder Metrikergebnisse verwendet werden.

API für die Codeanalyse

Dieses Objekt stellt einen allgemeinen Zugriff auf die Codeanalyse für ein Applikation-Objekt bereit.

Eigenschaft	Rückgabe-Objekt/Wert	Beschreibung
metrics	MetricsTable mit zugehörigen Funktionen/Eigenschaften	Die Eigenschaft metrics bietet Zugriff auf die API für die metrikspezifische Skripterstellung.
conventions	ConventionsTable mit zugehörigen Funktionen/Eigenschaften	Die Eigenschaft conventions bietet Zugriff auf die API für die konventionsspezifische Skripterstellung.
configuration	Configuration mit zugehörigen Funktionen/Eigenschaften	Die Eigenschaft configuration bietet Zugriff auf die API für die konfigurationsspezifische Skripterstellung.
cloud_connection	CloudConnection mit zugehörigen Funktionen/Eigenschaften	Die Eigenschaft cloud_connection bietet Zugriff auf den Upload von Schnappschüssen in Triple Storages und die Konfiguration der Cloudanbindung.

Funktionen	Rückgabe-Objekt/Wert	Beschreibung
clear()	Kein	Entfernt das Abhängigkeitsmodell aus dem Speicher. Daraufhin kann eine andere Codeanalyse-Ausführung gestartet werden.
perform_full_analysis()	Keiner	Startet eine komplette Codeanalyse-Ausführung. Das Abhängigkeitsmodell wird erstellt und z. B. von der API für Metriken wiederverwendet.
store_dependency_model(filename)	Keiner	Speichert das Abhängigkeitsmodell in einer XML-Datei.
store_ttl(filename)	Keiner	Speichert das RDF-Modell im TTL-Format auf der Festplatte. TTL (Turtle Language) ist ein Standardformat der Organisation https://www.w3.org für die Speicherung von RDF-Modellen.

API für Metriken

Funktionen	Rückgabe-Objekt/Wert	Beschreibung
get_all_metrics()	string[] mit verfügbaren Metriknamen	Ruft die verfügbaren Metrik-Abfragenamen ab.
full_metrics_table()	MetricsTableResult mit zugehörigen Funktionen/Eigenschaften	Erstellt eine komplette Metriktabelle mit den verfügbaren Metrikabfragen. Siehe API für die Metriktabellenergebnisse.
metrics_table()	MetricsTableResult mit zugehörigen Funktionen/Eigenschaften	Erstellt die Metriktabelle mit den angegebenen Metrikabfragen. Siehe API für die Metriktabellenergebnisse.

API für die Metriktabellenergebnisse

Eigenschaften	Rückgabe-Objekt/Wert	Beschreibung
successful	BOOL	Ruft die erfolgreichen Ergebnisse ab.
message	STRING	Ruft die lesbare Meldung zu den erfolgreichen Ergebnissen ab.
project_path	STRING	Ruft den Projektpfad ab, auf dem diese Ergebnisse basieren.
analysis_started_at	STRING	Ruft die Startzeit der Erstellung der Ergebnistabelle ab.
analysis_finished_at	STRING	Ruft die Endzeit der Erstellung der Ergebnistabelle ab.
analyser_version	STRING	Ruft die Version des zur Erstellung der Ergebnistabelle verwendeten Code Analyzers ab.
columns	STRING	Ruft die Liste der Spalten in der Ergebnistabelle ab.
rows	STRING	Ruft die Tabelle (Zeilen mit Spalten: [Array] von [Array]) mit den Ergebniswerten ab.

Funktionen	Rückgabe-Objekt/Wert	Beschreibung
store_as_xml(…)	Kein	Speichert die Metriktabellenergebnisse als XML-Datei auf der Festplatte.
store_as_csv(…)	Keiner	Speichert die Metriktabellenergebnisse als CSV-Datei auf der Festplatte.
store_as_html(…)	Keiner	Speichert die Metriktabellenergebnisse als HTML-Datei auf der Festplatte. Ermöglicht nach Bedarf die Angabe einer XSLT-Datei für die XML-zu-HTML-Konvertierung.

Funktionen

Rückgabe-Objekt/Wert

Beschreibung

store_as_xml(…)

Kein

Speichert die Metriktabellenergebnisse als XML-Datei auf der Festplatte.

store_as_csv(…)

Keiner

Speichert die Metriktabellenergebnisse als CSV-Datei auf der Festplatte.

store_as_html(…)

Keiner

Speichert die Metriktabellenergebnisse als HTML-Datei auf der Festplatte.

Ermöglicht nach Bedarf die Angabe einer XSLT-Datei für die XML-zu-HTML-Konvertierung.

API für Konventionen

Funktionen	Rückgabe-Objekt/Wert	Beschreibung
get_all_conventions()	STRING[] mit verfügbaren Konventionsnamen	Ruft die verfügbaren Konventionsabfragenamen ab.
full_conventions_table()	ConventionTableResult mit zugehörigen Funktionen/Eigenschaften	Erstellt die komplette Konventionstabelle mit den verfügbaren Konventionsabfragen. Siehe API für die Konventionstabellenergebnisse.
conventions_table()	ConventionTableResult mit zugehörigen Funktionen/Eigenschaften	Erstellt die Konventionstabelle mit den angegebenen Konventionsabfragen. Siehe API für die Konventionstabellenergebnisse.

Funktionen

Rückgabe-Objekt/Wert

Beschreibung

get_all_conventions()

STRING[] mit verfügbaren Konventionsnamen

Ruft die verfügbaren Konventionsabfragenamen ab.

full_conventions_table()

ConventionTableResult mit zugehörigen Funktionen/Eigenschaften

Erstellt die komplette Konventionstabelle mit den verfügbaren Konventionsabfragen.

Siehe API für die Konventionstabellenergebnisse.

conventions_table()

ConventionTableResult mit zugehörigen Funktionen/Eigenschaften

Erstellt die Konventionstabelle mit den angegebenen Konventionsabfragen.

Siehe API für die Konventionstabellenergebnisse.

API für die Konventionstabellenergebnisse

Eigenschaften	Rückgabe-Objekt/Wert	Beschreibung
successful	BOOL	Ruft die erfolgreichen Ergebnisse ab.
message	STRING	Ruft die lesbare Meldung zu den erfolgreichen Ergebnissen ab.
project_path	STRING	Ruft den Projektpfad ab, auf dem diese Ergebnisse basieren.
analysis_started_at	STRING	Ruft die Startzeit der Erstellung der Ergebnistabelle ab.
analysis_finished_at	STRING	Ruft die Endzeit der Erstellung der Ergebnistabelle ab.
analyser_version	STRING	Ruft die Version des zur Erstellung der Ergebnistabelle verwendeten Code Analyzers ab.
columns	STRING	Ruft die Liste der Spalten in der Ergebnistabelle ab.
rows	STRING	Ruft die Tabelle (Zeilen mit Spalten: [Array] von [Array]) mit den Ergebniswerten ab.

Funktionen	Rückgabe-Objekt/Wert	Beschreibung
store_as_xml(…)	Kein	Speichert die Konventionstabellenergebnisse als XML-Datei auf der Festplatte.
store_as_csv(…)	Keiner	Speichert die Konventionstabellenergebnisse als CSV-Datei auf der Festplatte.
store_as_html(…)	Keiner	Speichert die Konventionstabellenergebnisse als HTML-Datei auf der Festplatte. Ermöglicht nach Bedarf die Angabe einer XSLT-Datei für die XML-zu-HTML-Konvertierung.

Funktionen

Rückgabe-Objekt/Wert

Beschreibung

store_as_xml(…)

Kein

Speichert die Konventionstabellenergebnisse als XML-Datei auf der Festplatte.

store_as_csv(…)

Keiner

Speichert die Konventionstabellenergebnisse als CSV-Datei auf der Festplatte.

store_as_html(…)

Keiner

Speichert die Konventionstabellenergebnisse als HTML-Datei auf der Festplatte.

Ermöglicht nach Bedarf die Angabe einer XSLT-Datei für die XML-zu-HTML-Konvertierung.

API für die Konfiguration

Eigenschaft	Rückgabe-Objekt/Wert	Beschreibung
triple_storage_backend_type	Enumeration TripleStorageBackendTypes	Konfiguriert den RDF Triple Storage Backend-Typ, der zur Verwaltung der Codeanalysedaten verwendet werden soll.
thresshold_for_out_proc_backend_usage	INT	Konfiguriert den Schwellenwert für die automatische Auswahl des verwendeten Storage Backend-Typs (In-Memory oder Out-Proc).
max_upload_triple_count_per_request	INT	Konfiguriert die Anzahl der Triples pro Upload-Request.
query_execution_timeout	Long	Konfiguriert das Timeout für die Abfrageausführung.
update_execution_timeout	Long	Konfiguriert das Aktualisierungs-Timeout für eine Abfrage.
server_uri	STRING	Konfiguriert die Server-URI für HTTP-basierte Storage Backends.
relative_query_endpoint	STRING	Konfiguriert den Abfrageendpunkt für HTTP-basierte Storage Backends (Teil des kompletten Abfrageendpunkt-URL).
relative_update_endpoint	STRING	Konfiguriert den Aktualisierungsendpunkt für HTTP-basierte Storage Backends (Teil des kompletten Aktualisierungsendpunkt-URL).
dataset	STRING	Konfiguriert den Dataset-Namen für HTTP-basierte Storage Backends (Teil des Endpunkt-URL).
relative_data_endpoint	STRING	Konfiguriert den Datenendpunktnamen für HTTP-basierte Storage Backends (Teil des Endpunkt-URL).
relative_sparql_endpoint	STRING	Konfiguriert den SPARQL-Endpunktnamen für HTTP-basierte Storage Backends (Teil des Endpunkt-URL).
graph_name	STRING	Konfiguriert den Graphnamen für HTTP-basierte Storage Backends (Teil des Endpunkt-URL).
sparql_endpoint	STRING	Schreibgeschützt. Fordert den Zugriff auf den kompletten SPARQL-Endpunkt-URL an.
data_endpoint	STRING	Schreibgeschützt. Fordert den Zugriff auf den kompletten Datenendpunkt-URL an.
query_endpoint	STRING	Schreibgeschützt. Fordert den Zugriff auf den kompletten Abfrageendpunkt-URL an.
update_endpoint	STRING	Schreibgeschützt. Fordert den Zugriff auf den kompletten Aktualisierungsendpunkt-URL an.

Funktionen	Rückgabe-Objekt/Wert	Beschreibung
reset()	Kein	Setzt die Konfiguration der Codeanalyse zurück.

API für die Cloudanbindung

Eigenschaft	Rückgabe-Objekt/Wert	Beschreibung
configuration	CloudConfiguration mit zugehörigen Funktionen/Eigenschaften	Die Eigenschaft der Cloudkonfiguration bietet Zugriff auf die API für die cloudkonfigurationsspezifische Skripterstellung.

Funktionen	Rückgabe-Objekt/Wert	Beschreibung
upload_to_triple_storage(…)	Kein	Startet eine Schnappschuss-Upload des RDF-Modells in den konfigurierten RDF Triple Storage.

API für die Cloudkonfiguration

Eigenschaft	Rückgabe-Objekt/Wert	Beschreibung
http_backend_type	Enumeration HttpBackendTypes	Konfiguriert den HTTP-Backend-Typ (z. B. generisch, Apache Fuseki, Stardog usw.). Dieser Konfigurationswert wird nur berücksichtigt, wenn der Triple Storage Backend-Typ „Http“ verwendet wird.
max_upload_triple_count_per_request	Integer	Konfiguriert die Anzahl der Triples pro Upload-Request.
update_execution_timeout	Long	Konfiguriert das Aktualisierungs-Timeout für eine Abfrage.
server_uri	String	Konfiguriert die Server-URI für HTTP-basierte Storage Backends.
relative_query_endpoint	String	Konfiguriert den Abfrageendpunkt für HTTP-basierte Storage Backends (Teil der kompletten Abfrageendpunkt-URI).
relative_update_endpoint	String	Konfiguriert den Aktualisierungsendpunkt für HTTP-basierte Storage Backends (Teil der kompletten Aktualisierungsendpunkt-URI).
dataset	String	Konfiguriert den Dataset-Namen für HTTP-basierte Storage Backends (Teil der Endpunkt-URI).
relative_data_endpoint	String	Konfiguriert den Datenendpunktnamen für HTTP-basierte Storage Backends (Teil der Endpunkt-URI).
relative_sparql_endpoint	String	Konfiguriert den SPARQL-Endpunktnamen für HTTP-basierte Storage Backends (Teil der Endpunkt-URI).
sparql_endpoint	String	Schreibgeschützt. Fordert den Zugriff auf die komplette SPARQL-Endpunkt-URI an.
data_endpoint	String	Schreibgeschützt. Fordert den Zugriff auf die komplette Datenendpunkt-URI an.
query_endpoint	String	Schreibgeschützt. Fordert den Zugriff auf die komplette Abfrageendpunkt-URI an.
update_endpoint	String	Schreibgeschützt. Fordert den Zugriff auf die komplette Aktualisierungsendpunkt-URI an.

Funktionen	Rückgabe-Objekt/Wert	Beschreibung
reset()	Kein	Setzt die Cloudkonfiguration der Codeanalyse zurück.