apache / apache/lucene

Simplify API for Geo3DPoint when performing a polygon query [LUCENE-8576]

Open
#9,622 0 comments 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Minor module:spatial3d type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

We currently have two ways for polygon queries when using Geo3DPoint, newPolygonQuery and newLargePolygonQuery. This is due to the fact that there are two implementation for creating polygons in spatial3d.

In #9267, it was added a new polygon factory method that chooses the best polygon implementation to use depending on the provided polygon. We could simplify the interface by using this factory method in newPolygonQuery and probably deprecate newLargePolygonQuery.

---
Migrated from [LUCENE-8576](https://issues.apache.org/jira/browse/LUCENE-8576) by Ignacio Vera (@iverase)

Contributor guide

Open the contributing guide

Research direction

Start with the Geo3DPoint polygon-query entry points newPolygonQuery and newLargePolygonQuery, then review the polygon factory method introduced in #9267. Determine how the factory selects an implementation and define the compatible API change, including whether newLargePolygonQuery should be deprecated. Done means the simplified interface uses the factory correctly and existing polygon-query behavior remains covered by the project's tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
search
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.