org.n52.io.response.PlatformOutput Maven / Gradle / Ivy

Go to download
/*
 * 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;

import java.util.Collection;

import org.n52.io.geojson.GeoJSONGeometrySerializer;
import org.n52.io.response.dataset.DatasetOutput;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.vividsolutions.jts.geom.Geometry;

/**
 * TODO: JavaDoc
 *
 * @author Henning Bredel
 * @since 2.0.0
 */
public class PlatformOutput extends OutputWithParameters {

    public static final String DATASETS = "datasets";
    public static final String GEOMETRY = "geometry";
    public static final String PLATFORMTYPE = "platformtype";

    private OptionalOutput platformType;

    private OptionalOutput> datasets;

    private OptionalOutput geometry;

    public PlatformOutput() {
    }

    @Override
    public String getHrefBase() {
        String base = super.getHrefBase();
        String suffix = getType().getPlatformType();
        return base != null && base.endsWith(suffix)
                ? base.substring(0, base.lastIndexOf(suffix) - 1)
                : base;
    }

    public String getPlatformType() {
        if (getIfSerialized(platformType) != null) {
            return getType().getPlatformType();
        } else {
            return null;
        }
    }

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

    @JsonIgnore
    public PlatformType getType() {
        PlatformType type = getIfSet(platformType, true);
        return type != null
                ? type
                // stay backward compatible
                : PlatformType.STATIONARY_INSITU;
    }

    @Override
    public PlatformOutput setId(String id) {
        if (getType() != null) {
            super.setId(getType().createId(id));
        }
        return this;
    }

    public Collection getDatasets() {
        return getIfSerializedCollection(datasets);
    }

    public PlatformOutput setDatasets(OptionalOutput> series) {
        this.datasets = series;
        return this;
    }

    @JsonSerialize(using = GeoJSONGeometrySerializer.class)
    public Geometry getGeometry() {
        return getIfSerialized(geometry);
    }

    public PlatformOutput setGeometry(OptionalOutput geometry) {
        this.geometry = geometry;
        return this;
    }

}