org.coode.owlapi.rdf.model.RDFResourceNode 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, 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.coode.owlapi.rdf.model;

import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.NodeID;

/**
 * @author Matthew Horridge, The University Of Manchester, Bio-Health
 *         Informatics Group, Date: 06-Dec-2006
 */
public class RDFResourceNode extends RDFNode implements Comparable {

    private final IRI iri;
    private final int anonId;
    private final boolean isIndividual;
    private final boolean forceIdOutput;

    /**
     * Constructs a named resource (i.e. a resource with a IRI).
     * 
     * @param iri
     *        the IRI
     */
    public RDFResourceNode(IRI iri) {
        this.iri = iri;
        anonId = 0;
        isIndividual = false;
        forceIdOutput = false;
    }

    /**
     * Constructs an anonymous node, which has the specified ID.
     * 
     * @param anonId
     *        The id of the node
     */
    public RDFResourceNode(int anonId, boolean isIndividual, boolean forceId) {
        this.anonId = anonId;
        this.isIndividual = isIndividual;
        iri = null;
        forceIdOutput = forceId;
    }

    public boolean isIndividual() {
        return isIndividual;
    }

    public boolean shouldOutputId() {
        return forceIdOutput;
    }

    @Override
    public IRI getIRI() {
        return iri;
    }

    /**
     * @return id
     */
    public int getId() {
        return anonId;
    }

    @Override
    public boolean isLiteral() {
        return false;
    }

    @Override
    public boolean isAnonymous() {
        return iri == null;
    }

    @Override
    public int hashCode() {
        int hashCode = 17;
        hashCode = hashCode * 37 + (iri == null ? anonId : iri.hashCode());
        return hashCode;
    }

    @Override
    public boolean equals(Object obj) {
        if (!(obj instanceof RDFResourceNode)) {
            return false;
        }
        RDFResourceNode other = (RDFResourceNode) obj;
        if (iri != null) {
            if (other.iri != null) {
                return other.iri.equals(iri);
            } else {
                return false;
            }
        } else {
            return other.anonId == anonId;
        }
    }

    @Override
    public String toString() {
        return iri != null ? "<" + iri.toString() + ">" : NodeID
            .nodeString(anonId);
    }

    /**
     * @return a comparable id for this node
     */
    protected Comparable id() {
        return iri != null ? iri : anonId;
    }

    @Override
    public int compareTo(RDFNode b) {
        if (b.isLiteral()) {
            return 1;
        }
        if (equals(b)) {
            return 0;
        }
        int diff = 0;
        boolean anonA = isAnonymous();
        boolean anonB = b.isAnonymous();
        if (anonA == anonB) {
            // if both are anonymous or both are not anonymous,
            // comparing the id() values corresponds to comparing IRIs or
            // comparing bnode ids
            diff = id().compareTo(((RDFResourceNode) b).id());
        } else {
            // if one is anonymous and the other is not,
            // named nodes come first
            if (!anonA) {
                diff = -1;
            } else {
                diff = 1;
            }
        }
        return diff;
    }
}