nknize commented on a change in pull request #726: LUCENE-8632: New XYShape Field and Queries for indexing and searching general cartesian geometries URL: https://github.com/apache/lucene-solr/pull/726#discussion_r297775614
########## File path: lucene/sandbox/src/java/org/apache/lucene/document/XYShape.java ########## @@ -0,0 +1,101 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF 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. + */ +package org.apache.lucene.document; + +import java.util.ArrayList; +import java.util.List; + +import org.apache.lucene.geo.Tessellator; +import org.apache.lucene.index.PointValues; // javadoc +import org.apache.lucene.geo.XYLine; +import org.apache.lucene.geo.XYPolygon; +import org.apache.lucene.search.Query; + +import static org.apache.lucene.geo.XYEncodingUtils.encode; + +/** + * A cartesian shape utility class for indexing and searching geometries whose vertices are unitless x, y values. + * <p> + * This class defines six static factory methods for common indexing and search operations: + * <ul> + * <li>{@link #createIndexableFields(String, XYPolygon)} for indexing a cartesian polygon. + * <li>{@link #createIndexableFields(String, XYLine)} for indexing a cartesian linestring. + * <li>{@link #createIndexableFields(String, double, double)} for indexing a x, y cartesian point. + * <li>{@link #newBoxQuery newBoxQuery()} for matching cartesian shapes that have some {@link QueryRelation} with a bounding box. + * <li>{@link #newBoxQuery newLineQuery()} for matching cartesian shapes that have some {@link QueryRelation} with a linestring. + * <li>{@link #newBoxQuery newPolygonQuery()} for matching cartesian shapes that have some {@link QueryRelation} with a polygon. + * </ul> + + * <b>WARNING</b>: Like {@link LatLonPoint}, vertex values are indexed with some loss of precision from the + * original {@code double} values. + * @see PointValues + * @see LatLonDocValuesField + * + * @lucene.experimental + */ +public class XYShape extends ShapeField { Review comment: We sure don't. Fixed. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
