com.digitalbridge.domain.geo.GeoJsonPolygon.java Source code

Introduction

Here is the source code for com.digitalbridge.domain.geo.GeoJsonPolygon.java

Source

/*
 * Copyright 2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.digitalbridge.domain.geo;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.springframework.data.geo.Point;
import org.springframework.data.geo.Polygon;

import com.digitalbridge.util.Constants;

/**
 * {@link com.digitalbridge.domain.geo.GeoJson} representation of {@link org.springframework.data.geo.Polygon}. Unlike
 * {@link org.springframework.data.geo.Polygon} the {@link com.digitalbridge.domain.geo.GeoJsonPolygon} requires a
 * closed border. Which means that the first and last {@link org.springframework.data.geo.Point} have to have same
 * coordinate pairs.
 *
 * @see http://geojson.org/geojson-spec.html#polygon
 * @author rajakolli
 * @version 1:0
 */
public class GeoJsonPolygon extends Polygon implements GeoJson<List<GeoJsonLineString>> {

    private static final long serialVersionUID = 3936163018187247185L;
    private static final String TYPE = "Polygon";

    private List<GeoJsonLineString> coordinates = new ArrayList<GeoJsonLineString>();

    /**
     * Creates new {@link com.digitalbridge.domain.geo.GeoJsonPolygon} from the given
     * {@link org.springframework.data.geo.Point}s.
     *
     * @param first must not be {@literal null}.
     * @param second must not be {@literal null}.
     * @param third must not be {@literal null}.
     * @param fourth must not be {@literal null}.
     * @param others can be {@literal null}.
     */
    public GeoJsonPolygon(Point first, Point second, Point third, Point fourth, final Point... others) {
        this(asList(first, second, third, fourth, others));
    }

    /**
     * Creates new {@link com.digitalbridge.domain.geo.GeoJsonPolygon} from the given
     * {@link org.springframework.data.geo.Point}s.
     *
     * @param points must not be {@literal null}.
     */
    public GeoJsonPolygon(List<Point> points) {

        super(points);
        this.coordinates.add(new GeoJsonLineString(points));
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.core.geo.GeoJson#getType()
     */
    /** {@inheritDoc} */
    @Override
    public String getType() {
        return TYPE;
    }

    /*
     * (non-Javadoc)
     * @see org.springframework.data.mongodb.core.geo.GeoJson#getCoordinates()
     */
    /** {@inheritDoc} */
    @Override
    public List<GeoJsonLineString> getCoordinates() {
        return Collections.unmodifiableList(this.coordinates);
    }

    private static List<Point> asList(Point first, Point second, Point third, Point fourth, final Point... others) {

        List<Point> result = new ArrayList<Point>(Constants.THREE + others.length);

        result.add(first);
        result.add(second);
        result.add(third);
        result.add(fourth);
        result.addAll(Arrays.asList(others));

        return result;
    }
}