Oggetti di script (API analisi codice)

Panoramica

Tramite le Estensioni oggetto di script, è possibile utilizzare gli oggetti di script restituiti, ad esempio, per avviare un'analisi del codice o per accedere ai risultati di metriche o convenzioni.

API di analisi codice

Questo oggetto fornisce accesso generico all'analisi del codice di un oggetto Applicazione.

Proprietà

Valore/Oggetto restituito

Descrizione

metrics

MetricsTable con funzioni/proprietà allegate

La proprietà metrics fornisce accesso all'API di script specifica delle metriche.

conventions

ConventionsTable con funzioni/proprietà allegate

La proprietà conventions fornisce accesso all'API di script specifica delle convenzioni.

configuration

Configuration con funzioni/proprietà allegate

La proprietà configuration fornisce accesso all'API di script specifica delle convenzioni.

cloud_connection

CloudConnection con funzioni/proprietà allegate

La proprietà cloud_connection fornisce accesso al caricamento delle istantanee nei Triple Storage e alla configurazione della connessione cloud.

Funzioni

Valore/Oggetto restituito

Descrizione

clear()

None

Rimuove il modello dipendenza dalla memoria. È possibile avviare un'altra esecuzione dell'analisi del codice.

perform_full_analysis()

Nessuno

Avvia un'esecuzione di analisi del codice completa. Il modello dipendenza viene generato e riutilizzato ad esempio da API metriche.

store_dependency_model(filename)

Nessuno

Memorizza il modello dipendenza in un file XML.

store_ttl(filename)

Nessuno

Memorizza il modello RDF in formato TTL su disco.

TTL (Turtle Language) è un formato standard di https://www.w3.org per memorizzare modelli RDF.

API metriche

Funzioni

Valore/Oggetto restituito

Descrizione

get_all_metrics()

string[] con nomi di metriche disponibili

Recupera i nomi delle query metriche disponibili.

full_metrics_table()

MetricsTableResult con funzioni/proprietà allegate

Crea la tabella metriche completa delle query metriche disponibili. Vedere API risultati tabella metriche.

metrics_table()

MetricsTableResult con funzioni/proprietà allegate.

Crea la tabella metriche con query metriche specificate. Vedere API risultati tabella metriche.

API risultati tabella metriche

Proprietà

Valore/Oggetto restituito

Descrizione

successful

BOOL

Recupera il risultato ottenuto.

message

STRING

Recupera il messaggio del risultato leggibile.

project_path

STRING

Recupera il percorso del progetto su cui si basano questi risultati.

analysis_started_at

STRING

Recupera l'ora di inizio della generazione di questa tabella risultati.

analysis_finished_at

STRING

Recupera l'ora di fine della generazione di questa tabella risultati.

analyser_version

STRING

Recupera la versione dell'analizzatore di codice utilizzato per creare questa tabella risultati.

columns

STRING

Recupera l'elenco delle colonne in questa tabella risultati.

rows

STRING

Recupera la tabella (righe con colonne: [Array] di [Array]) con i valori del risultato.

Funzioni

Valore/Oggetto restituito

Descrizione

store_as_xml(…)

None

Memorizza i risultati della tabella metriche come file XML su disco.

store_as_csv(…)

Nessuno

Memorizza i risultati della tabella metriche come file CSV su disco.

store_as_html(…)

Nessuno

Memorizza i risultati della tabella metriche come file HTML su disco.

Consente di specificare un file XSLT per la trasformazione da XML a HTML, se richiesto.

API convenzioni

Funzioni

Valore/Oggetto restituito

Descrizione

get_all_conventions()

STRING[] con nomi di convenzioni disponibili

Recupera i nomi delle query convenzione disponibili.

full_conventions_table()

ConventionTableResult con funzioni/proprietà allegate

Crea la tabella convenzioni completa delle query convenzione disponibili.

Vedere API risultati tabella convenzioni.

conventions_table()

ConventionTableResult con funzioni/proprietà allegate.

Crea la tabella convenzioni con query convenzione specificate.

Vedere API risultati tabella convenzioni.

API risultati tabella convenzioni

Proprietà

Valore/Oggetto restituito

Descrizione

successful

BOOL

Recupera il risultato ottenuto.

message

STRING

Recupera il messaggio del risultato leggibile.

project_path

STRING

Recupera il percorso del progetto su cui si basano questi risultati.

analysis_started_at

STRING

Recupera l'ora di inizio della generazione di questa tabella risultati.

analysis_finished_at

STRING

Recupera l'ora di fine della generazione di questa tabella risultati.

analyser_version

STRING

Recupera la versione dell'analizzatore di codice utilizzato per creare questa tabella risultati.

columns

STRING

Recupera l'elenco delle colonne in questa tabella risultati.

rows

STRING

Recupera la tabella (righe con colonne: [Array] di [Array]) con i valori del risultato.

Funzioni

Valore/Oggetto restituito

Descrizione

store_as_xml(…)

None

Memorizza i risultati della tabella convenzioni come file XML su disco.

store_as_csv(…)

Nessuno

Memorizza i risultati della tabella convenzioni come file CSV su disco.

store_as_html(…)

Nessuno

Memorizza i risultati della tabella convenzioni come file HTML su disco.

Consente di specificare un file XSLT per la trasformazione da XML a HTML, se richiesto.

API di configurazione

Proprietà

Valore/Oggetto restituito

Descrizione

triple_storage_backend_type

Enumerazione TripleStorageBackendTypes

Configura il tipo backend Triple Storage RDF da utilizzare per gestire i dati di analisi codice.

thresshold_for_out_proc_backend_usage

INT

Configura la soglia per la selezione automatica del tipo di backend di storage utilizzato (In-memoria o Proc est).

max_upload_triple_count_per_request

INT

Configura il numero di Triple per richiesta di caricamento.

query_execution_timeout

Long

Configura il timeout di esecuzione della query.

update_execution_timeout

Long

Configura il timeout di esecuzione aggiornamento per una query.

server_uri

STRING

Configura l'URI del server per backend di storage basati su http.

relative_query_endpoint

STRING

Configura l'endpoint query per backend di storage basati su http (parte dell'url dell'endpoint query completo).

relative_update_endpoint

STRING

Configura l'endpoint di aggiornamento per backend di storage basati su http (parte dell'url dell'endpoint di aggiornamento completo).

dataset

STRING

Configura il nome del set di dati per backend di storage basati su http (parte dell'url dell'endpoint).

relative_data_endpoint

STRING

Configura il nome dell'endpoint dati per backend di storage basati su http (parte dell'url dell'endpoint).

relative_sparql_endpoint

STRING

Configura il nome dell'endpoint SPARQL per backend di storage basati su http (parte dell'url dell'endpoint).

graph_name

STRING

Configura il nome dell'immagine per backend di storage basati su http (parte dell'url dell'endpoint).

sparql_endpoint

STRING

Solo lettura. Ottiene l'accesso all'url dell'endpoint SPARQL completo.

data_endpoint

STRING

Solo lettura. Ottiene l'accesso all'url dell'endpoint dati completo.

query_endpoint

STRING

Solo lettura. Ottiene l'accesso all'url dell'endpoint query completo.

update_endpoint

STRING

Solo lettura. Ottiene l'accesso all'url dell'endpoint di aggiornamento completo.

Funzioni

Valore/Oggetto restituito

Descrizione

reset()

None

Azzera la configurazione di analisi codice.

API connessione cloud

Proprietà

Valore/Oggetto restituito

Descrizione

configuration

CloudConfiguration con funzioni/proprietà allegate.

La proprietà di configurazione cloud fornisce accesso all'API di script specifica della configurazione cloud.

Funzioni

Valore/Oggetto restituito

Descrizione

upload_to_triple_storage(…)

None

Avvia il caricamento di una istantanea del modello RDF nel Triple Storage RDF configurato.

API configurazione cloud

Proprietà

Valore/Oggetto restituito

Descrizione

http_backend_type

Enumerazione HttpBackendTypes

Configura il tipo di backend http (ad esempio, generico, Apache Fuseki, Stardog e così via). Questo valore di configurazione viene considerato solo se il tipo di backend Triple Storage è impostato su "Http".

max_upload_triple_count_per_request

Integer

Configura il numero di Triple per richiesta di caricamento.

update_execution_timeout

Long

Configura il timeout di esecuzione aggiornamento per una query.

server_uri

String

Configura l'URI del server per backend di storage basati su http.

relative_query_endpoint

String

Configura l'endpoint query per backend di storage basati su http (parte dell'URI dell'endpoint query completo).

relative_update_endpoint

String

Configura l'endpoint di aggiornamento per backend di storage basati su http (parte dell'URI dell'endpoint di aggiornamento completo).

dataset

String

Configura il nome del set di dati per backend di storage basati su http (parte dell'URI dell'endpoint).

relative_data_endpoint

String

Configura il nome dell'endpoint dati per backend di storage basati su http (parte dell'URI dell'endpoint).

relative_sparql_endpoint

String

Configura il nome dell'endpoint SPARQL per backend di storage basati su http (parte dell'URI dell'endpoint).

sparql_endpoint

String

Solo lettura. Ottiene l'accesso all'URI dell'endpoint SPARQL completo.

data_endpoint

String

Solo lettura. Ottiene l'accesso all'URI dell'endpoint dati completo.

query_endpoint

String

Solo lettura. Ottiene l'accesso all'URI dell'endpoint query completo.

update_endpoint

String

Solo lettura. Ottiene l'accesso all'URI dell'endpoint di aggiornamento completo.

Funzioni

Valore/Oggetto restituito

Descrizione

reset()

None

Azzera la configurazione cloud di analisi codice.