org.n52.sos.netcdf.om.NetCDFObservation 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.om;

import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.n52.shetland.ogc.gml.time.TimePeriod;
import org.n52.shetland.ogc.om.OmObservableProperty;
import org.n52.sos.netcdf.data.dataset.AbstractSensorDataset;

import com.google.common.collect.Lists;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

import org.locationtech.jts.geom.Envelope;

import ucar.nc2.constants.CF;

/**
 * An netCDF compatible observation block containing all observations for a
 * feature type.
 *
 * @author Shane StClair
 * @author Carsten Hollmann
 * @since 4.4.0
 *
 */
@SuppressFBWarnings({"EI_EXPOSE_REP", "EI_EXPOSE_REP2"})
public class NetCDFObservation {
    // for metadata block
    private CF.FeatureType featureType;

    private TimePeriod samplingTime = new TimePeriod();

    private Set phenomena = new HashSet();

    private Envelope envelope = new Envelope();

    // for data block
    private Map sensorDatasetMap;

    // constructor
    public NetCDFObservation(CF.FeatureType featureType, TimePeriod samplingTime,
            Map sensorDatasetMap, Set phenomena,
            Envelope envelope) {
        super();
        this.featureType = featureType;
        this.samplingTime = samplingTime;
        this.sensorDatasetMap = sensorDatasetMap;
        this.phenomena = phenomena;
        this.envelope = envelope;
    }

    public CF.FeatureType getFeatureType() {
        return featureType;
    }

    public TimePeriod getSamplingTime() {
        return samplingTime;
    }

    public Map getSensorDatasetMap() {
        return sensorDatasetMap;
    }

    public Set getPhenomena() {
        return Collections.unmodifiableSet(phenomena);
    }

    public Envelope getEnvelope() {
        return envelope;
    }

    public List getSensorDatasets() {
        return Collections.unmodifiableList(Lists.newArrayList(sensorDatasetMap.values()));
    }

}