/*
 * 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
 *
 *   https://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.
 *
 *   SPDX-License-Identifier: Apache-2.0
 */

package org.apache.jena.sparql.exec;

import java.util.List;
import java.util.function.Consumer;
import java.util.stream.Stream;

import org.apache.jena.atlas.iterator.Iter;
import org.apache.jena.atlas.iterator.IteratorCloseable;
import org.apache.jena.query.QueryException;
import org.apache.jena.query.ResultSet;
import org.apache.jena.sparql.core.Var;
import org.apache.jena.sparql.engine.QueryIterator;
import org.apache.jena.sparql.engine.binding.Binding;

public interface RowSet extends IteratorCloseable<Binding> {

    public class Exception extends QueryException
    {
        public Exception(String msg) { super(msg) ; }
        public Exception(String msg, Throwable cause) { super(msg, cause) ; }
    }

    public static RowSet adapt(ResultSet resultSet) {
        if ( resultSet instanceof ResultSetAdapter ) {
            return ((ResultSetAdapter)resultSet).get();
        }
        return new RowSetAdapter(resultSet);
    }

    @Override public boolean hasNext() ;

    @Override public Binding next() ;

    /** Short form of {@code forEachRemaining}. */
    public default void forEach(Consumer<Binding> action) { forEachRemaining(action); }

    public List<Var> getResultVars() ;

    /**
     * Create a {@link RowSetRewindable} from the current position to the end.
     * This consumes this RowSet - the iterator will have ended after a call to this method.
     */
    public default RowSetRewindable rewindable() {
        return RowSetMem.create(this);
    }

    /**
     * Return a {@code RowSet} that is not connected to the original source.
     * This consumes this ResultSet and produces another one.
     */
    public default RowSet materialize() {
        return rewindable();
    }

    /** Return the row number. The first row is row 1. */
    public long getRowNumber();

    public default Stream<Binding> stream() {
        return Iter.asStream(this);
    }

    /**
     * Normally a RowSet is processed until complete which implicitly closes any
     * underlying resources. This "close" operation exists to explicitly end use of the RowSet
     * in cases where it does happen. There is no need to close RowSets
     * normally - it is the {@link QueryExec} that should be closed.
     */
    @Override
    public void close();

    /**
     * Turn a {@link QueryIterator} into a RowSet.
     * This operation does not materialize the QueryIterator.
     */
    public static RowSet create(QueryIterator qIter, List<Var> vars) {
        return RowSetStream.create(vars, qIter);
    }
}
