org.n52.io.response.dataset.DatasetOutput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spi Show documentation
There is a newer version: 2.0.1-alpha.8
/*
 * Copyright (C) 2013-2019 52°North Initiative for Geospatial Open Source
 * Software 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.io.response.dataset;

import java.util.List;

import org.n52.io.request.IoParameters;
import org.n52.io.response.OptionalOutput;
import org.n52.io.response.ParameterOutput;

import com.fasterxml.jackson.annotation.JsonProperty;

public class DatasetOutput> extends ParameterOutput {

    public static final String VALUE_TYPE = "valuetype";
    public static final String PLATFORM_TYPE = "platformtype";
    public static final String DATASET_PARAMETERS = "parameters";
    public static final String REFERENCE_VALUES = "referencevalues";
    public static final String FIRST_VALUE = "firstvalue";
    public static final String LAST_VALUE = "lastvalue";
    public static final String UOM = "uom";

    private OptionalOutput valueType;

    private OptionalOutput platformType;

    private OptionalOutput datasetParameters;

    private OptionalOutput>> referenceValues;

    private OptionalOutput firstValue;

    private OptionalOutput lastValue;

    private OptionalOutput uom;

    protected DatasetOutput() {
        // use static constructor method
    }

    public static > DatasetOutput create(String type, IoParameters params) {
        DatasetOutput output = new DatasetOutput<>();
        output.setValue(VALUE_TYPE, type, params, output::setValueType);
        return output;
    }

    @Override
    public DatasetOutput setId(String id) {
        String type = getIfSet(valueType, true);
        super.setId(ValueType.createId(type, id));
        return this;
    }

    public String getValueType() {
        return getIfSerialized(valueType);
    }

    protected void setValueType(OptionalOutput valueType) {
        this.valueType = valueType;
    }

    public String getPlatformType() {
        return getIfSerialized(platformType);
    }

    public DatasetOutput setPlatformType(OptionalOutput platformType) {
        this.platformType = platformType;
        return this;
    }

    @JsonProperty("parameters")
    public DatasetParameters getDatasetParameters() {
        return getDatasetParameters(false);
    }

    public DatasetParameters getDatasetParameters(boolean forced) {
        return getIfSet(datasetParameters, forced);
    }

    public DatasetOutput setDatasetParameters(OptionalOutput parameters) {
        this.datasetParameters = parameters;
        return this;
    }

    public String getUom() {
        return getIfSerialized(uom);
    }

    public DatasetOutput setUom(OptionalOutput uom) {
        this.uom = uom;
        return this;
    }

    public V getFirstValue() {
        return getIfSerialized(firstValue);
    }

    public DatasetOutput setFirstValue(OptionalOutput firstValue) {
        this.firstValue = firstValue;
        return this;
    }

    public V getLastValue() {
        return getIfSerialized(lastValue);
    }

    public DatasetOutput setLastValue(OptionalOutput lastValue) {
        this.lastValue = lastValue;
        return this;
    }

    public List> getReferenceValues() {
        return getIfSerializedCollection(referenceValues);
    }

    public DatasetOutput setReferenceValues(OptionalOutput>> referenceValues) {
        this.referenceValues = referenceValues;
        return this;
    }
}