Source: client/querying-client.js

  1. /*
  2.  * Copyright 2023, TeamDev. All rights reserved.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  * http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Redistribution and use in source and/or binary forms, with or without
  11.  * modification, must retain the above copyright notice and the following
  12.  * disclaimer.
  13.  *
  14.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25.  */
  27. import {QueryRequest} from "./query-request";
  29. /**
  30.  * A client which performs entity state queries.
  31.  *
  32.  * @abstract
  33.  */
  34. export class QueryingClient {
  36.   /**
  37.    * @param {!ActorRequestFactory} actorRequestFactory
  38.    *        a request factory to build requests to Spine server
  39.    */
  40.   constructor(actorRequestFactory) {
  41.     this._requestFactory = actorRequestFactory;
  42.   }
  44.   /**
  45.    * Creates a new query request.
  46.    *
  47.    * @param {!Class<Message>} entityType the target entity type
  48.    * @param {!Client} client the client which initiated the request
  49.    * @return {QueryRequest} a new query request
  50.    */
  51.   select(entityType, client) {
  52.     return new QueryRequest(entityType, client, this._requestFactory);
  53.   }
  55.   /**
  56.    * Executes the given `Query` instance specifying the data to be retrieved from
  57.    * Spine server fulfilling a returned promise with an array of received objects.
  58.    *
  59.    * @param {!spine.client.Query} query a query instance to be executed
  60.    * @return {Promise<Message[]>} a promise to be fulfilled with a list of Protobuf
  61.    *        messages of a given type or with an empty list if no entities matching given query
  62.    *        were found; rejected with a `SpineError` if error occurs
  63.    *
  64.    * @template <T> a Protobuf type of entities being the target of a query
  65.    */
  66.   read(query) {
  67.     throw new Error('Not implemented in abstract base.');
  68.   }
  70.   /**
  71.    * Creates a new query factory instance which can be further used for the `Query` creation.
  72.    *
  73.    * @return {QueryFactory}
  74.    */
  75.   newQuery() {
  76.     return this._requestFactory.query();
  77.   }
  78. }