org.springframework.data.elasticsearch.core.geo.GeoJsonGeometryCollection Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-elasticsearch Show documentation

Spring Data Implementation for Elasticsearch

There is a newer version: 5.3.0

Show newest version

/*
 * Copyright 2015-2020 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
 *
 *      https://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 org.springframework.data.elasticsearch.core.geo;

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

import org.springframework.util.Assert;

/**
 * Defines a {@link GeoJsonGeometryCollection} that consists of a {@link List} of {@link GeoJson} objects.

 * Copied from Spring Data Mongodb
 *
 * @author Christoph Strobl
 * @author Peter-Josef Meisch
 * @since 4.1
 * @see https://geojson.org/geojson-spec.html#geometry-collection
 */
public class GeoJsonGeometryCollection implements GeoJson>> {

	public static final String TYPE = "GeometryCollection";

	private final List> geometries = new ArrayList<>();

	private GeoJsonGeometryCollection(List> geometries) {
		this.geometries.addAll(geometries);
	}

	/**
	 * Creates a new {@link GeoJsonGeometryCollection} for the given {@link GeoJson} instances.
	 *
	 * @param geometries must not be {@literal null}.
	 */
	public static GeoJsonGeometryCollection of(List> geometries) {

		Assert.notNull(geometries, "Geometries must not be null!");

		return new GeoJsonGeometryCollection(geometries);
	}

	@Override
	public String getType() {
		return TYPE;
	}

	@Override
	public Iterable> getCoordinates() {
		return getGeometries();
	}

	public List> getGeometries() {
		return Collections.unmodifiableList(this.geometries);
	}

	@Override
	public boolean equals(Object o) {
		if (this == o)
			return true;
		if (o == null || getClass() != o.getClass())
			return false;

		GeoJsonGeometryCollection that = (GeoJsonGeometryCollection) o;

		return geometries.equals(that.geometries);
	}

	@Override
	public int hashCode() {
		return geometries.hashCode();
	}

	@Override
	public String toString() {
		return "GeoJsonGeometryCollection{" + "geometries=" + geometries + '}';
	}
}