package mil.nga.giat.geowave.core.index;

import mil.nga.giat.geowave.core.index.dimension.NumericDimensionDefinition;
import mil.nga.giat.geowave.core.index.sfc.data.MultiDimensionalNumericData;

/**
 * Interface which defines a numeric index strategy.
 * 
 */
public interface NumericIndexStrategy extends
		IndexStrategy<MultiDimensionalNumericData, MultiDimensionalNumericData>
{

	/**
	 * Return an integer coordinate in each dimension for the given insertion ID
	 * plus a bin ID if that dimension is continuous
	 * 
	 * @param insertionId
	 *            the insertion ID to determine the coordinates for
	 * @return the integer coordinate that the given insertion ID represents and
	 *         associated bin ID if that dimension is continuous
	 */
	public MultiDimensionalCoordinates getCoordinatesPerDimension(
			ByteArrayId insertionId );

	/**
	 * Return an integer coordinate range in each dimension for the given data
	 * range plus a bin ID if that dimension is continuous
	 * 
	 * @param dataRange
	 *            the range to determine the coordinates for
	 * @return the integer coordinate ranges that the given data ID represents
	 *         and associated bin IDs if a dimension is continuous
	 */
	public MultiDimensionalCoordinateRanges[] getCoordinateRangesPerDimension(
			MultiDimensionalNumericData dataRange,
			IndexMetaData... hints );

	/**
	 * 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
	 * 
	 * @return the ordered array of dimension definitions that represents this
	 *         index strategy
	 */
	public NumericDimensionDefinition[] getOrderedDimensionDefinitions();

	/***
	 * Get the range/size of a single insertion ID for each dimension at the
	 * highest precision supported by this index strategy
	 * 
	 * @return the range of a single insertion ID for each dimension
	 */
	public double[] getHighestPrecisionIdRangePerDimension();

	/***
	 * Get the offset in bytes before the dimensional index. This can accounts
	 * for tier IDs and bin IDs
	 * 
	 * @return the byte offset prior to the dimensional index
	 */
	public int getByteOffsetFromDimensionalIndex();

}