/*
 * 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.update;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.apache.jena.atlas.io.IndentedWriter;
import org.apache.jena.atlas.io.PrintUtils;
import org.apache.jena.atlas.io.Printable;
import org.apache.jena.query.Syntax ;
import org.apache.jena.sparql.core.Prologue ;
import org.apache.jena.sparql.modify.UpdateCompare ;
import org.apache.jena.sparql.modify.request.UpdateSerializer ;
import org.apache.jena.sparql.modify.request.UpdateWriter ;
import org.apache.jena.sparql.serializer.SerializerRegistry ;
import org.apache.jena.sparql.serializer.UpdateSerializerFactory ;

/**
 * A SPARQL Update consists of a number of operations (e.g. INSERT, CLEAR). A
 * request is the unit of execution.
 */
public class UpdateRequest extends Prologue implements Printable, Iterable<Update> {
    private List<Update> operations = new ArrayList<>();
    private List<Update> operationsView = Collections.unmodifiableList(operations);

    public UpdateRequest() {
        super();
    }

    public UpdateRequest(Update update) {
        this();
        add(update);
    }

    public UpdateRequest add(Update update) {
        operations.add(update);
        return this;
    }

    public UpdateRequest add(String string) {
        UpdateFactory.parse(this, string);
        return this;
    }

    public List<Update> getOperations() {
        return operationsView;
    }

    @Override
    public Iterator<Update> iterator() {
        return operationsView.iterator();
    }

    @Override
    public String toString() {
        return PrintUtils.toString(this);
    }

    @Override
    public void output(IndentedWriter out) {
        // Try to use a serializer factory if available
        UpdateSerializerFactory factory = SerializerRegistry.get().getUpdateSerializerFactory(
                Syntax.defaultUpdateSyntax);
        if (factory != null) {
            UpdateSerializer serializer = factory.create(Syntax.defaultUpdateSyntax, this, out);
            serializer.open();
            serializer.update(this);
            serializer.close();
        } else {
            // Otherwise fall back to old default behaviour
            UpdateWriter.output(this, out);
        }
    }

    public boolean equalTo(UpdateRequest other) {
        return UpdateCompare.isomorphic(this, other);
    }

    // Better to have an explicit "isomorphism" equality and leave .equals
    // alone.
    // The Query object historical did it the other way so leave that.
}
