mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 13:08:29 +00:00
732741dd8d
We've had `QueryDSLDocumentationTests` for a while but it had a very hopeful comment at the top about how we want to make sure that the example in the query-dsl docs match up with the test but we never had anything that made *sure* that they did. This changes that! Now the examples from the query-dsl docs are all built from the `QueryDSLDocumentationTests`. All except for the percolator example because that is hard to do as it stands now. To make this easier this change moves `QueryDSLDocumentationTests` from core and into the high level rest client. This is useful for two reasons: 1. We expect the high level rest client to be able to use the builders. 2. The code that builds that docs doesn't check out all of Elasticsearch. It only checks out certain directories. Since we're already including snippets from that directory we don't have to make any changes to that process. Closes #24320
58 lines
2.3 KiB
Plaintext
58 lines
2.3 KiB
Plaintext
[[java-query-dsl-geo-shape-query]]
|
|
==== GeoShape Query
|
|
|
|
See {ref}/query-dsl-geo-shape-query.html[Geo Shape Query]
|
|
|
|
Note: the `geo_shape` type uses `Spatial4J` and `JTS`, both of which are
|
|
optional dependencies. Consequently you must add `Spatial4J` and `JTS`
|
|
to your classpath in order to use this type:
|
|
|
|
[source,xml]
|
|
-----------------------------------------------
|
|
<dependency>
|
|
<groupId>org.locationtech.spatial4j</groupId>
|
|
<artifactId>spatial4j</artifactId>
|
|
<version>0.6</version> <1>
|
|
</dependency>
|
|
|
|
<dependency>
|
|
<groupId>com.vividsolutions</groupId>
|
|
<artifactId>jts</artifactId>
|
|
<version>1.13</version> <2>
|
|
<exclusions>
|
|
<exclusion>
|
|
<groupId>xerces</groupId>
|
|
<artifactId>xercesImpl</artifactId>
|
|
</exclusion>
|
|
</exclusions>
|
|
</dependency>
|
|
-----------------------------------------------
|
|
<1> check for updates in http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.locationtech.spatial4j%22%20AND%20a%3A%22spatial4j%22[Maven Central]
|
|
<2> check for updates in http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.vividsolutions%22%20AND%20a%3A%22jts%22[Maven Central]
|
|
|
|
[source,java]
|
|
--------------------------------------------------
|
|
// Import ShapeRelation and ShapeBuilder
|
|
import org.elasticsearch.common.geo.ShapeRelation;
|
|
import org.elasticsearch.common.geo.builders.ShapeBuilder;
|
|
--------------------------------------------------
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{query-dsl-test}[geo_shape]
|
|
--------------------------------------------------
|
|
<1> field
|
|
<2> shape
|
|
<3> relation can be `ShapeRelation.CONTAINS`, `ShapeRelation.WITHIN`, `ShapeRelation.INTERSECTS` or `ShapeRelation.DISJOINT`
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{query-dsl-test}[indexed_geo_shape]
|
|
--------------------------------------------------
|
|
<1> field
|
|
<2> The ID of the document that containing the pre-indexed shape.
|
|
<3> Index type where the pre-indexed shape is.
|
|
<4> relation
|
|
<5> Name of the index where the pre-indexed shape is. Defaults to 'shapes'.
|
|
<6> The field specified as path containing the pre-indexed shape. Defaults to 'shape'.
|