sparnatural/dist/types/sparnatural/components/datasources/DataProviders.d.ts

Visual client-side SPARQL query builder and knowledge graph exploration tool

import { Term } from "@rdfjs/types/data-model";
import { RDFTerm } from "../../SparnaturalQueryIfc";
/**
 * An item returned by a list widget datasource
 */
export interface RdfTermDatasourceItem {
    term: RDFTerm;
    label: string;
    group?: string;
    itemLabel?: string;
}
/**
 * Datasource item for a tree. The "group" variable is not used in that case.
 */
export interface RdfTermTreeDatasourceItem extends RdfTermDatasourceItem {
    hasChildren: boolean;
    disabled: boolean;
}
/**
 * Interface for objects that can provide data to a ListWidget :
 * either through a SPARQL query, or through custom mean (calling an API)
 */
export interface ListDataProviderIfc {
    init(lang: string, defaultLang: string, typePredicate: string): void;
    getListContent(domain: string, predicate: string, range: string, callback: (items: RdfTermDatasourceItem[]) => void, errorCallback?: (payload: any) => void): void;
}
/**
 * An implementation of ListDataProviderIfc that sorts items of another data provider
 */
export declare class SortListDataProvider implements ListDataProviderIfc {
    delegate: ListDataProviderIfc;
    lang: string;
    constructor(delegate: ListDataProviderIfc);
    init(lang: string, defaultLang: string, typePredicate: string): void;
    getListContent(domain: string, predicate: string, range: string, callback: (items: RdfTermDatasourceItem[]) => void, errorCallback?: (payload: any) => void): void;
}
/**
 * Interface for objects that can provide data to a ListWidget :
 * either through a SPARQL query, or through custom mean (calling an API)
 */
export interface ValuesListDataProviderIfc {
    init(lang: string, defaultLang: string, typePredicate: string): void;
    getListContent(values: Term[], callback: (items: RdfTermDatasourceItem[]) => void, errorCallback?: (payload: any) => void): void;
}
/**
 * An implementation of ValuesListDataProviderIfc that sorts items of another data provider
 */
export declare class SortValuesListDataProvider implements ValuesListDataProviderIfc {
    delegate: ValuesListDataProviderIfc;
    lang: string;
    constructor(delegate: ValuesListDataProviderIfc);
    init(lang: string, defaultLang: string, typePredicate: string): void;
    getListContent(values: Term[], callback: (items: RdfTermDatasourceItem[]) => void, errorCallback?: (payload: any) => void): void;
}
/**
 * Interface for objects that can provide data to an AutocompleteWidget :
 * either through a SPARQL query, or through custom mean (calling an API)
 */
export interface AutocompleteDataProviderIfc {
    init(lang: string, defaultLang: string, typePredicate: string): void;
    /**
     * Used by new Awesomplete implementation
     */
    getAutocompleteSuggestions(domain: string, predicate: string, range: string, key: string, callback: (items: RdfTermDatasourceItem[]) => void, errorCallback?: (payload: any) => void): void;
}
/**
 * Interface for objects that can provide data to a TreeWidget
 */
export interface TreeDataProviderIfc {
    init(lang: string, defaultLang: string, typePredicate: string): void;
    getRoots(domain: string, predicate: string, range: string, callback: (items: {
        term: RDFTerm;
        label: string;
        hasChildren: boolean;
        disabled: boolean;
    }[]) => void, errorCallback?: (payload: any) => void): void;
    getRoots(domain: string, predicate: string, range: string, callback: (items: RdfTermTreeDatasourceItem[]) => void, errorCallback?: (payload: any) => void): void;
    getChildren(node: string, domain: string, predicate: string, range: string, callback: (items: RdfTermTreeDatasourceItem[]) => void, errorCallback?: (payload: any) => void): void;
}
/**
 * An implementation of ListDataProviderIfc that sorts items of another data provider
 */
export declare class SortTreeDataProvider implements TreeDataProviderIfc {
    delegate: TreeDataProviderIfc;
    lang: string;
    constructor(delegate: TreeDataProviderIfc);
    init(lang: string, defaultLang: string, typePredicate: string): void;
    getRoots(domain: string, predicate: string, range: string, callback: (items: RdfTermTreeDatasourceItem[]) => void, errorCallback?: (payload: any) => void): void;
    getChildren(node: string, domain: string, predicate: string, range: string, callback: (items: RdfTermTreeDatasourceItem[]) => void, errorCallback?: (payload: any) => void): void;
}