# neo4j-rtree

**Repository Path**: third_party_code_01/neo4j-rtree

## Basic Information

- **Project Name**: neo4j-rtree
- **Description**: 一个用于neo4j的空间索引
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 6
- **Created**: 2021-12-31
- **Last Updated**: 2022-05-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# neo4j-rtree
一个用于neo4j的空间索引

[README](README.md) | [中文文档](README_zh.md)

## 这个项目能干什么

### 新建空间索引
~~~java
//5个参数依次是:  neo4j的GraphDatabaseService实例    索引名(唯一) 空间属性名   rtree最大子节点数 最大缓存geometry对象数
RTreeIndex rTreeIndex = RTreeIndexManager.createIndex(db, "index1", "geometry", 64, 1024);
~~~


### 简洁地为node加入空间索引:
~~~java
Transaction tx = db.beginTx();
Node node = tx.createNode(testLabel);//新建节点
Point geo = wkbReader.read("POINT(10 20)");
byte[] wkb = wkbWriter.write(geo);//转为wkb
node.setProperty("geometry", wkb);//设置空间字段值,必须为wkb格式
rTreeIndex.add(node,tx);//加入索引(效率起见，多个node的话用list add，详见测试用例)

~~~

### 空间查询
~~~java
//输入一个矩形范围，查询矩形覆盖的节点
double[] bbox = new double[]{3, 1, 8, 9};
try (Transaction tx = db.beginTx()) {
    RtreeQuery.queryByBbox(tx, rTreeIndex, bbox, (node, geometry) -> {
        System.out.println(node.getProperty("xxxx"));
    });
}
~~~

~~~java
//输入一个geometry，查询geometry覆盖的节点
//对于狭长的geometry，使用queryByStripGeometryIntersects方法有更高的性能
Geometry inputGeo = new WKTReader().read("POLYGON ((11 24, 22 28, 29 15, 11 24))");
try (Transaction tx = db.beginTx()) {
    RtreeQuery.queryByGeometryIntersects(tx, rTreeIndex, inputGeo, (node, geometry) -> {
        System.out.println(node.getProperty("xxxx"));
    });
}
~~~

### 最邻近搜索
~~~java
//查询距离点(10.2, 13.2)最近的5个node
try (Transaction tx = db.beginTx()) {
    List<DistanceResult> res = RtreeNearestQuery.queryNearestN(tx, rTreeIndex, 10.2, 13.2, 5, (node, geometry) -> true);
    System.out.println(res);
}

~~~
~~~java
//查询满足约束条件且距离点(10.2, 13.2)最近的5个node
try (Transaction tx = db.beginTx()) {
    List<DistanceResult> res = RtreeNearestQuery.queryNearestN(tx, rTreeIndex, 10.2, 13.2, 5, (node, geometry) -> geometry.getCoordinate().x<10);
    System.out.println(res);//DistanceResult里包含了node、距离以及geometry，详见测试用例
}
~~~
### 精细对象的快速空间分析
对于非常精细的geometry，由于它包含了太多的点，直接用jts的intersects等函数去进行空间关系计算性能会很差，此时，可以考虑用BigShapeManager工具将其切割开并建立索引后再分析：
~~~java
String wkt = "...";//一个很多点构成的多边形
Geometry geometry = wktReader.read(wkt);
String indexId = "123";//声明一个id来构建索引，注意id唯一性
BigShapeManager.build(graphDb, indexId, geometry, 10, 10);//切割多边形为10行10列并构建索引
BigShape bigShape = BigShapeManager.get(graphDb, indexId);//获取到BigShape对象
Geometry s1 = new WKTReader().read("POINT (866.8184900283813 132.99309968948364)");
System.out.println(bigShape.intersects(tx, s1));//利用BigShape来做空间关系计算
~~~
实测对于精细复杂的geometry，BigShape的性能比直接jts快了上百倍（简单的geometry就不要BigShape切割了，否则可能反而性能下降）


## install
The latest version is `1.4.2.RELEASE`

maven import in your project
```
            <dependency>
                <groupId>org.wowtools</groupId>
                <artifactId>neo4j-rtree</artifactId>
                <version>${neo4j-rtree-version}</version>
            </dependency>
```
如果你的项目中已经使用了其它版本的neo4j(例如企业版)，引入时需要exclusions:
```
            <dependency>
                <groupId>org.wowtools</groupId>
                <artifactId>neo4j-rtree</artifactId>
                <version>${neo4j-rtree-version}</version>
                <exclusions>
                    <exclusion>
                        <groupId>org.neo4j</groupId>
                        <artifactId>neo4j-common</artifactId>
                    </exclusion>
                    <exclusion>
                        <groupId>org.neo4j</groupId>
                        <artifactId>neo4j</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
```

注意，maven中央库的依赖用jdk11编译，所以如果你的项目使用了jdk8，你需要自己编译一份适合于你的jdk的:

clone & install

```
git clone https://github.com/codingmiao/neo4j-rtree.git
mvn clean install -DskipTests

```


## 关于本项目
本项目源码中的org.wowtools.neo4j.rtree.spatial包取自开源项目Neo4j Spatial(https://github.com/neo4j-contrib/spatial)

截至本项目首次push起，Neo4j Spatial已经有16个月未更新，Neo4j 4.0的发布，大量的api重写导致Neo4j Spatial已不可用，
所以我抽取了Neo4j Spatial中的空间索引部分并适配至Neo4j 4.0。

同时，去掉了原项目中的osm、shp解析等内容，旨在使项目更精简，这个项目的理念是精简与解耦，你可以独立或集成使用geotools等工具来实现shp等文件的导入，而非与neo4j捆绑在一起。

org.wowtools.neo4j.rtree.nearest包则是取自开源项目PRTree(https://github.com/EngineHub/PRTree)
，基于分支限界法的最邻近搜索