org.mycore.datamodel.metadata.MCRMetaSpatial Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.datamodel.metadata;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import java.util.stream.Collectors;

import org.jdom2.Element;
import org.mycore.common.MCRException;

import com.google.gson.JsonArray;
import com.google.gson.JsonObject;

/**
 * Stores spatial information for geographic references. The latitude longitude values are stored in an array list,
 * where two BigDecimal build a point.
 *
 * @author Matthias Eichner
 * @author Jens Kupferschmidt
 */
public class MCRMetaSpatial extends MCRMetaDefault {

    private List data;

    /**
     * initializes with empty values.
     */
    public MCRMetaSpatial() {
        super();
        this.data = new ArrayList<>();
    }

    @Deprecated
    public MCRMetaSpatial(String subtag, String defaultLanguage, String type, Integer inherited) throws MCRException {
        super(subtag, defaultLanguage, type, inherited);
        this.data = new ArrayList<>();
    }

    /**
     * The constructor for a MCRMetaSpatial instance with an empty data container.
     * @param subtag the name of the subtag
     * @param type an optional type or an empty string
     * @param inherited a value >= 0
     * 
     * @throws MCRException if the set_subtag value is null or empty
     */
    public MCRMetaSpatial(String subtag, String type, Integer inherited) throws MCRException {
        super(subtag, null, type, inherited);
        this.data = new ArrayList<>();
    }

    /**
     * Returns the spatial data. Two entries build a point. The first is always the latitude and the second one
     * is always the longitude value.
     *
     * @return list of the spatial data
     */
    public List getData() {
        return this.data;
    }

    public void setData(List data) {
        this.data = data;
    }

    /**
     * Adds a new point to the data.
     *
     * @param lat the latitude value
     * @param lng the longitude value
     */
    public void add(BigDecimal lat, BigDecimal lng) {
        this.data.add(lat);
        this.data.add(lng);
    }

    @Override
    public void setFromDOM(Element element) throws MCRException {
        super.setFromDOM(element);
        String textData = element.getText();
        String[] splitData = textData.split(",");
        if (splitData.length % 2 != 0) {
            throw new MCRException(String.format(Locale.ROOT,
                "Unable to parse MCRMetaSpatial cause text data '%s' contains invalid content", textData));
        }
        try {
            Arrays.stream(splitData).map(BigDecimal::new).forEach(this.data::add);
        } catch (NumberFormatException nfe) {
            throw new MCRException(String.format(Locale.ROOT,
                "Unable to parse MCRMetaSpatial cause text data '%s' contains invalid content", textData), nfe);
        }
    }

    @Override
    public Element createXML() throws MCRException {
        Element element = super.createXML();
        return element.setText(this.data.stream().map(BigDecimal::toPlainString).collect(Collectors.joining(",")));
    }

    /**
     * Creates the JSON representation. Extends the {@link MCRMetaDefault#createJSON()} method
     * with the following data.
     *
     *      *   {
     *     data: [50.92878, 11.5899]
     *   }
     * 
     *
     */
    @Override
    public JsonObject createJSON() {
        JsonObject json = super.createJSON();
        JsonArray dataArray = new JsonArray();
        this.data.forEach(dataArray::add);
        json.add("data", dataArray);
        return json;
    }

    @Override
    public void validate() throws MCRException {
        super.validate();
        if (this.data.isEmpty()) {
            throw new MCRException("spatial list should contain content");
        }
        if (this.data.size() % 2 != 0) {
            throw new MCRException(
                String.format(Locale.ROOT, "spatial list content '%s' is uneven", this.data.toString()));
        }
    }

    /**
     * clone of this instance
     * 
     * you will get a (deep) clone of this element
     * 
     * @see java.lang.Object#clone()
     */
    @Override
    public MCRMetaSpatial clone() {
        MCRMetaSpatial clone = (MCRMetaSpatial) super.clone();

        clone.data = new ArrayList<>(this.data); // Big Integer is immutable

        return clone;
    }

}