arlas-web-core 18.1.0 → 19.3.0-dev0

package/src/models/contributor.ts

@@ -0,0 +1,161 @@
+/*
+ * Licensed to Gisaïa under one or more contributor
+ * license agreements. See the NOTICE.txt file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Gisaïa licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { ConfigService } from '../services/config.service';
+import { CollaborativesearchService } from '../services/collaborativesearch.service';
+import { CollaborationEvent, Collaboration } from './collaboration';
+import { Observable, Subject } from 'rxjs';
+import { map, finalize, filter, debounceTime } from 'rxjs/operators';
+import { CollectionAggField, hasAtLeastOneCommon as hasAtLeastOneCommon } from '../utils/utils';
+
+export abstract class Contributor {
+
+    private name: string;
+    private fetchedData: any;
+    private _updateData = true;
+    public isDataUpdating = false;
+    public collection: string;
+    public collections: CollectionAggField[];
+    public endCollaborationEvent = new Subject();
+    protected cacheDuration: number;
+
+
+    /**
+    * @param identifier  string identifier of the contributor.
+    * @param configService  configService of the contributor.
+    */
+    constructor(public identifier: string,
+        public configService: ConfigService,
+        public collaborativeSearcheService: CollaborativesearchService, collection?: string) {
+        if (!!collection) {
+            this.collection = collection;
+        } else {
+            this.collection = this.collaborativeSearcheService.defaultCollection;
+        }
+        const configDebounceTime = this.configService.getValue('arlas.server.debounceCollaborationTime');
+        const debounceDuration = configDebounceTime !== undefined ? configDebounceTime : 750;
+        const configName = this.getConfigValue('name');
+        const configCacheDuration = this.getConfigValue('cache_duration');
+        this.cacheDuration = configCacheDuration ? configCacheDuration : this.collaborativeSearcheService.max_age;
+        this.name = configName ? configName : this.identifier;
+        // Register the contributor in collaborativeSearcheService registry
+        this.collaborativeSearcheService.register(this.identifier, this);
+        // Subscribe a bus to update data and selection
+        this.collaborativeSearcheService.collaborationBus.pipe(debounceTime(debounceDuration))
+            .subscribe(collaborationEvent => {
+                // Update only contributor of same collection that the current collaboration or on the init whit the url
+                let collaborationCollections;
+                if (!!this.collaborativeSearcheService.registry.get(collaborationEvent.id)) {
+                  collaborationCollections = this.collaborativeSearcheService.registry.get(collaborationEvent.id).collections;
+                }
+                const cs1 = !!this.collections ? this.collections.map(c => c.collectionName) : [];
+                const cs2 = !!collaborationCollections ? collaborationCollections.map(c => c.collectionName) : [];
+                const update = collaborationEvent.id === 'url' || collaborationEvent.id === 'all' || hasAtLeastOneCommon(cs1, cs2) ;
+                if (this._updateData && update) {
+                    this.updateFromCollaboration(<CollaborationEvent>collaborationEvent);
+                }
+            },
+                error => this.collaborativeSearcheService.collaborationErrorBus.next(error)
+            );
+    }
+    /**
+    * @returns package name of contributor used in configuration.
+    */
+    public abstract getPackageName(): string;
+
+    /**
+    * @param key  a `key` defined in configuration.
+    * @returns value of the `key` in configuration.
+    */
+    public getConfigValue(key: string): any {
+        let configValue = null;
+        const contributor = this.configService.getValue('arlas.web.contributors').find(
+            contrib => contrib.identifier === this.identifier
+        );
+        if (contributor) {
+            configValue = contributor[key];
+        }
+        return configValue;
+    }
+
+    /**
+    * @returns  name of contributor set in configuration.
+    */
+    public getName(): string {
+        return this.name;
+    }
+
+    /**
+    * @returns  set the name of the contributor
+    */
+    public setName(name: string): void {
+        this.name = name;
+    }
+
+    /**
+    * @returns  whether the data of contributor should be updated.
+    */
+    public get updateData(): boolean {
+        return this._updateData;
+    }
+
+    /**
+    * @param  value set if the data of contributor should be updated or not.
+    */
+    public set updateData(value) {
+        this._updateData = value;
+    }
+
+
+    /**
+    * @returns  name and live informations about filter contributor.
+    */
+    public abstract getFilterDisplayName(): string;
+
+    public abstract fetchData(collaborationEvent: CollaborationEvent): Observable<any>;
+
+    public abstract computeData(data: any): any;
+
+    public abstract setData(data: any): any;
+
+    public abstract setSelection(data: any, c: Collaboration): any;
+
+    public updateFromCollaboration(collaborationEvent: CollaborationEvent) {
+        this.collaborativeSearcheService.ongoingSubscribe.next(1);
+        this.isDataUpdating = true;
+        this.fetchData(collaborationEvent)
+            .pipe(
+                map(f => this.computeData(f)),
+                map(f => { this.fetchedData = f; this.setData(f); }),
+                finalize(() => {
+                    this.setSelection(this.fetchedData, this.collaborativeSearcheService.getCollaboration(this.identifier));
+                    this.collaborativeSearcheService.contribFilterBus
+                        .next(this.collaborativeSearcheService.registry.get(this.identifier));
+                    this.collaborativeSearcheService.ongoingSubscribe.
+                        next(-1);
+                    this.isDataUpdating = false;
+                    this.endCollaborationEvent.next({});
+                })
+            )
+            .subscribe(
+                data => data,
+                error => this.collaborativeSearcheService.collaborationErrorBus.next(error)
+            );
+    }
+}

package/src/models/projections.ts

@@ -0,0 +1,58 @@
+/*
+ * Licensed to Gisaïa under one or more contributor
+ * license agreements. See the NOTICE.txt file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Gisaïa licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Search, Aggregation } from 'arlas-api';
+
+/**
+* Enum  ARLAS SERVER type of request.
+*/
+export enum projType {
+  aggregate,
+  geoaggregate,
+  geohashgeoaggregate,
+  geotilegeoaggregate,
+  count,
+  search,
+  geosearch,
+  tiledgeosearch,
+  /**range is deprecated and will be removed in v13.0.0 */
+  range,
+  compute,
+  shapesearch,
+  shapeaggregate
+}
+
+export interface TiledSearch {
+  search: Search;
+  x: number;
+  y: number;
+  z: number;
+}
+
+export interface GeohashAggregation {
+  geohash: string;
+  aggregations: Array<Aggregation>;
+}
+
+export interface GeoTileAggregation {
+  x: number;
+  y: number;
+  z: number;
+  aggregations: Array<Aggregation>;
+}