oracle.spatial.spark.vector.index

Class PartitionKey

java.lang.Object

oracle.spatial.spark.vector.index.PartitionKey

All Implemented Interfaces:

java.io.Serializable

public class PartitionKey
extends java.lang.Object
implements java.io.Serializable

A reference to an existing SpatialPartition. It is used to associate an RDD's single element to the partition it belongs and other partitions (with smaller partition index values) which also contain the RDD element.

Author:

hsaucedo

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PartitionKey() Creates an empty instance
PartitionKey(int index) Creates an instance pointing to a partition with the given index
PartitionKey(int index, java.lang.Integer[] previousIndexes) Creates an instance pointing to a partition with the given index and the given previousIndexes

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getIndex() Gets the index of the referenced partition
java.lang.Integer[]	getPreviousIndexes() Gets an array of partitions indexes which also contain the RDD element this key is associated with.
int	hashCode()
void	readFields(java.io.DataInput in)
void	setIndex(int index) Sets the index of the referenced partition
void	setPreviousIndexes(java.lang.Integer[] previousIndexes) Sets an array of partitions indexes which also contain the RDD element this key is associated with.
java.lang.String	toString()
void	write(java.io.DataOutput out)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PartitionKey

public PartitionKey()

Creates an empty instance

PartitionKey

public PartitionKey(int index)

Creates an instance pointing to a partition with the given index

Parameters:

index -

PartitionKey

public PartitionKey(int index,
                    java.lang.Integer[] previousIndexes)

Creates an instance pointing to a partition with the given index and the given previousIndexes

Parameters:

index -

previousIndexes -

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getIndex

public int getIndex()

Gets the index of the referenced partition

Returns:

an index equals or largest than 0 or -1 if no partition is referenced

getPreviousIndexes

public java.lang.Integer[] getPreviousIndexes()

Gets an array of partitions indexes which also contain the RDD element this key is associated with.

Returns:

an array of partitions indexes. The index values must be less than the current PartitionKey's index.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Throws:

java.io.IOException

setIndex

public void setIndex(int index)

Sets the index of the referenced partition

Parameters:

index - an index equals or largest than 0 or -1 if no partition is referenced

setPreviousIndexes

public void setPreviousIndexes(java.lang.Integer[] previousIndexes)

Sets an array of partitions indexes which also contain the RDD element this key is associated with.

This data is used to avoid processing RDD elements residing in more than one partition.

Parameters:

previousIndexes - an array of partitions indexes. The index values must be less than the current PartitionKey's index.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Throws:

java.io.IOException