com.streamsets.systemexplorer.api.ExplorerLoaderContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of streamsets-datacollector-api Show documentation

StreamSets Data Collector API

There is a newer version: 6.2.1

Show newest version

/*
 * Copyright 2023 StreamSets Inc.
 *
 * Licensed 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.
 */
package com.streamsets.systemexplorer.api;

/**
 * Data prepared by a loader for a searcher to search for specific data based on a user request.
 */
public interface ExplorerLoaderContext {
  /**
   * Data storage where a searcher should search data for.
   * If a data is not bound, the storage could be modified by the searcher if it needs data missing in the storage.
   *
   * @return data storage where to search data for.
   */
  ExplorerData getData();

  /**
   * Returns true if all not bounded data have already been added to the data storage.
   *
   * @return true if all not bounded data have already been added to the data storage.
   */
  boolean isDataUnbounded();

  /**
   * Adds bound data to a data storage if it's still missing for search to complete.
   *
   * @param request - explorer request context, contains data needed to complete an explorer request.
   * @param boundaries - define data boundaries in the data domain.
   */
  void load(ExplorerRequestContext request, ExplorerDataBoundaries boundaries) throws InterruptedException, ExplorerLoader.ExplorerLoaderException;
}