All files / languages/sparql/services sparql-endpoint-provider.interface.ts

0% Statements 0/0
0% Branches 0/0
0% Functions 0/0
0% Lines 0/0

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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                                                                                                           
import { SparqlConnection, SparqlStoreType } from './sparql-connection';
import { ComunicaEndpoint } from './sparql-endpoint';
 
/**
 * Options for creating a query source.
 */
export interface SparqlEndpointOptions {
    /**
     * Whether inference should be enabled for the query source.
     */
    inferenceEnabled: boolean;
}
 
/**
 * Interface for providers that create Comunica-compatible query sources
 * for different types of SPARQL stores.
 * 
 * Each provider handles a specific store type and knows how to configure
 * inference and other store-specific features.
 */
export interface ISparqlEndpointProvider {
    /**
     * The store type this provider handles.
     */
    readonly storeType: SparqlStoreType;
 
    /**
     * Whether this provider supports inference toggling.
     */
    readonly supportsInference: boolean;
 
    /**
     * Creates a Comunica-compatible query source for the given connection.
     * @param connection The SPARQL connection.
     * @param options Options including inference settings.
     * @returns A promise that resolves to a ComunicaSource configuration.
     */
    createEndpoint(
        connection: SparqlConnection,
        options: SparqlEndpointOptions
    ): Promise<ComunicaEndpoint>;
 
    /**
     * Retrieves the list of named graphs available from the query source.
     * @param connection The SPARQL connection.
     * @param options Options including inference settings.
     * @returns A promise that resolves to an array of graph IRIs.
     */
    getGraphs(
        connection: SparqlConnection,
        options: SparqlEndpointOptions
    ): Promise<string[]>;
}