/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.
 */
package org.apache.jena.geosparql.spatial;

import java.nio.file.Path;
import java.util.Collection;

import org.apache.jena.geosparql.implementation.SRSInfo;
import org.apache.jena.graph.Node;
import org.apache.jena.sparql.core.Quad;
import org.locationtech.jts.geom.Envelope;

public interface SpatialIndex {

    /**
     *
     * @return Information about the SRS used by the SpatialIndex.
     */
    SRSInfo getSrsInfo();

    /**
     *
     * @return True if the SpatialIndex is empty.
     */
    boolean isEmpty();

    /**
     * Returns the number of items in the index.
     */
    long getSize();

    /**
     * Query the index for all matching items in the given graph.
     *
     * The default graph can be referenced with null or any value for which {@link Quad#isDefaultGraph()} returns true.
     * The union graph (= all named graphs but not the default graph) can be referenced with {@link Quad#unionGraph}.
     *
     * @param searchEnvelope The bounding box for which to find overlapping items.
     * @param graph The graph to which to restrict the query.
     * @return The collection of nodes whose envelopes overlap with the search envelope.
     */
    Collection<Node> query(Envelope searchEnvelope, Node graph);

    Path getLocation();
    void setLocation(Path location);
}
