org.semanticweb.owlapi.change.SetOntologyIDData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of owlapi-distribution Show documentation
There is a newer version: 5.5.1
/*
 * This file is part of the OWL API.
 *  
 * The contents of this file are subject to the LGPL License, Version 3.0.
 *
 * Copyright (C) 2011, 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.
 *
 * Copyright 2011, The University of Manchester
 *  
 * 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.change;

import java.util.Collections;
import java.util.Set;

import org.semanticweb.owlapi.model.OWLEntity;
import org.semanticweb.owlapi.model.OWLOntology;
import org.semanticweb.owlapi.model.OWLOntologyID;
import org.semanticweb.owlapi.model.SetOntologyID;

/**
 * Represents the specific non-ontology data required by a
 * {@link org.semanticweb.owlapi.model.SetOntologyID} change. 

 * Instances of this class are immutable.
 * 
 * @author Matthew Horridge, Stanford University, Bio-Medical Informatics
 *         Research Group, Date: 27/04/2012
 * @since 3.5
 */
public final class SetOntologyIDData extends OWLOntologyChangeData {

    private static final long serialVersionUID = 30406L;
    private final OWLOntologyID newId;

    /**
     * Constructs a {@link SetOntologyIDData} object that describes an
     * {@link SetOntologyID} change for the {@link OWLOntologyID} object
     * specified by the {@code newId} parameter.
     * 
     * @param newId
     *        The {@link OWLOntologyID} that is the focus of some change. Not
     *        {@code null}.
     * @throws NullPointerException
     *         if {@code ontologyId} is {@code null}.
     */
    public SetOntologyIDData(OWLOntologyID newId) {
        if (newId == null) {
            throw new NullPointerException("newId must not be null");
        }
        this.newId = newId;
    }

    /**
     * Gets the {@link OWLOntologyID} that is associated with some
     * {@link SetOntologyID} change.
     * 
     * @return The {@link OWLOntologyID}. Not {@code null}.
     */
    public OWLOntologyID getNewId() {
        return newId;
    }

    /**
     * Creates the {@link org.semanticweb.owlapi.model.SetOntologyID} change
     * that describes setting an
     * {@link org.semanticweb.owlapi.model.OWLOntologyID} for an
     * {@link OWLOntology} specified by the {@code ontology} parameter.
     * 
     * @param ontology
     *        The {@link OWLOntology} that the change should apply to. Not
     *        {@code null}.
     * @return The {@link org.semanticweb.owlapi.model.SetOntologyID} change for
     *         the {@link OWLOntology} specified by {@code ontology} and the
     *         {@link org.semanticweb.owlapi.model.OWLOntologyID} associated
     *         with this {@link SetOntologyIDData} object.
     * @throws NullPointerException
     *         if {@code ontology} is {@code null}.
     */
    @Override
    public SetOntologyID createOntologyChange(OWLOntology ontology) {
        if (ontology == null) {
            throw new NullPointerException("ontology must not be null");
        }
        return new SetOntologyID(ontology, newId);
    }

    @Override
    public Set getSignature() {
        return Collections.emptySet();
    }

    @Override
    public  O accept(
            OWLOntologyChangeDataVisitor visitor) throws E {
        return visitor.visit(this);
    }

    @Override
    public int hashCode() {
        return "SetOntologyIDData".hashCode() + newId.hashCode();
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == this) {
            return true;
        }
        if (!(obj instanceof SetOntologyIDData)) {
            return false;
        }
        SetOntologyIDData other = (SetOntologyIDData) obj;
        return newId.equals(other.newId);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("SetOntologyIDData");
        sb.append("(OntologyId(");
        sb.append(newId);
        sb.append("))");
        return sb.toString();
    }
}