org.semanticweb.owlapi.io.StringDocumentSource 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.io;

import java.io.InputStream;
import java.io.Reader;
import java.io.StringReader;
import java.util.concurrent.atomic.AtomicInteger;

import org.semanticweb.owlapi.formats.OWLOntologyFormatFactory;
import org.semanticweb.owlapi.formats.OWLOntologyFormatFactoryRegistry;
import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.OWLRuntimeException;


/**
 * Author: Matthew Horridge

 * The University Of Manchester

 * Bio-Health Informatics Group

 * Date: 24-Apr-2007


 * 
 * An ontology input source that wraps a string.
 */
public class StringDocumentSource implements OWLOntologyDocumentSource {

    private static final AtomicInteger counter = new AtomicInteger(0);

    private final IRI documentIRI;

    private final String string;

    private OWLOntologyFormatFactory format;

    /**
     * @param string the source string
     */
    public StringDocumentSource(String string) {
        this(string, getNextDocumentIRI());
    }
    
    /**
     * @param string the source string
     */
    public StringDocumentSource(String string, OWLOntologyFormatFactory format) {
        this(string, getNextDocumentIRI(), format);
    }
    
    
    /**
     * @param string the source string
     */
    public StringDocumentSource(String string, String mimeType) {
        this(string, getNextDocumentIRI(), mimeType);
    }
    
    
    /**
     * @return a fresh IRI
     */
    public static IRI getNextDocumentIRI() {
        return IRI.create( "string:ontology" + counter.incrementAndGet());
    }



    /**
     * Specifies a string as an ontology document.
     * @param string The string
     * @param documentIRI The document IRI
     */
    public StringDocumentSource(String string, IRI documentIRI) {
        this.string = string;
        this.documentIRI = documentIRI;
    }


    /**
     * Specifies a string as an ontology document.
     * @param string The string
     * @param documentIRI The document IRI
     */
    public StringDocumentSource(String string, IRI documentIRI, OWLOntologyFormatFactory format) {
        this(string, documentIRI);
        this.format = format;
    }


    /**
     * Specifies a string as an ontology document.
     * @param string The string
     * @param documentIRI The document IRI
     */
    public StringDocumentSource(String string, IRI documentIRI, String mimeType) {
        this(string, documentIRI);
        OWLOntologyFormatFactory formatFactory = OWLOntologyFormatFactoryRegistry.getInstance().getByMIMEType(mimeType);
        
        if(formatFactory != null) {
            this.format = formatFactory;
        }
    }

    @Override
    public boolean isReaderAvailable() {
        return true;
    }


    @Override
    public Reader getReader() {
        return new StringReader(string);
    }


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


    @Override
    public InputStream getInputStream() {
        throw new OWLRuntimeException("InputStream not available.  Check with StringDocumentSource.isInputStreamAvailable() first!");
    }


    @Override
    public IRI getDocumentIRI() {
        return documentIRI;
    }

    @Override
    public OWLOntologyFormatFactory getFormatFactory() {
        return this.format;
    }

    @Override
    public boolean isFormatKnown() {
        return this.format != null;
    }
}