Source: core/datasource/sweapi/SweApi.datasource.js

/***************************** BEGIN LICENSE BLOCK ***************************

 The contents of this file are subject to the Mozilla Public License, v. 2.0.
 If a copy of the MPL was not distributed with this file, You can obtain one
 at http://mozilla.org/MPL/2.0/.

 Software distributed under the License is distributed on an "AS IS" basis,
 WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 for the specific language governing rights and limitations under the License.

 Copyright (C) 2015-2022 Georobotix Inc. All Rights Reserved.

 Author: Mathieu Dhainaut <mathieu.dhainaut@gmail.com>

 ******************************* END LICENSE BLOCK ***************************/


import TimeSeriesDatasource from "../TimeSeries.datasource";
import {Mode} from "../Mode";
import SweApiDatasourceUpdater from "./SweApi.datasource.updater";

class SweApi extends TimeSeriesDatasource {
    /**
     * @param {String} name - the datasource name
     * @param {Object} properties - the datasource properties
     * @param {String} properties.protocol - defines the protocol of the datasource. @see {@link DataConnector}, 'http', 'ws', 'mqtt', 'file', 'topic'
     * @param {String} properties.endpointUrl the endpoint url, this property is ignored in case of using 'mqtt' protocol, the properties.mqttOpts.endpointUrl will be used instead
     * @param {String} properties.resource the resource, /procedures, /fois, /observations, /tasks, /datastreams/4778/obs
     * @param {Boolean} properties.tls - defines if use secure TLS connection
     * @param {Boolean} properties.connectorOpts - connector specific Opts
     * @param {Object} [properties.mqttOpts={}] - the Mqtt options if protocol is 'mqtt'
     * @param {String} properties.mqttOpts.prefix - the Mqtt prefix value
     * @param {String} properties.mqttOpts.endpointUrl - the Mqtt specific endpointUrl
     * @param {Number} [properties.responseFormat=application/om+json] the response format (e.g application/om+json)
     * @param {String[]} [properties.parentId=undefined] the parent id
     * @param {String[]} [properties.keywords=undefined] the keyword ids
     * @param {String[]} [properties.includedProps=undefined] the included properties
     * @param {String[]} [properties.excludedProps=undefined] the excluded properties
     * @param {string} [properties.roi=undefined] - WKT geometry and operator to filter resources on their location or geometry
     * @param {String[]} [properties.featureOfInterest=undefined] Comma separated list of feature of interest IDs to get observations for.
     * @param {String[]} [properties.observedProperty=undefined] Comma separated list of observed property URIs to get observations for.
     * @param {String[]} [properties.prefetchBatchSize=250] Number of elements to prefetch at a time
     * @param {String[]} [properties.prefetchBatchDuration=5000] Duration before prefetching the next batch. N.b the next batch will be prefetched at 80% of this duration
     */
    constructor(name, properties) {
        super(name, {
            reconnectTimeout: 1000 * 5, // default if not defined into properties
            reconnectRetry: 10,
            startTime: 'now',
            endTime: '2055-01-01T00:00:00Z',
            tls: false,
            responseFormat: 'application/swe+json',
            protocol: 'http',
            type: 'SweApiStream',
            mode: Mode.REAL_TIME,
            prefetchBatchSize: 250,
            prefetchBatchDuration: 5000,
            connectorOpts: {},
            ...properties,
        });
    }

    async createTimeUpdater() {
        if(!this.timeUpdater) {
            this.timeUpdater = new SweApiDatasourceUpdater(this.properties);
            let first = true;
            this.timeUpdater.onTimeChanged = (min, max) => {
                if (first) {
                    this.setMinTime(min);
                    first = false;
                }
                this.setMaxTime(max);
                if (this.getDataSynchronizer()) {
                    this.getDataSynchronizer().minMaxChanged(first);
                }
            }
            this.timeUpdater.onError = (err) => reject();

            return this.timeUpdater.start();
        } // TO CHECK: if timeUpdater has been created multiple times. Start() should not return anything
    }

    destroyTimeUpdater() {
        if(this.timeUpdater) {
            this.timeUpdater.destroy();
        }
        this.timeUpdater = undefined;
    }
}

export default SweApi;