/*
 * 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.mem2.store.legacy;

import org.apache.jena.graph.Node;
import org.apache.jena.graph.Triple;
import org.apache.jena.mem2.collection.JenaSet;
import org.apache.jena.util.iterator.ExtendedIterator;

import java.util.stream.Stream;

/**
 * A map from a node to the triples that have that node as subject, predicate or object.
 */
public interface NodeToTriplesMap extends JenaSet<Triple> {

    /**
     * Answer an iterator over all the triples in this map that match the pattern.
     *
     * @param index The node to match as key.
     * @param n2    A node to match, or Node.ANY.
     * @param n3    A node to match, or Node.ANY.
     * @return An iterator over all the triples in this map that match the pattern.
     */
    ExtendedIterator<Triple> iteratorForMatches(Node index, Node n2, Node n3);

    /**
     * Answer a stream over all the triples in this map that match the pattern.
     *
     * @param index The node to match as key.
     * @param n2    A node to match, or Node.ANY.
     * @param n3    A node to match, or Node.ANY.
     * @return A stream over all the triples in this map that match the pattern.
     */
    Stream<Triple> streamForMatches(Node index, Node n2, Node n3);

    /**
     * Answer true iff this map contains a triple that matches the pattern.
     *
     * @param index The node to match as key.
     * @param n2    A node to match, or Node.ANY.
     * @param n3    A node to match, or Node.ANY.
     * @return True iff this map contains a triple that matches the pattern.
     */
    boolean containsMatch(Node index, Node n2, Node n3);

    /**
     * Create a copy of this map.
     * The new map will contain all the same nodes as keys of this map, but copies of the bunches as values.
     *
     * @return an independent copy of this map
     */
    NodeToTriplesMap copy();
}
