spatial.addLayerWithEncoder

Procedure

Adds a new layer with the given encoder class and configuration, returns the layer root node

Signature

spatial.addLayerWithEncoder(name :: STRING, encoder :: STRING, encoderConfig :: STRING, indexConfig =  :: STRING) :: (node :: NODE)

Input parameters

Name Type Default Description

name

STRING

null

The name of the layer

encoder

STRING

null

The name of the encoder to be used for the new layer

encoderConfig

STRING

null

The configuration of the encoder that is used by layer to en-/decode the geometry of indexed nodes

indexConfig

STRING

""

The configuration of the newly created index

Output parameters

Name Type Description

node

NODE

Examples

Create a NativePointEncoder

CALL spatial.addLayerWithEncoder('geom','NativePointEncoder','')
Table 1. Result
node 
(:SpatialLayer {
    geomencoder: "org.neo4j.gis.spatial.encoders.NativePointEncoder",
    index_class: "org.neo4j.gis.spatial.index.LayerRTreeIndex",
    layer: "geom",
    layer_class: "org.neo4j.gis.spatial.SimplePointLayer"
})

Create a NativePointEncoder with a customized encoder configuration

Configures the encoder to use the nodes pos property instead of location and the mbr property instead of bbox.

CALL spatial.addLayerWithEncoder('geom','NativePointEncoder','pos:mbr')
Table 2. Result
node 
(:SpatialLayer {
    geomencoder: "org.neo4j.gis.spatial.encoders.NativePointEncoder",
    geomencoder_config: "pos:mbr",
    index_class: "org.neo4j.gis.spatial.index.LayerRTreeIndex",
    layer: "geom",
    layer_class: "org.neo4j.gis.spatial.SimplePointLayer"
})

Create a NativePointEncoder with a customized encoder configuration using Cartesian coordinates

Configures the encoder to use the nodes pos property instead of location, the mbr property instead of bbox and Cartesian coordinates.

CALL spatial.addLayerWithEncoder('geom','NativePointEncoder','pos:mbr:Cartesian')
Table 3. Result
node 
(:SpatialLayer {
    geomencoder: "org.neo4j.gis.spatial.encoders.NativePointEncoder",
    geomencoder_config: "pos:mbr:Cartesian",
    index_class: "org.neo4j.gis.spatial.index.LayerRTreeIndex",
    layer: "geom",
    layer_class: "org.neo4j.gis.spatial.SimplePointLayer"
})

Create a SimplePointEncoder

CALL spatial.addLayerWithEncoder('geom','SimplePointEncoder','')
Table 4. Result
node 
(:SpatialLayer {
    geomencoder: "org.neo4j.gis.spatial.encoders.SimplePointEncoder",
    index_class: "org.neo4j.gis.spatial.index.LayerRTreeIndex",
    layer: "geom",
    layer_class: "org.neo4j.gis.spatial.SimplePointLayer"
})

Create a SimplePointEncoder with a customized encoder configuration

Configures the encoder to use the nodes x property instead of longitude, the y property instead of latitude and the mbr property instead of bbox.

CALL spatial.addLayerWithEncoder('geom','SimplePointEncoder','x:y:mbr')
Table 5. Result
node 
(:SpatialLayer {
    geomencoder: "org.neo4j.gis.spatial.encoders.SimplePointEncoder",
    geomencoder_config: "x:y:mbr",
    index_class: "org.neo4j.gis.spatial.index.LayerRTreeIndex",
    layer: "geom",
    layer_class: "org.neo4j.gis.spatial.SimplePointLayer"
})