Hermes@Neo4j
Neo4jSpatiotemporal.LayerST Interface Reference
Inheritance diagram for Neo4jSpatiotemporal.LayerST:
Neo4jSpatiotemporal.DefaultLayerTemporal Neo4jSpatiotemporal.DynamicLayerConfigTemporal Neo4jSpatiotemporal.EditableLayerTemporal Neo4jSpatiotemporal.EditableLayerImplTemporal Neo4jSpatiotemporal.EditableLayerImplTemporal Neo4jSpatiotemporal.DynamicLayerTemporal Neo4jSpatiotemporal.OrderedEditableLayerTemporal Neo4jSpatiotemporal.SimplePointLayerST Neo4jSpatiotemporal.DynamicLayerTemporal Neo4jSpatiotemporal.OrderedEditableLayerTemporal Neo4jSpatiotemporal.SimplePointLayerST

Public Member Functions

void initialize (SpatialTemporalDatabaseService spatialDatabase, String name, Node layerNode)
 
LayerIndexReaderTemporal getIndex ()
 
SpatialTemporalDatabaseRecord add (Node geomNode)
 
TemporalGeometryFactory getGeometryFactory ()
 
Node getLayerNode ()
 
void delete (Listener monitor)
 
String getName ()
 
TemporalGeometryEncoder getGeometryEncoder ()
 
CoordinateReferenceSystem getCoordinateReferenceSystem ()
 
String[] getExtraPropertyNames ()
 
Integer getGeometryType ()
 
SpatialTemporalDatabaseService getSpatialDatabase ()
 
SpatialTemporalDataset getDataset ()
 
Object getStyle ()
 
PropertyMappingManagerTemporal getPropertyMappingManager ()
 

Detailed Description

Instances of LayerST provide the ability for developers to add/remove and edit geometries associated with a single dataset (or layer). This includes support for several storage mechanisms, like in-node (geometries in properties) and sub-graph (geometries describe by the graph). A LayerST can be associated with a dataset. In cases where the dataset contains only one layer, the layer itself is the dataset. See the class DefaultLayerTemporal for the standard implementation of that pattern.

Member Function Documentation

SpatialTemporalDatabaseRecord Neo4jSpatiotemporal.LayerST.add ( Node  geomNode)

This method adds existing geometries to the layer for indexing. After this method is called the geometry should be searchable.

Parameters
geomNode
Returns
SpatialTemporalDatabaseRecord representation of the geometry added to the database

Implemented in Neo4jSpatiotemporal.DynamicLayerConfigTemporal, and Neo4jSpatiotemporal.DefaultLayerTemporal.

void Neo4jSpatiotemporal.LayerST.delete ( Listener  monitor)

Delete the entire layer, including the index. The specific layer implementation will decide if this method should delete also the geometry nodes indexed by this layer. Some implementations have data that only has meaning within a layer, and so will be deleted. Others are simply views onto other more complex data models and deleting the geometry nodes might imply damage to the model. Keep this in mind when coding implementations of the Layer.

Implemented in Neo4jSpatiotemporal.DefaultLayerTemporal, and Neo4jSpatiotemporal.DynamicLayerConfigTemporal.

CoordinateReferenceSystem Neo4jSpatiotemporal.LayerST.getCoordinateReferenceSystem ( )

Each layer can represent data stored in a specific coordinate reference system, or projection.

Returns

Implemented in Neo4jSpatiotemporal.DynamicLayerConfigTemporal, and Neo4jSpatiotemporal.DefaultLayerTemporal.

SpatialTemporalDataset Neo4jSpatiotemporal.LayerST.getDataset ( )

Each layer is associated with a SpatialTemporalDataset. This can be a one-for-one match to the layer, or can be expressed as many layers on a single dataset.

Returns
SpatialTemporalDataset containing the data indexed by this layer.

Implemented in Neo4jSpatiotemporal.DefaultLayerTemporal, and Neo4jSpatiotemporal.DynamicLayerConfigTemporal.

String [] Neo4jSpatiotemporal.LayerST.getExtraPropertyNames ( )

Each layer contains geometries with optional attributes.

Returns
String array of all attribute names

Implemented in Neo4jSpatiotemporal.DefaultLayerTemporal, and Neo4jSpatiotemporal.DynamicLayerConfigTemporal.

TemporalGeometryEncoder Neo4jSpatiotemporal.LayerST.getGeometryEncoder ( )

Each layer can contain geometries stored in the database in a custom way. Classes that implement the layer should also provide appropriate TemporalGeometryEncoders for encoding and decoding the geometries. This can be either as properties of a geometry node, or as sub-graphs accessible from some geometry node.

Returns
implementation of the GemoetryEncoder class enabling encoding/decoding of geometries from the graph

Implemented in Neo4jSpatiotemporal.DefaultLayerTemporal, and Neo4jSpatiotemporal.DynamicLayerConfigTemporal.

TemporalGeometryFactory Neo4jSpatiotemporal.LayerST.getGeometryFactory ( )
Integer Neo4jSpatiotemporal.LayerST.getGeometryType ( )

The layer conforms with the Geotools pattern of only allowing a single geometry per layer.

Returns
integer key for the geotools geometry type

Implemented in Neo4jSpatiotemporal.DynamicLayerConfigTemporal, and Neo4jSpatiotemporal.DefaultLayerTemporal.

LayerIndexReaderTemporal Neo4jSpatiotemporal.LayerST.getIndex ( )

Every layer using a specific implementation of the SpatialTemporalIndexReader and SpatialTemporalIndexWriter for indexing the data in that layer.

Returns
the SpatialIndexReader used to perform searches on the data in the layer

Implemented in Neo4jSpatiotemporal.DynamicLayerConfigTemporal, and Neo4jSpatiotemporal.DefaultLayerTemporal.

Node Neo4jSpatiotemporal.LayerST.getLayerNode ( )

All layers are associated with a single node in the database. This node will have properties, relationships (sub-graph) or both to describe the contents of the layer

Implemented in Neo4jSpatiotemporal.DefaultLayerTemporal, and Neo4jSpatiotemporal.DynamicLayerConfigTemporal.

String Neo4jSpatiotemporal.LayerST.getName ( )

Every layer is defined by a unique name. Uniqueness is not enforced, but lack of uniqueness will not guarrantee the right layer returned from a search.

Returns

Implemented in Neo4jSpatiotemporal.DynamicLayerConfigTemporal, and Neo4jSpatiotemporal.DefaultLayerTemporal.

PropertyMappingManagerTemporal Neo4jSpatiotemporal.LayerST.getPropertyMappingManager ( )
SpatialTemporalDatabaseService Neo4jSpatiotemporal.LayerST.getSpatialDatabase ( )

Since the layer is a key object passed around to most code, it is important to be able to access the generic spatial API from this object.

Returns
instance of the SpatialTemporalDatabaseService object for general access to the spatial database features

Implemented in Neo4jSpatiotemporal.DynamicLayerConfigTemporal, and Neo4jSpatiotemporal.DefaultLayerTemporal.

Object Neo4jSpatiotemporal.LayerST.getStyle ( )

Each layer can optionally provide a style to be used in rendering this layer. Return null if you wish to leave this choice to the GIS. If a Style is returned, it is used. If a File is returned, it is opened and assumed to contain SLD contents. If a String is returned, it is assumed to contain SLD contents.

Returns
Style, String, File or null

Implemented in Neo4jSpatiotemporal.DefaultLayerTemporal, and Neo4jSpatiotemporal.DynamicLayerConfigTemporal.

void Neo4jSpatiotemporal.LayerST.initialize ( SpatialTemporalDatabaseService  spatialDatabase,
String  name,
Node  layerNode 
)

The layer is constructed from metadata in the layer node, which requires that the layer have a no-argument constructor. The real initialization of the layer is then performed by calling this method. The layer implementation can store the passed parameters for later use satisfying the prupose of the layer API (see other LayerST methods).

Parameters
spatialDatabase
name
layerNode

Implemented in Neo4jSpatiotemporal.DefaultLayerTemporal, and Neo4jSpatiotemporal.DynamicLayerConfigTemporal.


The documentation for this interface was generated from the following file: