org.oscim.theme.ExternalRenderTheme Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vtm Show documentation
OpenGL vector map library written in Java - running on Android, iOS, Desktop and within the browser.
There is a newer version: 0.21.0
/*
 * Copyright 2010, 2011, 2012 mapsforge.org
 * Copyright 2013 Hannes Janetzek
 * Copyright 2016-2017 devemux86
 * Copyright 2017 Andrey Novikov
 *
 * This file is part of the OpenScienceMap project (http://www.opensciencemap.org).
 *
 * This program is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program. If not, see .
 */
package org.oscim.theme;

import org.oscim.theme.IRenderTheme.ThemeException;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;

/**
 * An ExternalRenderTheme allows for customizing the rendering style of the map
 * via an XML file.
 */
public class ExternalRenderTheme implements ThemeFile {
    private static final long serialVersionUID = 1L;

    private final long mFileModificationDate;
    private XmlRenderThemeMenuCallback mMenuCallback;
    private final String mPath;

    /**
     * @param fileName the path to the XML render theme file.
     * @throws ThemeException if the file does not exist or cannot be read.
     */
    public ExternalRenderTheme(String fileName) throws ThemeException {
        this(fileName, null);
    }

    /**
     * @param fileName     the path to the XML render theme file.
     * @param menuCallback the interface callback to create a settings menu on the fly.
     * @throws ThemeException if the file does not exist or cannot be read.
     */
    public ExternalRenderTheme(String fileName, XmlRenderThemeMenuCallback menuCallback) throws ThemeException {
        File themeFile = new File(fileName);
        if (!themeFile.exists()) {
            throw new ThemeException("file does not exist: " + themeFile.getAbsolutePath());
        } else if (!themeFile.isFile()) {
            throw new ThemeException("not a file: " + fileName);
        } else if (!themeFile.canRead()) {
            throw new ThemeException("cannot read file: " + fileName);
        }

        mFileModificationDate = themeFile.lastModified();
        if (mFileModificationDate == 0L) {
            throw new ThemeException("cannot read last modification time");
        }
        mPath = fileName;
        mMenuCallback = menuCallback;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        } else if (!(obj instanceof ExternalRenderTheme)) {
            return false;
        }
        ExternalRenderTheme other = (ExternalRenderTheme) obj;
        if (mFileModificationDate != other.mFileModificationDate) {
            return false;
        } else if (mPath == null && other.mPath != null) {
            return false;
        } else if (mPath != null && !mPath.equals(other.mPath)) {
            return false;
        }
        return true;
    }

    @Override
    public XmlRenderThemeMenuCallback getMenuCallback() {
        return mMenuCallback;
    }

    @Override
    public String getRelativePathPrefix() {
        return new File(mPath).getParent();
    }

    @Override
    public InputStream getRenderThemeAsStream() throws ThemeException {
        InputStream is;

        try {
            is = new FileInputStream(mPath);
        } catch (FileNotFoundException e) {
            throw new ThemeException(e.getMessage());
        }
        return is;
    }

    @Override
    public boolean isMapsforgeTheme() {
        return ThemeUtils.isMapsforgeTheme(this);
    }

    @Override
    public void setMenuCallback(XmlRenderThemeMenuCallback menuCallback) {
        mMenuCallback = menuCallback;
    }
}