/* * 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.common.geo.builders; import org.opensearch.core.ParseField; import org.opensearch.common.geo.GeoShapeType; import org.opensearch.common.geo.parsers.ShapeParser; import org.locationtech.spatial4j.shape.Circle; import org.locationtech.jts.geom.Coordinate; import org.opensearch.core.common.io.stream.StreamInput; import org.opensearch.core.common.io.stream.StreamOutput; import org.opensearch.common.unit.DistanceUnit; import org.opensearch.common.unit.DistanceUnit.Distance; import org.opensearch.core.xcontent.XContentBuilder; import java.io.IOException; import java.util.Objects; /** * Builds a circle geometry * * @opensearch.internal */ public class CircleBuilder extends ShapeBuilder { public static final ParseField FIELD_RADIUS = new ParseField("radius"); public static final GeoShapeType TYPE = GeoShapeType.CIRCLE; private DistanceUnit unit = DistanceUnit.DEFAULT; private double radius; private Coordinate center; /** * Creates a circle centered at [0.0, 0.0]. * Center can be changed by calling {@link #center(Coordinate)} later. */ public CircleBuilder() { this.center = ZERO_ZERO; } /** * Read from a stream. */ public CircleBuilder(StreamInput in) throws IOException { center(readFromStream(in)); radius(in.readDouble(), DistanceUnit.readFromStream(in)); } @Override public void writeTo(StreamOutput out) throws IOException { writeCoordinateTo(center, out); out.writeDouble(radius); unit.writeTo(out); } /** * Set the center of the circle * * @param center coordinate of the circles center * @return this */ public CircleBuilder center(Coordinate center) { this.center = center; return this; } /** * set the center of the circle * @param lon longitude of the center * @param lat latitude of the center * @return this */ public CircleBuilder center(double lon, double lat) { return center(new Coordinate(lon, lat)); } /** * Get the center of the circle */ public Coordinate center() { return center; } /** * Set the radius of the circle. The String value will be parsed by {@link DistanceUnit} * @param radius Value and unit of the circle combined in a string * @return this */ public CircleBuilder radius(String radius) { return radius(DistanceUnit.Distance.parseDistance(radius)); } /** * Set the radius of the circle * @param radius radius of the circle (see {@link org.opensearch.common.unit.DistanceUnit.Distance}) * @return this */ public CircleBuilder radius(Distance radius) { return radius(radius.value, radius.unit); } /** * Set the radius of the circle * @param radius value of the circles radius * @param unit unit name of the radius value (see {@link DistanceUnit}) * @return this */ public CircleBuilder radius(double radius, String unit) { return radius(radius, DistanceUnit.fromString(unit)); } /** * Set the radius of the circle * @param radius value of the circles radius * @param unit unit of the radius value (see {@link DistanceUnit}) * @return this */ public CircleBuilder radius(double radius, DistanceUnit unit) { this.unit = unit; this.radius = radius; return this; } /** * Get the radius of the circle without unit */ public double radius() { return this.radius; } /** * Get the radius unit of the circle */ public DistanceUnit unit() { return this.unit; } @Override public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { builder.startObject(); builder.field(ShapeParser.FIELD_TYPE.getPreferredName(), TYPE.shapeName()); builder.field(FIELD_RADIUS.getPreferredName(), unit.toString(radius)); builder.field(ShapeParser.FIELD_COORDINATES.getPreferredName()); toXContent(builder, center); return builder.endObject(); } @Override public Circle buildS4J() { return SPATIAL_CONTEXT.makeCircle(center.x, center.y, 360 * radius / unit.getEarthCircumference()); } @Override public org.opensearch.geometry.Circle buildGeometry() { return new org.opensearch.geometry.Circle(center.x, center.y, unit.toMeters(radius)); } @Override public GeoShapeType type() { return TYPE; } @Override public String toWKT() { throw new UnsupportedOperationException("The WKT spec does not support CIRCLE geometry"); } public int numDimensions() { return Double.isNaN(center.z) ? 2 : 3; } @Override public int hashCode() { return Objects.hash(center, radius, unit.ordinal()); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj == null || getClass() != obj.getClass()) { return false; } CircleBuilder other = (CircleBuilder) obj; return Objects.equals(center, other.center) && Objects.equals(radius, other.radius) && Objects.equals(unit.ordinal(), other.unit.ordinal()); } }