-
Notifications
You must be signed in to change notification settings - Fork 1
/
clusters.ts
72 lines (63 loc) · 2.35 KB
/
clusters.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
62
63
64
65
66
67
68
69
70
71
72
import { Query, ResultItem, ResultsResponse, SpinqueResultObject } from './types';
import { tupleListToString } from './utils';
export interface Cluster {
probability: number;
rank: number;
class: string[];
query: Query;
}
interface GetClustersOptions {
clusterEndpoint?: string;
clusterParameterName?: string;
clusterParameterType?: 'STRING' | 'TUPLE_LIST';
knownClusters?: string[];
}
const DEFAULT_CLUSTER_ENDPOINT: NonNullable<GetClustersOptions['clusterEndpoint']> = 'type:FILTER';
const DEFAULT_CLUSTER_PARAMETER_NAME: NonNullable<GetClustersOptions['clusterParameterName']> = 'value';
const DEFAULT_CLUSTER_PARAMETER_TYPE: NonNullable<GetClustersOptions['clusterParameterType']> = 'TUPLE_LIST';
const RDFS_CLASS = 'http://www.w3.org/2000/01/rdf-schema#Class';
/**
* Taskes a ResultsResponse, finds clusters in the results and returns a list of Cluster objects.
* These Cluster objects contain a Query that can be used to fetch the contents of the clusters
* by stacking the Query on top of the results Query[].
*/
export const getClusters = (results: ResultsResponse, options: GetClustersOptions = {}) => {
const endpoint = options.clusterEndpoint ?? DEFAULT_CLUSTER_ENDPOINT;
const parameterName = options.clusterParameterName ?? DEFAULT_CLUSTER_PARAMETER_NAME;
const parameterType = options.clusterParameterType ?? DEFAULT_CLUSTER_PARAMETER_TYPE;
const clusters: Cluster[] = [];
// Loop through result items and when encountering a cluster, add it to the list
for (let item of results.items) {
if (!isCluster(item)) {
continue;
}
const cluster = {
probability: item.probability,
rank: item.rank,
class: item.tuple[0].class,
query: {
endpoint,
parameters: {
[parameterName]: parameterType === 'TUPLE_LIST' ? tupleListToString([item.tuple[0].id]) : item.tuple[0].id,
},
},
};
clusters.push(cluster);
}
return clusters;
};
/**
* Takes a result item and checks if it is a cluster.
* A result is considered a cluster when it's of type rdfs:Class.
*/
export const isCluster = (item: ResultItem): item is ResultItem<[SpinqueResultObject]> => {
if (
!item.tuple ||
item.tuple.length !== 1 ||
typeof item.tuple[0] === 'string' ||
typeof item.tuple[0] === 'number'
) {
return false;
}
return item.tuple[0].class.includes(RDFS_CLASS);
};