All files / languages/sparql/services triple-store-config-service.interface.ts

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
import { SparqlConnection } from './sparql-connection';
import { TripleStoreConfig, SparqlQueryKind } from './triple-store-config';
 
/**
 * Interface for the TripleStoreConfigService.
 */
export interface ITripleStoreConfigService {
	/**
	 * The store type assumed for connections that do not specify one.
	 */
	readonly defaultStoreType: string;
 
	/**
	 * Returns the user-defined store configs from the `mentor.sparql.stores` setting.
	 * VS Code provides the package.json default when the setting is unset at runtime.
	 * @returns An array of store configs in display order.
	 */
	getStoreConfigs(): TripleStoreConfig[];
 
	/**
	 * Resolves a store config by its id (store type).
	 * @param storeType The store-type id. Defaults to the generic SPARQL endpoint when `undefined`.
	 * @returns The matching store config, or `undefined` if no config has that id.
	 */
	getStoreConfig(storeType: string | undefined): TripleStoreConfig | undefined;
 
	/**
	 * Checks if the given connection supports inference toggling.
	 * The workspace connection always supports inference. For all other connections, support
	 * is determined by the store config's `inference.supported` flag.
	 * @param connection The SPARQL connection to check.
	 * @returns `true` if the connection supports inference, `false` otherwise.
	 */
	supportsInference(connection: SparqlConnection): boolean;
 
	/**
	 * Returns whether the connection targets the internal in-memory workspace store.
	 * @param connection Id of the connection to check.
	 * @returns `true` if the connection is the workspace connection.
	 */
	isWorkspaceConnectionId(connectionId: string): boolean;
 
	/**
	 * Returns where a store type is defined: a built-in preset, the user
	 * settings, the workspace settings, or nowhere (`undefined`). A store id
	 * defined in both settings scopes reports `workspace`, matching the
	 * resolution precedence of `getStoreConfigs`.
	 * @param storeType The store-type id to look up.
	 */
	getStoreConfigScope(storeType: string | undefined): 'preset' | 'user' | 'workspace' | undefined;
 
	/**
	 * Resolves the effective SPARQL query template of the given kind for a connection.
	 * Resolution order: the store config's own query → global `mentor.sparql.*` fallback.
	 * @param connection The SPARQL connection.
	 * @param kind The kind of query template to resolve.
	 * @returns The resolved template, or `undefined` if none is configured at any level.
	 */
	getQueryTemplate(connection: SparqlConnection, kind: SparqlQueryKind): string | undefined;
}