Objetos de automatización (API de análisis de código)

Descripción general

Con las Extensiones de objetos de automatización, los objetos de automatización devueltos se pueden utilizar, por ejemplo, para activar un análisis de código o para acceder a resultados de métricas o convenciones.

API de análisis de código

Este objeto ofrece acceso general al análisis de código de un objeto de Aplicación.

Propiedad	Objeto/valor devuelto	Descripción
metrics	MetricsTable con funciones o propiedades vinculadas	La propiedad metrics ofrece acceso a la API de automatización específica de métricas.
conventions	ConventionsTable con funciones o propiedades vinculadas	La propiedad conventions ofrece acceso a la API de automatización específica de convenciones.
configuration	Configuration con funciones o propiedades vinculadas	La propiedad configuration ofrece acceso a la API de automatización específica de configuración.
cloud_connection	CloudConnection con funciones o propiedades vinculadas	La propiedad cloud_connection ofrece acceso a la carga de instantáneas en los almacenamientos Triple Storage y a la configuración de la conexión a la nube.

Funciones	Objeto/valor devuelto	Descripción
clear()	Ninguno	Elimina el modelo de dependencia de la memoria. Se puede iniciar otra ejecución de análisis de código.
perform_full_analysis()	Ninguno	Inicia una ejecución completa de análisis de código. El modelo de dependencia lo crea y reutiliza, por ejemplo, la API de métricas.
store_dependency_model(filename)	Ninguno	Almacena el modelo de dependencia en un archivo XML.
store_ttl(filename)	Ninguno	Almacena el modelo RDF en formato TTL en el disco. TTL (Turtle Language) es un formato estándar de https://www.w3.org para almacenar modelos RDF.

API de métricas

Funciones	Objeto/valor devuelto	Descripción
get_all_metrics()	string[] con nombres de métricas disponibles	Obtiene los nombres de consultas de métricas disponibles.
full_metrics_table()	MetricsTableResult con funciones o propiedades vinculadas	Genera la tabla completa de métricas de las consultas de métricas disponibles. Consulte API de resultados de la tabla de métricas.
metrics_table()	MetricsTableResult con funciones o propiedades vinculadas.	Genera la tabla de métricas con las consultas de métricas especificadas. Consulte API de resultados de la tabla de métricas.

API de resultados de la tabla de métricas

Propiedades	Objeto/valor devuelto	Descripción
successful	BOOL	Obtiene el resultado.
message	STRING	Obtiene el mensaje de resultado legible.
project_path	STRING	Obtiene la ruta del proyecto en la que se basan estos resultados.
analysis_started_at	STRING	Obtiene la hora de inicio en la que se generó esta tabla de resultados.
analysis_finished_at	STRING	Obtiene la hora de fin en la que se generó esta tabla de resultados.
analyser_version	STRING	Obtiene la versión del analizador de código que se utiliza para generar esta tabla de resultados.
columns	STRING	Obtiene la lista de columnas de esta tabla de resultados.
rows	STRING	Obtiene la tabla (filas con columnas: [Matriz] de [Matriz]) con los valores de los resultados.

Funciones	Objeto/valor devuelto	Descripción
store_as_xml(…)	Ninguno	Almacena los resultados de la tabla de métricas en el disco como archivo XML.
store_as_csv(…)	Ninguno	Almacena los resultados de la tabla de métricas en el disco como archivo CSV.
store_as_html(…)	Ninguno	Almacena los resultados de la tabla de métricas en el disco como HTML. Permite especificar un archivo XSLT para la conversión de XML a HTML, en caso de que sea necesario.

Funciones

Objeto/valor devuelto

Descripción

store_as_xml(…)

Ninguno

Almacena los resultados de la tabla de métricas en el disco como archivo XML.

store_as_csv(…)

Ninguno

Almacena los resultados de la tabla de métricas en el disco como archivo CSV.

store_as_html(…)

Ninguno

Almacena los resultados de la tabla de métricas en el disco como HTML.

Permite especificar un archivo XSLT para la conversión de XML a HTML, en caso de que sea necesario.

API de convenciones

Funciones	Objeto/valor devuelto	Descripción
get_all_conventions()	STRING[] con nombres de convenciones disponibles	Obtiene los nombres de consultas de convenciones disponibles.
full_conventions_table()	ConventionTableResult con funciones o propiedades vinculadas	Genera la tabla completa de convenciones de las consultas de convenciones disponibles. Consulte API de resultados de la tabla de convenciones.
conventions_table()	ConventionTableResult con funciones o propiedades vinculadas.	Genera la tabla de convenciones con las consultas de convenciones especificadas. Consulte API de resultados de la tabla de convenciones.

Funciones

Objeto/valor devuelto

Descripción

get_all_conventions()

STRING[] con nombres de convenciones disponibles

Obtiene los nombres de consultas de convenciones disponibles.

full_conventions_table()

ConventionTableResult con funciones o propiedades vinculadas

Genera la tabla completa de convenciones de las consultas de convenciones disponibles.

Consulte API de resultados de la tabla de convenciones.

conventions_table()

ConventionTableResult con funciones o propiedades vinculadas.

Genera la tabla de convenciones con las consultas de convenciones especificadas.

Consulte API de resultados de la tabla de convenciones.

API de resultados de la tabla de convenciones

Propiedades	Objeto/valor devuelto	Descripción
successful	BOOL	Obtiene el resultado.
message	STRING	Obtiene el mensaje de resultado legible.
project_path	STRING	Obtiene la ruta del proyecto en la que se basan estos resultados.
analysis_started_at	STRING	Obtiene la hora de inicio en la que se generó esta tabla de resultados.
analysis_finished_at	STRING	Obtiene la hora de fin en la que se generó esta tabla de resultados.
analyser_version	STRING	Obtiene la versión del analizador de código que se utiliza para generar esta tabla de resultados.
columns	STRING	Obtiene la lista de columnas de esta tabla de resultados.
rows	STRING	Obtiene la tabla (filas con columnas: [Matriz] de [Matriz]) con los valores de los resultados.

Funciones	Objeto/valor devuelto	Descripción
store_as_xml(…)	Ninguno	Almacena los resultados de la tabla de convenciones en el disco como archivo XML.
store_as_csv(…)	Ninguno	Almacena los resultados de la tabla de convenciones en el disco como archivo CSV.
store_as_html(…)	Ninguno	Almacena los resultados de la tabla de convenciones en el disco como HTML. Permite especificar un archivo XSLT para la conversión de XML a HTML, en caso de que sea necesario.

Funciones

Objeto/valor devuelto

Descripción

store_as_xml(…)

Ninguno

Almacena los resultados de la tabla de convenciones en el disco como archivo XML.

store_as_csv(…)

Ninguno

Almacena los resultados de la tabla de convenciones en el disco como archivo CSV.

store_as_html(…)

Ninguno

Almacena los resultados de la tabla de convenciones en el disco como HTML.

Permite especificar un archivo XSLT para la conversión de XML a HTML, en caso de que sea necesario.

API de configuración

Propiedad	Objeto/valor devuelto	Descripción
triple_storage_backend_type	Enumeración TripleStorageBackendTypes	Configura el tipo de backend de Triple Storage RDF que se usará para gestionar los datos del análisis de código.
thresshold_for_out_proc_backend_usage	INT	Configura el umbral de autoselección del tipo de backend de almacenamiento utilizado (In-Memory u Out-Proc).
max_upload_triple_count_per_request	INT	Configura el número de tripletas por solicitud de carga.
query_execution_timeout	Long	Configura el tiempo de espera de ejecución de consultas.
update_execution_timeout	Long	Configura el tiempo de espera de ejecución de actualizaciones de una consulta.
server_uri	STRING	Configura el URI de servidor para backends de almacenamiento basados en http.
relative_query_endpoint	STRING	Configura el punto de conexión de la consulta para backends de almacenamiento basados en http (parte de la URL completa del punto de conexión de la consulta).
relative_update_endpoint	STRING	Configura el punto de conexión de la actualización para backends de almacenamiento basados en http (parte de la URL completa del punto de conexión de la actualización).
dataset	STRING	Configura el nombre del conjunto de datos para backends de almacenamiento basados en http (parte de la URL del punto de conexión).
relative_data_endpoint	STRING	Configura el nombre del punto de conexión de datos para backends de almacenamiento basados en http (parte de la URL del punto de conexión).
relative_sparql_endpoint	STRING	Configura el nombre del punto de conexión de SPARQL para backends de almacenamiento basados en http (parte de la URL del punto de conexión).
graph_name	STRING	Configura el nombre del grafo para backends de almacenamiento basados en http (parte de la URL del punto de conexión).
sparql_endpoint	STRING	Solo lectura. Obtiene acceso a la URL completa del punto de conexión de SPARQL.
data_endpoint	STRING	Solo lectura. Obtiene acceso a la URL completa del punto de conexión de datos.
query_endpoint	STRING	Solo lectura. Obtiene acceso a la URL completa del punto de conexión de la consulta.
update_endpoint	STRING	Solo lectura. Obtiene acceso a la URL completa del punto de conexión de la actualización.

Funciones	Objeto/valor devuelto	Descripción
reset()	Ninguno	Restablece la configuración del análisis de código.

API de conexión a la nube

Propiedad	Objeto/valor devuelto	Descripción
configuration	CloudConfiguration con funciones o propiedades vinculadas.	La propiedad de configuración de la nube ofrece acceso a la API de automatización específica de configuración de la nube.

Funciones	Objeto/valor devuelto	Descripción
upload_to_triple_storage(…)	Ninguno	Inicia una carga de instantánea del modelo RDF en el Triple Storage RDF configurado.

API de configuración de la nube

Propiedad	Objeto/valor devuelto	Descripción
http_backend_type	Enumeración HttpBackendTypes	Configura el tipo de backend http (por ejemplo, genérico, Apache Fuseki, Stardog, etc.). Este valor de configuración solo se tiene en cuenta si el tipo de backend de Triple Storage está establecido en "http".
max_upload_triple_count_per_request	Integer	Configura el número de tripletas por solicitud de carga.
update_execution_timeout	Long	Configura el tiempo de espera de ejecución de actualizaciones de una consulta.
server_uri	String	Configura el URI de servidor para backends de almacenamiento basados en http.
relative_query_endpoint	String	Configura el punto de conexión de la consulta para backends de almacenamiento basados en http (parte del URI completo del punto de conexión de la consulta).
relative_update_endpoint	String	Configura el punto de conexión de la actualización para backends de almacenamiento basados en http (parte del URI completo del punto de conexión de la actualización).
dataset	String	Configura el nombre del conjunto de datos para backends de almacenamiento basados en http (parte del URI del punto de conexión).
relative_data_endpoint	String	Configura el nombre del punto de conexión de datos para backends de almacenamiento basados en http (parte del URI del punto de conexión).
relative_sparql_endpoint	String	Configura el nombre del punto de conexión de SPARQL para backends de almacenamiento basados en http (parte del URI punto de conexión).
sparql_endpoint	String	Solo lectura. Obtiene acceso al URI completo del punto de conexión de SPARQL.
data_endpoint	String	Solo lectura. Obtiene acceso al URI completo del punto de conexión de datos.
query_endpoint	String	Solo lectura. Obtiene acceso al URI completo del punto de conexión de la consulta.
update_endpoint	String	Solo lectura. Obtiene acceso al URI completo del punto de conexión de la actualización.

Funciones	Objeto/valor devuelto	Descripción
reset()	Ninguno	Restablece la configuración de la nube del análisis de código.