org.opensearch.geometry.LinearRing Maven / Gradle / Ivy
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you 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.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
package org.opensearch.geometry;
import java.util.Arrays;
/**
* Represents a closed line on the earth's surface in lat/lon decimal degrees and optional altitude in meters.
*
* Cannot be serialized by WKT directly but used as a part of polygon
*/
public class LinearRing extends Line {
public static final LinearRing EMPTY = new LinearRing();
private LinearRing() {}
public LinearRing(double[] x, double[] y) {
this(x, y, null);
}
public LinearRing(double[] x, double[] y, double[] z) {
super(x, y, z);
if (x.length < 2) {
throw new IllegalArgumentException("linear ring cannot contain less than 2 points, found " + x.length);
}
int last = x.length - 1;
if (x[0] != x[last] || y[0] != y[last] || (z != null && z[0] != z[last])) {
throw new IllegalArgumentException(
"first and last points of the linear ring must be the same (it must close itself):"
+ " x[0]="
+ x[0]
+ " x["
+ last
+ "]="
+ x[last]
+ " y[0]="
+ y[0]
+ " y["
+ last
+ "]="
+ y[last]
+ (z == null ? "" : " z[0]=" + z[0] + " z[" + last + "]=" + z[last])
);
}
}
@Override
public ShapeType type() {
return ShapeType.LINEARRING;
}
@Override
public T visit(GeometryVisitor visitor) throws E {
return visitor.visit(this);
}
@Override
public String toString() {
return "linearring(x="
+ Arrays.toString(getX())
+ ", y="
+ Arrays.toString(getY())
+ (hasZ() ? ", z=" + Arrays.toString(getZ()) : "")
+ ")";
}
}