org.semanticweb.owlapi.model.OWLOntologyStorerFactoryRegistry 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.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.semanticweb.owlapi.formats.OWLOntologyFormatFactory;

import com.github.ansell.abstractserviceloader.AbstractServiceLoader;


/**
 * Author: Matthew Horridge

 * The University Of Manchester

 * Bio-Health Informatics Group

 * Date: 15-Nov-2006


 * 
 * The OWLOntologyStorerFactory provides a central point for
 * the registration of storer factories that create storers to store OWL
 * ontologies.  The registry is typically used by at least one type of ontology
 * factory for storing ontologies whose concrete representations are to be 
 * contained in some kind of document.
 */
public class OWLOntologyStorerFactoryRegistry extends AbstractServiceLoader {

    private static final OWLOntologyStorerFactoryRegistry instance = new OWLOntologyStorerFactoryRegistry();

    public OWLOntologyStorerFactoryRegistry() {
        super(OWLOntologyStorerFactory.class);
    }


    /**@return the storer factory registry*/
    public static OWLOntologyStorerFactoryRegistry getInstance() {
        return instance;
    }


    /**
     * clear all registered storer factories
     */
    public void clearStorerFactories() {
        this.clear();
    }


    /**
     * @return the list of storers - changes will not be backed by the factory
     */
    public List getStorerFactories() {
        return new ArrayList(this.getAll());
    }

    /**
     * Return an OWLOntologyStorerFactory matching the given OWLOntologyFormat.
     * @param key
     * @return
     */
    public OWLOntologyStorerFactory getStorerFactory(OWLOntologyFormatFactory key)
    {
        Collection collection = this.get(key);
        
        if(collection.isEmpty())
        {
            return null;
        }
        else
        {
            return collection.iterator().next();
        }
    }
    
    /**
     * @param storerFactory the storer factory to register
     */
    public void registerStorerFactory(OWLOntologyStorerFactory storerFactory) {
        this.add(storerFactory);
    }


    /**
     * @param storerFactory the storer factory to remove
     */
    public void unregisterStorerFactory(OWLOntologyStorerFactory storerFactory) {
        this.remove(storerFactory);
    }


    @Override
    public OWLOntologyFormatFactory getKey(OWLOntologyStorerFactory service) {
        return service.getFormatFactory();
    }
}