Hermes@Neo4j
Neo4jSpatiotemporal.DynamicLayerConfigTemporal Class Reference
Inheritance diagram for Neo4jSpatiotemporal.DynamicLayerConfigTemporal:
Neo4jSpatiotemporal.LayerST Neo4jSpatiotemporal.TemporalConstants

Public Member Functions

 DynamicLayerConfigTemporal (DynamicLayerTemporal parent, Node configNode)
 
 DynamicLayerConfigTemporal (DynamicLayerTemporal parent, String name, int geometryType, String query)
 
String getName ()
 
String getQuery ()
 
SpatialTemporalDatabaseRecord add (Node geomNode)
 
void delete (Listener monitor)
 
CoordinateReferenceSystem getCoordinateReferenceSystem ()
 
SpatialTemporalDataset getDataset ()
 
String[] getExtraPropertyNames ()
 
void restrictLayerProperties ()
 
void setExtraPropertyNames (String[] names)
 
TemporalGeometryEncoder getGeometryEncoder ()
 
TemporalGeometryFactory getGeometryFactory ()
 
Integer getGeometryType ()
 
LayerIndexReaderTemporal getIndex ()
 
Node getLayerNode ()
 
SpatialTemporalDatabaseService getSpatialDatabase ()
 
void initialize (SpatialTemporalDatabaseService spatialDatabase, String name, Node layerNode)
 
Object getStyle ()
 
LayerST getParent ()
 
String toString ()
 
PropertyMappingManagerTemporal getPropertyMappingManager ()
 

Protected Attributes

Node configNode
 

Additional Inherited Members

- Public Attributes inherited from Neo4jSpatiotemporal.TemporalConstants
String PROP_LAYER = "layer"
 
String PROP_LAYERNODEEXTRAPROPS = "layerprops"
 
String PROP_CRS = "layercrs"
 
String PROP_CREATIONTIME = "ctime"
 
String PROP_GEOMENCODER = "geomencoder"
 
String PROP_GEOMENCODER_CONFIG = "geomencoder_config"
 
String PROP_LAYER_CLASS = "layer_class"
 
String PROP_TYPE = "gtype"
 
String PROP_QUERY = "query"
 
String PROP_WKB = "wkb"
 
String PROP_WKT = "wkt"
 
String[] RESERVED_PROPS
 
int GTYPE_GEOMETRY = 0
 
int GTYPE_POINT = 1
 
int GTYPE_LINESTRING = 2
 
int GTYPE_POLYGON = 3
 
int GTYPE_MULTIPOINT = 4
 
int GTYPE_MULTILINESTRING = 5
 
int GTYPE_MULTIPOLYGON = 6
 

Constructor & Destructor Documentation

Neo4jSpatiotemporal.DynamicLayerConfigTemporal.DynamicLayerConfigTemporal ( DynamicLayerTemporal  parent,
Node  configNode 
)

Construct the layer config instance on existing config information in the database.

Parameters
configNode
Neo4jSpatiotemporal.DynamicLayerConfigTemporal.DynamicLayerConfigTemporal ( DynamicLayerTemporal  parent,
String  name,
int  geometryType,
String  query 
)

Construct a new layer config by building the database structure to support the necessary configuration

Parameters
nameof the new dynamic layer
geometryTypethe geometry this layer supports
queryformated query string for this dynamic layer

Member Function Documentation

SpatialTemporalDatabaseRecord Neo4jSpatiotemporal.DynamicLayerConfigTemporal.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

Implements Neo4jSpatiotemporal.LayerST.

void Neo4jSpatiotemporal.DynamicLayerConfigTemporal.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.

Implements Neo4jSpatiotemporal.LayerST.

CoordinateReferenceSystem Neo4jSpatiotemporal.DynamicLayerConfigTemporal.getCoordinateReferenceSystem ( )

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

Returns

Implements Neo4jSpatiotemporal.LayerST.

SpatialTemporalDataset Neo4jSpatiotemporal.DynamicLayerConfigTemporal.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.

Implements Neo4jSpatiotemporal.LayerST.

String [] Neo4jSpatiotemporal.DynamicLayerConfigTemporal.getExtraPropertyNames ( )

Each layer contains geometries with optional attributes.

Returns
String array of all attribute names

Implements Neo4jSpatiotemporal.LayerST.

TemporalGeometryEncoder Neo4jSpatiotemporal.DynamicLayerConfigTemporal.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

Implements Neo4jSpatiotemporal.LayerST.

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

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

Returns
integer key for the geotools geometry type

Implements Neo4jSpatiotemporal.LayerST.

LayerIndexReaderTemporal Neo4jSpatiotemporal.DynamicLayerConfigTemporal.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

Implements Neo4jSpatiotemporal.LayerST.

Node Neo4jSpatiotemporal.DynamicLayerConfigTemporal.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

Implements Neo4jSpatiotemporal.LayerST.

String Neo4jSpatiotemporal.DynamicLayerConfigTemporal.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

Implements Neo4jSpatiotemporal.LayerST.

LayerST Neo4jSpatiotemporal.DynamicLayerConfigTemporal.getParent ( )
PropertyMappingManagerTemporal Neo4jSpatiotemporal.DynamicLayerConfigTemporal.getPropertyMappingManager ( )
String Neo4jSpatiotemporal.DynamicLayerConfigTemporal.getQuery ( )
SpatialTemporalDatabaseService Neo4jSpatiotemporal.DynamicLayerConfigTemporal.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

Implements Neo4jSpatiotemporal.LayerST.

Object Neo4jSpatiotemporal.DynamicLayerConfigTemporal.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

Implements Neo4jSpatiotemporal.LayerST.

void Neo4jSpatiotemporal.DynamicLayerConfigTemporal.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

Implements Neo4jSpatiotemporal.LayerST.

void Neo4jSpatiotemporal.DynamicLayerConfigTemporal.restrictLayerProperties ( )

This method will scan the layer for property names that are actually used, and restrict the layer properties to those

void Neo4jSpatiotemporal.DynamicLayerConfigTemporal.setExtraPropertyNames ( String[]  names)
String Neo4jSpatiotemporal.DynamicLayerConfigTemporal.toString ( )

Member Data Documentation

Node Neo4jSpatiotemporal.DynamicLayerConfigTemporal.configNode
protected

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