org.semanticweb.owlapi.model.OWLOntologyFormat Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of owlapi-api Show documentation
The newest version!
/*
 * 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.semanticweb.owlapi.model;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

import org.semanticweb.owlapi.io.OWLOntologyLoaderMetaData;
import org.semanticweb.owlapi.vocab.PrefixOWLOntologyFormat;

/**
 * Author: Matthew Horridge

 * The University Of Manchester

 * Bio-Health Informatics Group

 * Date: 02-Jan-2007


 *
 * Represents the concrete representation format of
 * an ontology.  The equality of an ontology format
 * is defined by the equals and hashCode method (not
 * its identity).
 */
public abstract class OWLOntologyFormat implements Comparable, Serializable {
    private static final long serialVersionUID = 30406L;

    /** if set to "true", an intermediate file will be used for output, even for
     * remote URIs */
    public static String USE_INTERMEDIATE_OUTPUT_FILE = "USE_INTERMEDIATE_OUTPUT_FILE";

    private static final int BEFORE = -1;
    private static final int EQUALS = 0;
    private static final int AFTER = 1;
    
    private Map paramaterMap;

    private OWLOntologyLoaderMetaData loaderMetaData = new NullLoaderMetaData();

    private Map getParameterMap() {
        if(paramaterMap == null) {
            paramaterMap = new HashMap();
        }
        return paramaterMap;
    }

    /**
     * @param key key for the new entry
     * @param value value for the new entry
     */
    public void setParameter(Object key, Object value) {
        getParameterMap().put(key, value);
    }

    /**
     * @param key key for the new entry
     * @param defaultValue value for the new entry
     * @return the value
     */
    public Object getParameter(Object key, Object defaultValue) {
        Object val = getParameterMap().get(key);
        if(val != null) {
            return val;
        }
        else {
            return defaultValue;
        }
    }

    /**
     * If this format describes an ontology that was loaded from some ontology document (rather than created programmatically)
     * there may be some meta data about the loading process.  Subclasses of OWLOntologyFormat will provide
     * accessors etc. to details pertaining to the meta data about loading.
     * @return An object containing the meta data about loading.  Not null.
     */
    public OWLOntologyLoaderMetaData getOntologyLoaderMetaData() {
        return loaderMetaData;
    }

    /**
     * Sets the meta data for the ontology loader.
     * @param loaderMetaData The metadata. Must not be null.
     * @throws NullPointerException if the loaderMetaData is null.
     */
    public void setOntologyLoaderMetaData(OWLOntologyLoaderMetaData loaderMetaData) {
        this.loaderMetaData = loaderMetaData;
    }

    /**
     * 
     * @return A unique key for this format.
     */
    public abstract String getKey();
    
    /**
     * Determines whether this format contains textual output, as opposed to binary output.
     * 
     * @return True if this format represents a textual format, as opposed to a binary format. Defaults to true if not overridden.
     */
    public boolean isTextual() {
        return true;
    }
    
    /* (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return this.getKey().hashCode();
    }

    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(Object obj) {
        if(obj == null) {
            return false;
        }
        
        if(this == obj) {
            return true;
        }
        
        if(!(obj instanceof OWLOntologyFormat)) {
            return false;
        }
        OWLOntologyFormat other = (OWLOntologyFormat)obj;
        return this.getKey().equals(other.getKey());
    }

    @Override
    public int compareTo(OWLOntologyFormat other) {
        if(other == null) {
            return AFTER;
        } else if(this.getKey() == null) {
            if(other.getKey() == null) {
                return EQUALS;
            } else {
                return BEFORE;
            }
        } else {
            return this.getKey().compareTo(other.getKey());
        }
    }

    private static class NullLoaderMetaData implements OWLOntologyLoaderMetaData,
            Serializable {
        private static final long serialVersionUID = 30406L;
        public NullLoaderMetaData() {}
    }

    /**
     * 
     * @return
     * @deprecated Use a standard Java cast instead of this method.
     */
    @Deprecated
    public PrefixOWLOntologyFormat asPrefixOWLOntologyFormat() {
        if(this instanceof PrefixOWLOntologyFormat) {
            return (PrefixOWLOntologyFormat)this;
        } else {
            throw new ClassCastException("Not a Prefix OWL Ontology Format. Check first using instanceof.");
        }
    }

    /**
     * 
     * @return
     * @deprecated Use Java instanceof keyword instead of this method.
     */
    @Deprecated
    public boolean isPrefixOWLOntologyFormat() {
        return this instanceof PrefixOWLOntologyFormat;
    }
}