Objets de script (API d'analyse de code)

Présentation

Les extensions d'objets de script permettent d'utiliser les objets de script renvoyés pour déclencher une analyse du code ou consulter les résultats concernant les conventions ou les métriques, par exemple.

API d'analyse de code

Cet objet offre un accès global à l'analyse de code d'un objet Application.

Propriété

Objet/valeur renvoyé(e)

Description

metrics

MetricsTable, avec fonctions/propriétés associées

La propriété metrics permet d'accéder à l'API de création de scripts propre aux métriques.

conventions

ConventionsTable, avec fonctions/propriétés associées

La propriété conventions permet d'accéder à l'API de création de scripts propre aux conventions.

configuration

Configuration, avec fonctions/propriétés associées

La propriété configuration permet d'accéder à l'API de création de scripts propre aux conventions.

cloud_connection

CloudConnection, avec fonctions/propriétés associées

La propriété cloud_connection permet d'accéder au téléchargement de snapshots vers les Triple Storages, ainsi qu'à la configuration de la connexion au cloud.

Fonctions

Objet/valeur renvoyé(e)

Description

clear()

Aucun(e)

Supprime le modèle de dépendance en mémoire. Une autre analyse de code peut être lancée.

perform_full_analysis()

Aucun(e)

Démarre une analyse de code complète. Le modèle de dépendance est généré et réutilisé (par exemple, par l'API de métriques).

store_dependency_model(filename)

Aucun(e)

Stocke le modèle de dépendance dans un fichier XML.

store_ttl(filename)

Aucun(e)

Stocke le modèle RDF sur disque dans un fichier TTL.

Le langage TTL (Turtle Language) est un format standard de stockage des modèles RDF défini par le W3C (https://www.w3.org).

API de métriques

Fonctions

Objet/valeur renvoyé(e)

Description

get_all_metrics()

string[], avec noms des métriques disponibles

Renvoie les noms des requêtes de métrique disponibles.

full_metrics_table()

MetricsTableResult, avec fonctions/propriétés associées

Génère le Tableau des mesures complet à partir des requêtes de métrique disponibles. Voir API de résultats du Tableau des mesures.

metrics_table()

MetricsTableResult, avec fonctions/propriétés associées

Génère le Tableau des mesures à partir des requêtes de métrique indiquées. Voir API de résultats du Tableau des mesures.

API de résultats du Tableau des mesures

Propriétés

Objet/valeur renvoyé(e)

Description

successful

BOOL

Renvoie le résultat (réussite).

message

STRING

Renvoie le message de résultat lisible.

project_path

STRING

Renvoie le chemin du projet dont les résultats proviennent.

analysis_started_at

STRING

Renvoie l'heure de début de la génération de ce tableau de résultats.

analysis_finished_at

STRING

Renvoie l'heure de fin de la génération de ce tableau de résultats.

analyser_version

STRING

Renvoie la version de l'analyseur de code qui a servi à générer ce tableau de résultats.

columns

STRING

Renvoie la liste des colonnes de ce tableau de résultats.

rows

STRING

Renvoie le tableau (lignes avec colonnes : [Array] of [Array]) avec les valeurs de résultat.

Fonctions

Objet/valeur renvoyé(e)

Description

store_as_xml(…)

Aucun(e)

Stocke les résultats du Tableau des mesures sur disque dans un fichier XML.

store_as_csv(…)

Aucun(e)

Stocke les résultats du Tableau des mesures sur disque dans un fichier CSV.

store_as_html(…)

Aucun(e)

Stocke les résultats du Tableau des mesures sur disque dans un fichier HTML.

Indiquez un fichier XSLT pour convertir le format XML en HTML, si besoin.

API de conventions

Fonctions

Objet/valeur renvoyé(e)

Description

get_all_conventions()

STRING[], avec noms des conventions disponibles

Renvoie les noms des requêtes de conventions disponibles.

full_conventions_table()

ConventionTableResult, avec fonctions/propriétés associées

Génère le Tableau des conventions à partir des requêtes de convention disponibles.

Voir API de résultats du Tableau des conventions.

conventions_table()

ConventionTableResult, avec fonctions/propriétés associées

Génère le Tableau des conventions à partir des requêtes de convention indiquées.

Voir API de résultats du Tableau des conventions.

API de résultats du Tableau des conventions

Propriétés

Objet/valeur renvoyé(e)

Description

successful

BOOL

Renvoie le résultat (réussite).

message

STRING

Renvoie le message de résultat lisible.

project_path

STRING

Renvoie le chemin du projet dont les résultats proviennent.

analysis_started_at

STRING

Renvoie l'heure de début de la génération de ce tableau de résultats.

analysis_finished_at

STRING

Renvoie l'heure de fin de la génération de ce tableau de résultats.

analyser_version

STRING

Renvoie la version de l'analyseur de code qui a servi à générer ce tableau de résultats.

columns

STRING

Renvoie la liste des colonnes de ce tableau de résultats.

rows

STRING

Renvoie le tableau (lignes avec colonnes : [Array] of [Array]) avec les valeurs de résultat.

Fonctions

Objet/valeur renvoyé(e)

Description

store_as_xml(…)

Aucun(e)

Stocke les résultats du Tableau des conventions sur disque dans un fichier XML.

store_as_csv(…)

Aucun(e)

Stocke les résultats du Tableau des conventions sur disque dans un fichier CSV.

store_as_html(…)

Aucun(e)

Stocke les résultats du Tableau des conventions sur disque dans un fichier HTML.

Indiquez un fichier XSLT pour convertir le format XML en HTML, si besoin.

API de configuration

Propriété

Objet/valeur renvoyé(e)

Description

triple_storage_backend_type

Énumération TripleStorageBackendTypes

Configure le type de backend Triple Storage RDF qui servira à gérer les données d'analyse de code.

thresshold_for_out_proc_backend_usage

INT

Configure le seuil de sélection automatique du type de backend de stockage utilisé (en mémoire ou Out-Proc).

max_upload_triple_count_per_request

INT

Configure le nombre de triplets par demande de téléchargement.

query_execution_timeout

Long

Configure le timeout d'exécution des requêtes.

update_execution_timeout

Long

Configure le timeout d'exécution de la mise à jour d'une requête.

server_uri

STRING

Configure l'URI de serveur des backends de stockage HTTP.

relative_query_endpoint

STRING

Configure le point final de requête pour les backends de stockage HTTP (par rapport à l'URL complète de point final de requête).

relative_update_endpoint

STRING

Configure le point final de mise à jour pour les backends de stockage HTTP (par rapport à l'URL complète de point final de mise à jour).

dataset

STRING

Configure le nom du jeu de données pour les backends de stockage HTTP (par rapport à l'URL de point final).

relative_data_endpoint

STRING

Configure le point final de données pour les backends de stockage HTTP (par rapport à l'URL de point final).

relative_sparql_endpoint

STRING

Configure le point final SPARQL pour les backends de stockage HTTP (par rapport à l'URL de point final).

graph_name

STRING

Configure le nom du graphe pour les backends de stockage HTTP (par rapport à l'URL de point final).

sparql_endpoint

STRING

Lecture seule. Permet d'accéder à l'URL complète de point final SPARQL.

data_endpoint

STRING

Lecture seule. Permet d'accéder à l'URL complète de point final de données.

query_endpoint

STRING

Lecture seule. Permet d'accéder à l'URL complète de point final de requête.

update_endpoint

STRING

Lecture seule. Permet d'accéder à l'URL complète de point final de mise à jour.

Fonctions

Objet/valeur renvoyé(e)

Description

reset()

Aucun(e)

Réinitialise la configuration de l'analyse du code.

API de connexion au cloud

Propriété

Objet/valeur renvoyé(e)

Description

configuration

CloudConfiguration, avec fonctions/propriétés associées

Permet d'accéder à l'API de création de scripts propre à la configuration cloud.

Fonctions

Objet/valeur renvoyé(e)

Description

upload_to_triple_storage(…)

Aucun(e)

Démarre le téléchargement du snapshot du modèle RDF dans le Triple Storage RDF configuré.

API de configuration cloud

Propriété

Objet/valeur renvoyé(e)

Description

http_backend_type

Énumération HttpBackendTypes

Configure le type de backend HTTP (par exemple, générique, Apache Fuseki, Stardog, etc.). Cette valeur est prise en compte à condition que le type de backend Triple Storage soit défini sur « Http ».

max_upload_triple_count_per_request

Integer

Configure le nombre de triplets par demande de téléchargement.

update_execution_timeout

Long

Configure le timeout d'exécution de la mise à jour d'une requête.

server_uri

String

Configure l'URI de serveur des backends de stockage HTTP.

relative_query_endpoint

String

Configure le point final de requête pour les backends de stockage HTTP (partie de l'URI complet de point final de requête).

relative_update_endpoint

String

Configure le point final de mise à jour pour les backends de stockage HTTP (partie de l'URI complet de point final de mise à jour).

dataset

String

Configure le nom du jeu de données pour les backends de stockage HTTP (partie de l'URI de point final).

relative_data_endpoint

String

Configure le nom du point final de données pour les backends de stockage HTTP (partie de URI de point final).

relative_sparql_endpoint

String

Configure le nom du point final SPARQL pour les backends de stockage HTTP (partie de l'URI de point final).

sparql_endpoint

String

Lecture seule. Permet d'accéder à l'URI complet de point final SPARQL.

data_endpoint

String

Lecture seule. Permet d'accéder à l'URI complet de point final de données.

query_endpoint

String

Lecture seule. Permet d'accéder à l'URI complet de point final de requête.

update_endpoint

String

Lecture seule. Permet d'accéder à l'URI complet de point final de mise à jour.

Fonctions

Objet/valeur renvoyé(e)

Description

reset()

Aucun(e)

Réinitialise la configuration cloud de l'analyse du code.