oracle.spatial.spark.vector.index

Class DistributedSpatialIndex<T>

java.lang.Object

oracle.spatial.spark.vector.index.DistributedSpatialIndex<T>

Type Parameters:

T - the generic type of the indexed spatial RDD

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

QuadTreeDistIndex

public abstract class DistributedSpatialIndex<T>
extends java.lang.Object
implements java.io.Serializable

A distributed spatial index for a spatial RDD. An implementation of this class creates and handles a spatial index for a spatial RDD which is used to speed up spatial searches.

Author:

hsaucedo

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DistributedSpatialIndex(java.lang.Class<T> type) Creates an empty instance which will accept spatial RDDs of the given generic type

Method Summary

Modifier and Type	Method and Description
abstract void	cache() Persist the index' internal RDD with the default storage level
static <T> DistributedSpatialIndex<T>	createIndex(JavaSparkContext sc, SpatialJavaRDD<T> rdd, SpatialPartitioningConfiguration partConf) Spatially index a spatial RDD using the specified DistributedSpatialIndex implementing class
abstract SpatialJavaRDD<T>	filter(<any> f, SpatialOperationConfig spatialOpConf) Returns a new spatial RDD containing only the elements that satisfy both, the filtering function and the spatial operation
abstract <R> <any>	flatMap(<any> f, SpatialOperationConfig spatialOpConf) Returns a new RDD by first spatially filtering the RDD elements using the spatial operation given by spatialOpConf, then a function is applied to all the remaining elements.
abstract double[]	getMBR() Returns the minimum bounding rectangle, that is, the rectangle enclosing all the data from the current index
abstract boolean	isLocallyIndexed() Returns true if the current index's partitions contain a local spatial index
static <T> DistributedSpatialIndex<T>	load(JavaSparkContext sc, java.lang.String pathStr) Reads an existing persisted index from the given path
static <T> DistributedSpatialIndex<T>	load(JavaSparkContext sc, java.lang.String pathStr, java.lang.Class<T> type) Reads an existing persisted index from the given path
abstract java.util.List<<any>>	nearestNeighbors(<any> f, int k, SpatialOperationConfig spatialOpConf) Returns the k elements from the RDD which are closest to the query window defined in spatialOpConf
abstract void	persist(StorageLevel storageLevel) Sets the index' internal RDD's storage level to persist its values across operations after the first time it is computed.
abstract SpatialJavaRDD<T>	primaryFilter(<any> f, SpatialOperationConfig spatialOpConf) Returns a new spatial RDD containing the elements which satisfy the filtering lambda function an which are likely to interact with the query window defined in the passes spatial operation configuration.
abstract void	read(JavaSparkContext sc, java.lang.String pathStr) Loads a persisted index from the given path.
void	save(JavaSparkContext sc, java.lang.String pathStr) Stores the current index as a file in the given path
abstract <T2,R> <any>	spatialJoin(DistributedSpatialIndex<T2> index2, <any> f, SpatialOperationConfig spatialOpConf) Joins records from the current index with records of the passed spatial index.
abstract <T2,R> <any>	spatialJoin(SpatialJavaRDD<T2> rdd2, <any> f, SpatialOperationConfig spatialOpConf) Joins records from the current index with records of the passed spatial RDD.
abstract void	unpersist() Marks the index' internal RDD as non-persistent
abstract void	write(JavaSparkContext sc, java.lang.String pathStr) Writes the current index to the given path

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedSpatialIndex

public DistributedSpatialIndex(java.lang.Class<T> type)

Creates an empty instance which will accept spatial RDDs of the given generic type

Parameters:

type - the generic type of the spatial RDD to be indexed

Method Detail

cache

public abstract void cache()

Persist the index' internal RDD with the default storage level

createIndex

public static <T> DistributedSpatialIndex<T> createIndex(JavaSparkContext sc,
                                                         SpatialJavaRDD<T> rdd,
                                                         SpatialPartitioningConfiguration partConf)
                                                  throws java.lang.Exception

Spatially index a spatial RDD using the specified DistributedSpatialIndex implementing class

Parameters:

sc - an existing Spark context

rdd - a spatial RDD

partConf - Indexing and partitioning configuration. It determines the concrete index implementation to be created.

Returns:

an instance of DistributedSpatialIndex

Throws:

java.lang.Exception

filter

public abstract SpatialJavaRDD<T> filter(<any> f,
                                         SpatialOperationConfig spatialOpConf)
                                  throws java.lang.Exception

Returns a new spatial RDD containing only the elements that satisfy both, the filtering function and the spatial operation

Parameters:

f - a filtering function

spatialOpConf - the spatial operation configuration to spatially filter the RDD

Returns:

a new SpatialJavaRDD

Throws:

java.lang.Exception

flatMap

public abstract <R> <any> flatMap(<any> f,
                                  SpatialOperationConfig spatialOpConf)
                           throws java.lang.Exception

Returns a new RDD by first spatially filtering the RDD elements using the spatial operation given by spatialOpConf, then a function is applied to all the remaining elements.

Parameters:

f - a function to apply to each element

spatialOpConf - the spatial operation configuration to spatially filter the RDD

Returns:

a new RDD

Throws:

java.lang.Exception

getMBR

public abstract double[] getMBR()

Returns the minimum bounding rectangle, that is, the rectangle enclosing all the data from the current index

Returns:

an array of double containing the following information: minX, minY, maxX, maxY

isLocallyIndexed

public abstract boolean isLocallyIndexed()

Returns true if the current index's partitions contain a local spatial index

Returns:

load

public static <T> DistributedSpatialIndex<T> load(JavaSparkContext sc,
                                                  java.lang.String pathStr)
                                           throws java.lang.Exception

Reads an existing persisted index from the given path

Parameters:

sc - an existing Spark context

pathStr - a path on either, a local or distributed file system

Returns:

Throws:

java.lang.Exception

load

public static <T> DistributedSpatialIndex<T> load(JavaSparkContext sc,
                                                  java.lang.String pathStr,
                                                  java.lang.Class<T> type)
                                           throws java.lang.Exception

Reads an existing persisted index from the given path

Parameters:

sc - an existing Spark context

pathStr - a path on either, a local or distributed file system

type - the generic parameter type of the loaded index

Returns:

Throws:

java.lang.Exception

nearestNeighbors

public abstract java.util.List<<any>> nearestNeighbors(<any> f,
                                                       int k,
                                                       SpatialOperationConfig spatialOpConf)
                                                throws java.lang.Exception

Returns the k elements from the RDD which are closest to the query window defined in spatialOpConf

Parameters:

f - an optional filtering function which should return true for the elements which can be part of the solution

k - the number of nearest neighbors to return

spatialOpConf - a spatial configuration containing the query window to be used. SpatialOperation is ignored for this action.

Returns:

a list of tuples where each tuple contains a distance and a nearest neighbor

Throws:

java.lang.Exception

persist

public abstract void persist(StorageLevel storageLevel)

Sets the index' internal RDD's storage level to persist its values across operations after the first time it is computed.

Parameters:

storageLevel -

primaryFilter

public abstract SpatialJavaRDD<T> primaryFilter(<any> f,
                                                SpatialOperationConfig spatialOpConf)
                                         throws java.lang.Exception

Returns a new spatial RDD containing the elements which satisfy the filtering lambda function an which are likely to interact with the query window defined in the passes spatial operation configuration.

Parameters:

f - a filtering function

spatialOpConf - the spatial operation configuration to spatially filter the RDD

Returns:

a new SpatialJavaRDD

Throws:

java.lang.Exception

read

public abstract void read(JavaSparkContext sc,
                          java.lang.String pathStr)
                   throws java.lang.Exception

Loads a persisted index from the given path. The persisted index is expected to be of the same implementation class than the current instance

Parameters:

sc - an existing Spark context

pathStr - a path on either, a local or distributed file system

Throws:

java.lang.Exception

save

public void save(JavaSparkContext sc,
                 java.lang.String pathStr)
          throws java.lang.Exception

Stores the current index as a file in the given path

Parameters:

sc - an existing Spark context

pathStr - a path on either, a local or distributed file system

Throws:

java.lang.Exception

spatialJoin

public abstract <T2,R> <any> spatialJoin(DistributedSpatialIndex<T2> index2,
                                         <any> f,
                                         SpatialOperationConfig spatialOpConf)
                                  throws java.lang.Exception

Joins records from the current index with records of the passed spatial index. The records are joined based on a spatial relationship defined by the given instance of SpatialOperationConfig. The type of the resulting records is defined by the user-provided lambda function.

Parameters:

index2 - a spatial index to join

f - a lambda function called for each pair of joined records.

spatialOpConf - defines the spatial interaction used to join two records

Returns:

a new RDD containing records of a type defined by the return type of the user-provided lambda function

Throws:

java.lang.Exception

spatialJoin

public abstract <T2,R> <any> spatialJoin(SpatialJavaRDD<T2> rdd2,
                                         <any> f,
                                         SpatialOperationConfig spatialOpConf)
                                  throws java.lang.Exception

Joins records from the current index with records of the passed spatial RDD. The records are joined based on a spatial relationship defined by the given instance of SpatialOperationConfig. The type of the resulting records is defined by the user-provided lambda function.

Parameters:

rdd2 - a spatial RDD to join

f - a lambda function called for each pair of joined records.

spatialOpConf - defines the spatial interaction used to join two records

Returns:

a new RDD containing records of a type defined by the return type of the user-provided lambda function

Throws:

java.lang.Exception

unpersist

public abstract void unpersist()

Marks the index' internal RDD as non-persistent

write

public abstract void write(JavaSparkContext sc,
                           java.lang.String pathStr)
                    throws java.lang.Exception

Writes the current index to the given path

Parameters:

sc - an existing Spark context

pathStr - a path on either, a local or distributed file system

Throws:

java.lang.Exception