src.gov.nasa.worldwind.ogc.kml.io.KMLFile Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of worldwindx Show documentation

World Wind is a collection of components that interactively display 3D geographic information within Java applications or applets.

There is a newer version: 2.0.0-986

Show newest version

/*
 * Copyright (C) 2012 United States Government as represented by the Administrator of the
 * National Aeronautics and Space Administration.
 * All Rights Reserved.
 */

package gov.nasa.worldwind.ogc.kml.io;

import gov.nasa.worldwind.util.Logging;

import java.io.*;

/**
 * Implements the {@link KMLDoc} interface for KML files located within a computer's file system.
 * 
 * Note: This class does not resolve references to files in KMZ archives. For example, it does not resolve references
 * like this: ../other.kmz/file.png.
 *
 * @author tag
 * @version $Id: KMLFile.java 1171 2013-02-11 21:45:02Z dcollins $
 */
public class KMLFile implements KMLDoc
{
    /** The {@link File} reference specified to the constructor. */
    protected File kmlFile;

    /**
     * Construct a KMLFile instance.
     *
     * @param file path to the KML file.
     *
     * @throws IllegalArgumentException if the specified file is null.
     */
    public KMLFile(File file)
    {
        if (file == null)
        {
            String message = Logging.getMessage("nullValue.FileIsNull");
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }

        this.kmlFile = file;
    }

    /**
     * Returns the {@link File} specified to the constructor.
     *
     * @return the file specified to the constructor.
     */
    public File getZipFile()
    {
        return this.kmlFile;
    }

    /**
     * Returns an {@link InputStream} to the KML file.
     *
     * @return an input stream positioned to the start of the KML file.
     *
     * @throws IOException if an error occurs attempting to create the input stream.
     */
    public InputStream getKMLStream() throws IOException
    {
        return new FileInputStream(this.kmlFile);
    }

    /**
     * Returns an {@link InputStream} to a file indicated by a path relative to the KML file's location.
     *
     * @param path the path of the requested file.
     *
     * @return an input stream positioned to the start of the file, or null if the file does not exist.
     *
     * @throws IOException if an error occurs while attempting to query or open the file.
     */
    public InputStream getSupportFileStream(String path) throws IOException
    {
        if (path == null)
        {
            String message = Logging.getMessage("nullValue.FilePathIsNull");
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }

        File pathFile = new File(path);
        if (pathFile.isAbsolute())
            return null;

        pathFile = new File(this.kmlFile.getParentFile(), path);

        return pathFile.exists() ? new FileInputStream(pathFile) : null;
    }

    public String getSupportFilePath(String path)
    {
        if (path == null)
        {
            String message = Logging.getMessage("nullValue.FilePathIsNull");
            Logging.logger().severe(message);
            throw new IllegalArgumentException(message);
        }

        File pathFile = new File(path);
        if (pathFile.isAbsolute())
            return null;

        pathFile = new File(this.kmlFile.getParentFile(), path);

        return pathFile.exists() ? pathFile.getPath() : null;
    }
}