owlapi-version5/api/src/main/java/org/semanticweb/owlapi/model/SetOntologyID.java
/* This file is part of the OWL API.
 * The contents of this file are subject to the LGPL License, Version 3.0.
 * Copyright 2014, The University of Manchester
 * 
 * This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
 *
 * Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
 * 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 org.semanticweb.owlapi.model;

import static org.semanticweb.owlapi.util.OWLAPIPreconditions.checkNotNull;
import static org.semanticweb.owlapi.util.OWLAPIPreconditions.emptyOptional;
import static org.semanticweb.owlapi.util.OWLAPIPreconditions.optional;

import javax.annotation.Nullable;
import org.semanticweb.owlapi.change.SetOntologyIDData;

/**
 * @author Matthew Horridge, The University of Manchester, Information Management Group
 * @since 3.0.0
 */
public class SetOntologyID extends OWLOntologyChange {

    private static final String ONTOLOGY_ID_CANNOT_BE_NULL = "ontology id cannot be null";
    private final OWLOntologyID ontologyID;
    private final OWLOntologyID newOntologyID;

    /**
     * Creates a set ontology id change, which will set the ontology id to the
     * new one.
     *
     * @param ont The ontology whose id is to be changed
     * @param ontologyID The ontology ID
     */
    public SetOntologyID(OWLOntology ont, OWLOntologyID ontologyID) {
        super(ont);
        this.ontologyID = checkNotNull(ont.getOntologyID(), ONTOLOGY_ID_CANNOT_BE_NULL);
        newOntologyID = checkNotNull(ontologyID, ONTOLOGY_ID_CANNOT_BE_NULL);
    }

    SetOntologyID(OWLOntology ont, OWLOntologyID ontologyID, OWLOntologyID newOntologyID) {
        super(ont);
        this.ontologyID = checkNotNull(ontologyID, ONTOLOGY_ID_CANNOT_BE_NULL);
        this.newOntologyID = checkNotNull(newOntologyID, ONTOLOGY_ID_CANNOT_BE_NULL);
    }

    /**
     * Creates a set ontology id change using the ontologyIRI, which will set
     * the ontology id to the new one.
     *
     * @param ont The ontology whose id is to be changed
     * @param ontologyIRI The ontology iri
     */
    public SetOntologyID(OWLOntology ont, IRI ontologyIRI) {
        this(ont, new OWLOntologyID(optional(ontologyIRI), emptyOptional(IRI.class)));
    }

    @Override
    public SetOntologyIDData getChangeData() {
        return new SetOntologyIDData(newOntologyID);
    }

    /**
     * Gets the original ID of the ontology whose URI was changed.
     *
     * @return The original ID
     */
    public OWLOntologyID getOriginalOntologyID() {
        return ontologyID;
    }

    /**
     * @return the new URI - i.e. the URI of the ontology after the change was applied.
     */
    public OWLOntologyID getNewOntologyID() {
        return newOntologyID;
    }

    @Override
    public void accept(OWLOntologyChangeVisitor visitor) {
        visitor.visit(this);
    }

    @Override
    public <O> O accept(OWLOntologyChangeVisitorEx<O> visitor) {
        return visitor.visit(this);
    }

    @Override
    public String toString() {
        return String.format("SetOntologyID(%s OntologyID(%s))", newOntologyID, ontologyID);
    }

    @Override
    public int hashCode() {
        return 57 + ontologyID.hashCode() + newOntologyID.hashCode() * 3;
    }

    @Override
    public boolean equals(@Nullable Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof SetOntologyID)) {
            return false;
        }
        SetOntologyID change = (SetOntologyID) obj;
        return change.ontologyID.equals(ontologyID) && change.newOntologyID.equals(newOntologyID);
    }

    @Override
    public OWLOntologyChange reverseChange() {
        return new SetOntologyID(getOntology(), newOntologyID, getOntology().getOntologyID());
    }
}
