org.locationtech.geowave.core.index

Class NumericIndexStrategyWrapper

java.lang.Object

org.locationtech.geowave.core.index.NumericIndexStrategyWrapper

All Implemented Interfaces:

IndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>, NumericIndexStrategy, PartitionIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>, Persistable, SortedIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

public class NumericIndexStrategyWrapper
extends Object
implements NumericIndexStrategy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NumericIndexStrategyWrapper()
	NumericIndexStrategyWrapper(String id, NumericIndexStrategy indexStrategy)

Method Summary

Modifier and Type	Method and Description
List<IndexMetaData>	createMetaData()
void	fromBinary(byte[] bytes) Convert a stream of binary bytes to fields and data within an object.
MultiDimensionalCoordinateRanges[]	getCoordinateRangesPerDimension(MultiDimensionalNumericData dataRange, IndexMetaData... hints) Return an integer coordinate range in each dimension for the given data range plus a bin ID if that dimension is continuous
MultiDimensionalCoordinates	getCoordinatesPerDimension(byte[] partitionKey, byte[] sortKey) Return an integer coordinate in each dimension for the given partition and sort key plus a bin ID if that dimension is continuous.
double[]	getHighestPrecisionIdRangePerDimension() * Get the range/size of a single insertion ID for each dimension at the highest precision supported by this index strategy
String	getId()
InsertionIds	getInsertionIds(MultiDimensionalNumericData indexedData) Returns a list of id's for insertion.
InsertionIds	getInsertionIds(MultiDimensionalNumericData indexedData, int maxDuplicateInsertionIds) Returns a list of id's for insertion.
byte[][]	getInsertionPartitionKeys(MultiDimensionalNumericData insertionData)
NumericDimensionDefinition[]	getOrderedDimensionDefinitions() Returns an array of dimension definitions that defines this index strategy, the array is in the order that is expected within multidimensional numeric data that is passed to this index strategy
int	getPartitionKeyLength() * Get the offset in bytes before the dimensional index.
byte[][]	getPredefinedSplits()
byte[][]	getQueryPartitionKeys(MultiDimensionalNumericData queryData, IndexMetaData... hints)
QueryRanges	getQueryRanges(MultiDimensionalNumericData indexedRange, IndexMetaData... hints) Returns a list of query ranges for an specified numeric range.
QueryRanges	getQueryRanges(MultiDimensionalNumericData indexedRange, int maxRangeDecomposition, IndexMetaData... hints) Returns a list of query ranges for an specified numeric range.
MultiDimensionalNumericData	getRangeForId(byte[] partitionKey, byte[] sortKey) Returns the range that the given ID represents
byte[]	toBinary() Convert fields and data within an object to binary form for transmission or storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

NumericIndexStrategyWrapper

protected NumericIndexStrategyWrapper()

NumericIndexStrategyWrapper

public NumericIndexStrategyWrapper(String id,
                                   NumericIndexStrategy indexStrategy)

Method Detail

getId

public String getId()

Specified by:

getId in interface IndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

Returns:

a unique ID associated with the index strategy

toBinary

public byte[] toBinary()

Description copied from interface: Persistable

Convert fields and data within an object to binary form for transmission or storage.

Specified by:

toBinary in interface Persistable

Returns:

an array of bytes representing a binary stream representation of the object.

fromBinary

public void fromBinary(byte[] bytes)

Description copied from interface: Persistable

Convert a stream of binary bytes to fields and data within an object.

Specified by:

fromBinary in interface Persistable

getQueryRanges

public QueryRanges getQueryRanges(MultiDimensionalNumericData indexedRange,
                                  IndexMetaData... hints)

Description copied from interface: SortedIndexStrategy

Returns a list of query ranges for an specified numeric range.

Specified by:

getQueryRanges in interface SortedIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

Parameters:

indexedRange - defines the numeric range for the query

Returns:

a List of query ranges

getQueryRanges

public QueryRanges getQueryRanges(MultiDimensionalNumericData indexedRange,
                                  int maxRangeDecomposition,
                                  IndexMetaData... hints)

Description copied from interface: SortedIndexStrategy

Returns a list of query ranges for an specified numeric range.

Specified by:

getQueryRanges in interface SortedIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

Parameters:

indexedRange - defines the numeric range for the query

maxRangeDecomposition - the maximum number of ranges provided by a single query decomposition, this is a best attempt and not a guarantee

Returns:

a List of query ranges

getInsertionIds

public InsertionIds getInsertionIds(MultiDimensionalNumericData indexedData)

Description copied from interface: SortedIndexStrategy

Returns a list of id's for insertion. The index strategy will use a reasonable default for the maximum duplication of insertion IDs

Specified by:

getInsertionIds in interface SortedIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

Parameters:

indexedData - defines the numeric data to be indexed

Returns:

a List of insertion ID's

getRangeForId

public MultiDimensionalNumericData getRangeForId(byte[] partitionKey,
                                                 byte[] sortKey)

Description copied from interface: SortedIndexStrategy

Returns the range that the given ID represents

Specified by:

getRangeForId in interface SortedIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

Parameters:

partitionKey - the partition key part of the insertion ID to determine a range for

sortKey - the sort key part of the insertion ID to determine a range for

Returns:

the range that the given insertion ID represents, inclusive on the start and exclusive on the end for the range

getCoordinatesPerDimension

public MultiDimensionalCoordinates getCoordinatesPerDimension(byte[] partitionKey,
                                                              byte[] sortKey)

Description copied from interface: NumericIndexStrategy

Return an integer coordinate in each dimension for the given partition and sort key plus a bin ID if that dimension is continuous.

Specified by:

getCoordinatesPerDimension in interface NumericIndexStrategy

Parameters:

partitionKey - the partition key to determine the coordinates for

sortKey - the sort key to determine the coordinates for

Returns:

the integer coordinate that the given insertion ID represents and associated bin ID if that dimension is continuous

getOrderedDimensionDefinitions

public NumericDimensionDefinition[] getOrderedDimensionDefinitions()

Description copied from interface: NumericIndexStrategy

Returns an array of dimension definitions that defines this index strategy, the array is in the order that is expected within multidimensional numeric data that is passed to this index strategy

Specified by:

getOrderedDimensionDefinitions in interface NumericIndexStrategy

Returns:

the ordered array of dimension definitions that represents this index strategy

getHighestPrecisionIdRangePerDimension

public double[] getHighestPrecisionIdRangePerDimension()

Description copied from interface: NumericIndexStrategy

* Get the range/size of a single insertion ID for each dimension at the highest precision supported by this index strategy

Specified by:

getHighestPrecisionIdRangePerDimension in interface NumericIndexStrategy

Returns:

the range of a single insertion ID for each dimension

getInsertionIds

public InsertionIds getInsertionIds(MultiDimensionalNumericData indexedData,
                                    int maxDuplicateInsertionIds)

Description copied from interface: SortedIndexStrategy

Returns a list of id's for insertion.

Specified by:

getInsertionIds in interface SortedIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

Parameters:

indexedData - defines the numeric data to be indexed

maxDuplicateInsertionIds - the maximum number of insertion IDs that can be used, this is a best attempt and not a guarantee

Returns:

a List of insertion ID's

getPartitionKeyLength

public int getPartitionKeyLength()

Description copied from interface: NumericIndexStrategy

* Get the offset in bytes before the dimensional index. This can accounts for tier IDs and bin IDs

Specified by:

getPartitionKeyLength in interface NumericIndexStrategy

Specified by:

getPartitionKeyLength in interface PartitionIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

Returns:

the byte offset prior to the dimensional index

createMetaData

public List<IndexMetaData> createMetaData()

Specified by:

createMetaData in interface IndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

getCoordinateRangesPerDimension

public MultiDimensionalCoordinateRanges[] getCoordinateRangesPerDimension(MultiDimensionalNumericData dataRange,
                                                                          IndexMetaData... hints)

Description copied from interface: NumericIndexStrategy

Return an integer coordinate range in each dimension for the given data range plus a bin ID if that dimension is continuous

Specified by:

getCoordinateRangesPerDimension in interface NumericIndexStrategy

Parameters:

dataRange - the range to determine the coordinates for

hints - index hints

Returns:

the integer coordinate ranges that the given data ID represents and associated bin IDs if a dimension is continuous

getInsertionPartitionKeys

public byte[][] getInsertionPartitionKeys(MultiDimensionalNumericData insertionData)

Specified by:

getInsertionPartitionKeys in interface PartitionIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

getQueryPartitionKeys

public byte[][] getQueryPartitionKeys(MultiDimensionalNumericData queryData,
                                      IndexMetaData... hints)

Specified by:

getQueryPartitionKeys in interface PartitionIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>

getPredefinedSplits

public byte[][] getPredefinedSplits()

Specified by:

getPredefinedSplits in interface PartitionIndexStrategy<MultiDimensionalNumericData,MultiDimensionalNumericData>