org.n52.sos.netcdf.NetcdfHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sos-api-netcdf Show documentation
52°North Sensor Observation Service OceanSITES netCDF Coding
There is a newer version: 6.0.1
/*
 * Copyright (C) 2012-2022 52°North Spatial Information Research GmbH
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published
 * by the Free Software Foundation.
 *
 * If the program is linked with libraries which are licensed under one of
 * the following licenses, the combination of the program with the linked
 * library is not considered a "derivative work" of the program:
 *
 *     - Apache License, version 2.0
 *     - Apache Software License, version 1.0
 *     - GNU Lesser General Public License, version 3
 *     - Mozilla Public License, versions 1.0, 1.1 and 2.0
 *     - Common Development and Distribution License (CDDL), version 1.0
 *
 * Therefore the distribution of the program linked with libraries licensed
 * under the aforementioned licenses, is permitted by the copyright holders
 * if the distribution is compliant with both the GNU General Public
 * License version 2 and the aforementioned licenses.
 *
 * 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.
 */
package org.n52.sos.netcdf;

import java.util.Collections;
import java.util.Set;

import javax.naming.ConfigurationException;

import org.n52.faroe.ConfigurationError;
import org.n52.faroe.annotation.Configurable;
import org.n52.faroe.annotation.Setting;
import org.n52.shetland.iso.CodeList.CiRoleCodes;

import com.axiomalaska.cf4j.CFStandardName;
import com.axiomalaska.cf4j.CFStandardNames;
import com.google.common.base.Strings;
import com.google.common.collect.Sets;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import ucar.nc2.NetcdfFileWriter.Version;

/**
 * Helper class for netCDF encoding. Holds the netCDF setting values.
 *
 * @author Carsten Hollmann
 * @since 4.4.0
 *
 */
@Configurable
@SuppressFBWarnings({"EI_EXPOSE_REP"})
public class NetcdfHelper {

    private Version version;

    private int chunkSizeTime;

    private double fillValue;

    private CFStandardName heightDepth;

    private String variableType;

    private boolean upperCaseNames;

    private CiRoleCodes contributor;

    private CiRoleCodes publisher;

    private Set latitude = Collections.emptySet();

    private Set longitude = Collections.emptySet();

    private Set z = Collections.emptySet();

    /**
     * @param version
     *
     * @throws ConfigurationException if an error occurs
     */
    @Setting(NetcdfSettingsProvider.NETCDF_VERSION)
    public void setNetcdfVersion(String version) throws ConfigurationError {
        this.version = Version.valueOf(version);
    }

    /**
     * @return the version object
     */
    public Version getNetcdfVersion() {
        return version;
    }

    /**
     * @return the version string
     */
    public String getNetcdfVersionString() {
        return version.name();
    }

    /**
     * @param chunkSize the chunk size
     */
    @Setting(NetcdfSettingsProvider.NETCDF_CHUNK_SIZE_TIME)
    public void setChunkSizeTime(int chunkSize) {
        this.chunkSizeTime = chunkSize;
    }

    /**
     * @return the chunk size
     */
    public int getChunkSizeTime() {
        return chunkSizeTime;
    }

    /**
     * @param fillValue the fill value
     */
    @Setting(NetcdfSettingsProvider.NETCDF_FILL_VALUE)
    public void setFillValue(double fillValue) {
        this.fillValue = fillValue;
    }

    /**
     * @return the fill value
     */
    public double getFillValue() {
        return fillValue;
    }

    /**
     * @return the fill value as float
     */
    public float getFillValueAsFloat() {
        return (float) fillValue;
    }

    /**
     * @param heightDepth either {@code height} or {@code depth}
     */
    @Setting(NetcdfSettingsProvider.NETCDF_HEIGHT_DEPTH)
    public void setHeightDepth(String heightDepth) {
        this.heightDepth = getStandardName(heightDepth);
    }

    /**
     * @return the height/depth name
     */
    public CFStandardName getHeightDepth() {
        return heightDepth;
    }

    /**
     * @param heightDepth {@code height} or {@code depth}
     *
     * @return the standard name
     */
    private CFStandardName getStandardName(String heightDepth) {
        if (CFStandardNames.HEIGHT.getName().equals(heightDepth)) {
            return CFStandardNames.HEIGHT;
        }
        return CFStandardNames.DEPTH;
    }

    /**
     * @param type the variable type
     */
    @Setting(NetcdfSettingsProvider.NETCDF_VARIABLE_TYPE)
    public void setVariableType(String type) {
        this.variableType = type;
    }

    /**
     * @return the variable type
     */
    public String getVariableType() {
        return variableType;
    }

    /**
     * @return the upperCaseNames
     */
    public boolean isUpperCaseNames() {
        return upperCaseNames;
    }

    /**
     * @param upperCaseNames the upperCaseNames to set
     */
    @Setting(NetcdfSettingsProvider.NETCDF_VARIABLE_UPPER_CASE)
    public void setUpperCaseNames(boolean upperCaseNames) {
        this.upperCaseNames = upperCaseNames;
    }

    /**
     * @return the contributor
     */
    public CiRoleCodes getContributor() {
        return contributor;
    }

    /**
     * @param contributor the contributor to set
     */
    @Setting(NetcdfSettingsProvider.NETCDF_CONTRIBUTOR)
    public void setContributor(String contributor) {
        this.contributor = CiRoleCodes.valueOf(contributor);
    }

    /**
     * @return the publisher
     */
    public CiRoleCodes getPublisher() {
        return publisher;
    }

    /**
     * @param publisher the publisher to set
     */
    @Setting(NetcdfSettingsProvider.NETCDF_PUBLISHER)
    public void setPublisher(String publisher) {
        this.publisher = CiRoleCodes.valueOf(publisher);
    }

    /**
     * @return the latitude
     */
    public Set getLatitude() {
        return Collections.unmodifiableSet(latitude);
    }

    /**
     * @param latitude the latitude to set
     */
    @Setting(NetcdfSettingsProvider.NETCDF_PHEN_LATITUDE)
    public void setLatitude(String latitude) {
        if (!Strings.isNullOrEmpty(latitude)) {
            this.latitude = Sets.newHashSet(latitude.split(","));
        } else {
            this.latitude.clear();
        }
    }

    /**
     * @return the longitude
     */
    public Set getLongitude() {
        return Collections.unmodifiableSet(longitude);
    }

    /**
     * @param longitude the longitude to set
     */
    @Setting(NetcdfSettingsProvider.NETCDF_PHEN_LONGITUDE)
    public void setLongitude(String longitude) {
        if (!Strings.isNullOrEmpty(longitude)) {
            this.longitude = Sets.newHashSet(longitude.split(","));
        } else {
            this.longitude.clear();
        }
    }

    /**
     * @return the z
     */
    public Set getZ() {
        return Collections.unmodifiableSet(z);
    }

    /**
     * @param z the z to set
     */
    @Setting(NetcdfSettingsProvider.NETCDF_PHEN_Z)
    public void setZ(String z) {
        if (!Strings.isNullOrEmpty(z)) {
            this.z = Sets.newHashSet(z.split(","));
        } else {
            this.z.clear();
        }
    }

}