oracle.spatial.spark.vector.index.quadtree

Class QuadTreeConfiguration

java.lang.Object

oracle.spatial.spark.vector.index.quadtree.QuadTreeConfiguration

All Implemented Interfaces:

java.io.Serializable, SpatialPartitioningConfiguration

public class QuadTreeConfiguration
extends java.lang.Object
implements SpatialPartitioningConfiguration

Configuration used by QuadTreeDistIndex and QuadTreePartitioning. Partitioning quality and speed can be affected by setting configuration properties.

Author:

hsaucedo

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
QuadTreeConfiguration() Creates an empty instance
QuadTreeConfiguration(boolean useLocalIndex) Creates a new instance and sets the useLocalIndex property with the given value

Method Summary

Modifier and Type	Method and Description
java.lang.Class<? extends DistributedSpatialIndex<?>>	getDistributedSpatialIndexClass() Gets the type of DistributedSpatialIndex this configuration is meant for.
int	getMaxParitionCount() Gets the maximum number of partitions to be generated
int	getMaxQuadTreeDepth() Gets the maximum number of levels contained by the generated QuadTree
long	getMaxRecordsPerPartition() Gets the maximum number of RDD elements per partition
long	getMinRecordsPerPartition() Gets the minimum number of RDD elements per partition
long	getRddSize() Gets the size of the RDD to be partitioned/indexed.
long	getRecordSize() Gets the average record size
java.lang.Double	getSamplingFraction() Gets the sampling fraction used for sampling the RDD for calculating partitions.
java.lang.Class<? extends SpatialPartitioning<?>>	getSpatialPartitioningClass() Gets the type of SpatialPartitioning algorithm this configuration is meant for.
boolean	isLocallyIndexed()
boolean	isUseLocalIndex() Gets whether the generated distributed index will contain local indexes or not.
void	setLocallyIndexed(boolean locallyIndexed)
void	setMaxParitionCount(int maxParitionCount) Sets the maximum number of partitions to be generated
void	setMaxQuadTreeDepth(int maxQuadTreeDepth) Sets the maximum number of levels contained by the generated QuadTree
void	setMaxRecordsPerPartition(long maxElementsPerPartition) Sets the maximum number of RDD elements per partition
void	setMinRecordsPerPartition(long minElementsPerPartition) Sets the minimum number of RDD elements per partition
void	setRddSize(long rddSize) Sets the size of the RDD to be partitioned/indexed.
void	setRecordSize(long recordSize) Sets the average record size
void	setSamplingFraction(java.lang.Double samplingFraction) Sets the sampling fraction used for sampling the RDD for calculating partitions.
void	setUseLocalIndex(boolean useLocalIndex) Sets whether the generated distributed index will contain local indexes or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

QuadTreeConfiguration

public QuadTreeConfiguration()

Creates an empty instance

QuadTreeConfiguration

public QuadTreeConfiguration(boolean useLocalIndex)

Creates a new instance and sets the useLocalIndex property with the given value

Parameters:

useLocalIndex -

Method Detail

getDistributedSpatialIndexClass

public java.lang.Class<? extends DistributedSpatialIndex<?>> getDistributedSpatialIndexClass()

Description copied from interface: SpatialPartitioningConfiguration

Gets the type of DistributedSpatialIndex this configuration is meant for.

Specified by:

getDistributedSpatialIndexClass in interface SpatialPartitioningConfiguration

Returns:

a subclass of DistributedSpatialIndex

getMaxParitionCount

public int getMaxParitionCount()

Gets the maximum number of partitions to be generated

Returns:

getMaxQuadTreeDepth

public int getMaxQuadTreeDepth()

Gets the maximum number of levels contained by the generated QuadTree

Returns:

getMaxRecordsPerPartition

public long getMaxRecordsPerPartition()

Gets the maximum number of RDD elements per partition

Returns:

getMinRecordsPerPartition

public long getMinRecordsPerPartition()

Gets the minimum number of RDD elements per partition

Returns:

getRddSize

public long getRddSize()

Gets the size of the RDD to be partitioned/indexed.

Returns:

getRecordSize

public long getRecordSize()

Gets the average record size

Returns:

getSamplingFraction

public java.lang.Double getSamplingFraction()

Gets the sampling fraction used for sampling the RDD for calculating partitions.

Returns:

getSpatialPartitioningClass

public java.lang.Class<? extends SpatialPartitioning<?>> getSpatialPartitioningClass()

Description copied from interface: SpatialPartitioningConfiguration

Gets the type of SpatialPartitioning algorithm this configuration is meant for.

Specified by:

getSpatialPartitioningClass in interface SpatialPartitioningConfiguration

Returns:

a subclass of SpatialPartitioning

isLocallyIndexed

public boolean isLocallyIndexed()

Specified by:

isLocallyIndexed in interface SpatialPartitioningConfiguration

isUseLocalIndex

public boolean isUseLocalIndex()

Gets whether the generated distributed index will contain local indexes or not. Default is false.

Returns:

setLocallyIndexed

public void setLocallyIndexed(boolean locallyIndexed)

setMaxParitionCount

public void setMaxParitionCount(int maxParitionCount)

Sets the maximum number of partitions to be generated

Parameters:

maxParitionCount -

setMaxQuadTreeDepth

public void setMaxQuadTreeDepth(int maxQuadTreeDepth)

Sets the maximum number of levels contained by the generated QuadTree

Parameters:

maxQuadTreeDepth -

setMaxRecordsPerPartition

public void setMaxRecordsPerPartition(long maxElementsPerPartition)

Sets the maximum number of RDD elements per partition

Parameters:

maxElementsPerPartition -

setMinRecordsPerPartition

public void setMinRecordsPerPartition(long minElementsPerPartition)

Sets the minimum number of RDD elements per partition

Parameters:

minElementsPerPartition -

setRddSize

public void setRddSize(long rddSize)

Sets the size of the RDD to be partitioned/indexed. Setting this value can speed up the partitioning process and generate more accurate partition size.

Parameters:

rddSize -

setRecordSize

public void setRecordSize(long recordSize)

Sets the average record size

Parameters:

recordSize -

setSamplingFraction

public void setSamplingFraction(java.lang.Double samplingFraction)

Sets the sampling fraction used for sampling the RDD for calculating partitions. When this property is set, the RDD will always be sampled for calculating partitions. When this property has not been set, the RDD may be sampled or not, depending on the RDD size and the executor memory.

Parameters:

samplingFraction -

setUseLocalIndex

public void setUseLocalIndex(boolean useLocalIndex)

Sets whether the generated distributed index will contain local indexes or not. Default is false.

Parameters:

useLocalIndex -