org.heigit.bigspatialdata.oshdb.api.db

Class OSHDBIgnite

java.lang.Object

org.heigit.bigspatialdata.oshdb.OSHDB

org.heigit.bigspatialdata.oshdb.api.db.OSHDBDatabase

org.heigit.bigspatialdata.oshdb.api.db.OSHDBIgnite

All Implemented Interfaces:

AutoCloseable

public class OSHDBIgnite
extends OSHDBDatabase
implements AutoCloseable

OSHDB database backend connector to a Ignite system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OSHDBIgnite.ComputeMode

Field Summary

Fields inherited from class org.heigit.bigspatialdata.oshdb.OSHDB

GEOM_PRECISION, GEOM_PRECISION_TO_LONG, MAXZOOM

Constructor Summary

Constructors

Constructor and Description
OSHDBIgnite()
OSHDBIgnite(File igniteConfig) Opens a connection to oshdb data stored on an Ignite cluster.
OSHDBIgnite(org.apache.ignite.Ignite ignite)
OSHDBIgnite(String igniteConfigFilePath)

Method Summary

Modifier and Type	Method and Description
void	close()
OSHDBIgnite.ComputeMode	computeMode() Gets the set compute mode.
OSHDBIgnite	computeMode(OSHDBIgnite.ComputeMode computeMode) Sets the compute mode.
<X extends OSHDBMapReducible> MapReducer<X>	createMapReducer(Class<X> forClass) Factory function that creates a mapReducer object of the appropriate data type class for this oshdb backend implemenation.
org.apache.ignite.Ignite	getIgnite()
String	metadata(String property) Returns metadata about the given OSHDB.
Optional<org.apache.ignite.lang.IgniteRunnable>	onClose() Gets the onClose callback.
OSHDBIgnite	onClose(org.apache.ignite.lang.IgniteRunnable action) Sets a callback to be executed on all ignite workers after the query has been finished.
OSHDBIgnite	prefix(String prefix) Sets the "table/cache" name prefix to be used with this oshdb.

Methods inherited from class org.heigit.bigspatialdata.oshdb.api.db.OSHDBDatabase

clearTimeout, prefix, timeout, timeoutInMilliseconds, timeoutInMilliseconds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OSHDBIgnite

public OSHDBIgnite()

OSHDBIgnite

public OSHDBIgnite(org.apache.ignite.Ignite ignite)

OSHDBIgnite

public OSHDBIgnite(String igniteConfigFilePath)

OSHDBIgnite

public OSHDBIgnite(File igniteConfig)

Opens a connection to oshdb data stored on an Ignite cluster.

Parameters:

igniteConfig - ignite configuration file

Method Detail

prefix

public OSHDBIgnite prefix(String prefix)

Description copied from class: OSHDBDatabase

Sets the "table/cache" name prefix to be used with this oshdb.

Overrides:

prefix in class OSHDBDatabase

createMapReducer

public <X extends OSHDBMapReducible> MapReducer<X> createMapReducer(Class<X> forClass)

Description copied from class: OSHDBDatabase

Factory function that creates a mapReducer object of the appropriate data type class for this oshdb backend implemenation.

Specified by:

createMapReducer in class OSHDBDatabase

Parameters:

forClass - the data type class to iterate over in the `mapping` function of the generated MapReducer

Returns:

a new mapReducer object operating on the given OSHDB backend

metadata

public String metadata(String property)

Description copied from class: OSHDBDatabase

Returns metadata about the given OSHDB.

For example copyright information, currentness of the data, spatial extent, etc.

Specified by:

metadata in class OSHDBDatabase

getIgnite

public org.apache.ignite.Ignite getIgnite()

close

public void close()

Specified by:

close in interface AutoCloseable

computeMode

public OSHDBIgnite computeMode(OSHDBIgnite.ComputeMode computeMode)

Sets the compute mode.

Parameters:

computeMode - the compute mode to be used in calculations on this oshdb backend

Returns:

this backend

computeMode

public OSHDBIgnite.ComputeMode computeMode()

Gets the set compute mode.

Returns:

the currently set compute mode

onClose

public OSHDBIgnite onClose(org.apache.ignite.lang.IgniteRunnable action)

Sets a callback to be executed on all ignite workers after the query has been finished.

This can be used to close connections to (temporary) databases that were used to store or retrieve intermediate data.

Parameters:

action - the callback to execute after a query is done

Returns:

the current oshdb database object

onClose

public Optional<org.apache.ignite.lang.IgniteRunnable> onClose()

Gets the onClose callback.

Returns:

the currently set onClose callback