org.semanticweb.owlapi.io.GZipStreamDocumentSource 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.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.util.zip.GZIPInputStream;

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

/** Author: Matthew Horridge

 * The University Of Manchester

 * Bio-Health Informatics Group

 * Date: 15-Nov-2007

 * 

 * An ontology document source which can read from a stream. */
public class GZipStreamDocumentSource implements OWLOntologyDocumentSource {
    private static int counter = 0;
    private final IRI documentIRI;
    private final File file;
    private final OWLOntologyFormatFactory format;

    /** Constructs an input source which will read an ontology from a
     * representation from the specified stream.
     * 
     * @param is
     *            The stream that the ontology representation will be read from. */
    public GZipStreamDocumentSource(File is) {
        this(is, getNextDocumentIRI(), null);
    }

    /** Constructs an input source which will read an ontology from a
     * representation from the specified stream.
     * 
     * @param is
     *            The stream that the ontology representation will be read from. */
    public GZipStreamDocumentSource(File is, OWLOntologyFormatFactory format) {
        this(is, getNextDocumentIRI(), format);
    }

    /** @return a fresh IRI */
    public static synchronized IRI getNextDocumentIRI() {
        counter = counter + 1;
        return IRI.create("gzipinputstream:ontology" + counter);
    }

    /** Constructs an input source which will read an ontology from a
     * representation from the specified stream.
     * 
     * @param stream
     *            The stream that the ontology representation will be read from.
     * @param documentIRI
     *            The document IRI */
    public GZipStreamDocumentSource(File stream, IRI documentIRI) {
        this(stream, documentIRI, null);
    }

    /** Constructs an input source which will read an ontology from a
     * representation from the specified stream.
     * 
     * @param stream
     *            The stream that the ontology representation will be read from.
     * @param documentIRI
     *            The document IRI */
    public GZipStreamDocumentSource(File stream, IRI documentIRI, OWLOntologyFormatFactory format) {
        this.documentIRI = documentIRI;
        file = stream;
        this.format = format;
    }

    @Override
    public boolean isInputStreamAvailable() {
        return file.exists();
    }

    @Override
    public InputStream getInputStream() {
        try {
            return new GZIPInputStream(new FileInputStream(file));
        } catch (FileNotFoundException e) {
            throw new OWLRuntimeException(
                    "File not found - check that the input stream is available before calling this method.");
        } catch (IOException e) {
            throw new OWLRuntimeException(e);
        }
    }

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

    @Override
    public Reader getReader() {
        try {
            return new InputStreamReader(getInputStream(), "UTF-8");
        } catch (UnsupportedEncodingException e) {
            // will never happen though - UTF-8 is always supported
            throw new OWLRuntimeException(e);
        }
    }

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

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