Class TypeStrategies.DoubleTypeStrategy
- java.lang.Object
-
- org.apache.druid.segment.column.TypeStrategies.DoubleTypeStrategy
-
- All Implemented Interfaces:
it.unimi.dsi.fastutil.Hash.Strategy<Double>,Comparator<Object>,TypeStrategy<Double>
- Enclosing class:
- TypeStrategies
public static final class TypeStrategies.DoubleTypeStrategy extends Object implements TypeStrategy<Double>
Read and write non-null DOUBLE values. If reading non-null values, consider just usingByteBuffer.getDouble()directly, or if reading values written withNullableTypeStrategy, usingTypeStrategies.isNullableNull(java.nio.ByteBuffer, int)andTypeStrategies.readNotNullNullableDouble(java.nio.ByteBuffer, int), both of which allow dealing in primitive double values instead of objects.
-
-
Constructor Summary
Constructors Constructor Description DoubleTypeStrategy()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcompare(Object o1, Object o2)booleanequals(Double a, Double b)intestimateSizeBytes(Double value)Estimate the size in bytes that writing this value to memory would require.booleangroupable()Whether the type is groupable or not.inthashCode(Double o)Doubleread(ByteBuffer buffer)Read a non-null value from theByteBufferat the currentBuffer.position().Doubleread(ByteBuffer buffer, int offset)Read a non-null value from theByteBufferat the requested position.booleanreadRetainsBufferReference()Whether theTypeStrategy.read(java.nio.ByteBuffer)methods return an object that may retain a reference to the providedByteBuffer.intwrite(ByteBuffer buffer, Double value, int maxSizeBytes)Write a non-null value to theByteBufferat positionBuffer.position().-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
Methods inherited from interface org.apache.druid.segment.column.TypeStrategy
fromBytes, write
-
-
-
-
Method Detail
-
estimateSizeBytes
public int estimateSizeBytes(Double value)
Description copied from interface:TypeStrategyEstimate the size in bytes that writing this value to memory would require. This method is not required to be exactly correct, but many implementations might be. Implementations should err on the side of over-estimating if exact sizing is not efficient. Example usage of this method is estimating heap memory usage for an aggregator or the amount of buffer which might need allocated to thenTypeStrategy.write(java.nio.ByteBuffer, T, int)a value- Specified by:
estimateSizeBytesin interfaceTypeStrategy<Double>
-
read
public Double read(ByteBuffer buffer)
Description copied from interface:TypeStrategyRead a non-null value from theByteBufferat the currentBuffer.position(). This will move the underlying position by the size of the value read. The value returned from this method may retain a reference to the providedByteBuffer. If it does, thenTypeStrategy.readRetainsBufferReference()returns true.- Specified by:
readin interfaceTypeStrategy<Double>
-
read
public Double read(ByteBuffer buffer, int offset)
Description copied from interface:TypeStrategyRead a non-null value from theByteBufferat the requested position. This will not permanently move the underlyingBuffer.position(), but may temporarily modify the buffer position during reading so cannot be considered thread safe usage of the buffer. The contract of this method is that any value returned from this method MUST be completely detached from the underlyingByteBuffer, since it might outlive the memory location being allocated to hold the object. In other words, if an object is memory mapped, it must be copied on heap, or relocated to another memory location that is owned by the caller withTypeStrategy.write(java.nio.ByteBuffer, T, int).- Specified by:
readin interfaceTypeStrategy<Double>
-
groupable
public boolean groupable()
Description copied from interface:TypeStrategyWhether the type is groupable or not. This is always true for all the primitive types, arrays, and nested arrays therefore the SQL and the native layer might ignore this flag for those types. For complex types, this flag can be true or false, depending on whether the semantics and implementation of the type naturally leads to groupability or not. For example, it makes sense for JSON columns to be groupable, however there is little sense in grouping sketches (before finalizing).If a type is groupable, following statements MUST hold:
a.
TypeStrategy.equals(Object, Object)must be implemented. It should return true if and only if two objects are equal and can be grouped together.b.
TypeStrategy.hashCode(Object)must be implemented, and must be consistent with equals. It should return a hashCode for the given object. For two objects that are equal, it must return the same hash value. For two objects that are not equal, it can return the same hash value (or not). A conscious effort must be made to minimise collisions between the hash values of two non-equal objects for faster grouping.c.
Comparator.compare(Object, Object)must be consistent with equals. Apart from abiding by the definition ofComparator.compare(T, T), it must not return 0 for two objects that are not equals, and converse must also hold, i.e. if the value returned by compare is not zero, then the arguments must not be equal.- Specified by:
groupablein interfaceTypeStrategy<Double>
-
readRetainsBufferReference
public boolean readRetainsBufferReference()
Description copied from interface:TypeStrategyWhether theTypeStrategy.read(java.nio.ByteBuffer)methods return an object that may retain a reference to the providedByteBuffer. If a reference is sometimes retained, this method returns true. It returns false if, and only if, a reference is *never* retained.- Specified by:
readRetainsBufferReferencein interfaceTypeStrategy<Double>
-
write
public int write(ByteBuffer buffer, Double value, int maxSizeBytes)
Description copied from interface:TypeStrategyWrite a non-null value to theByteBufferat positionBuffer.position(). This will move the underlying position by the size of the value written. This method returns the number of bytes written. If writing the value would take more than 'maxSizeBytes', this method will return a negative value indicating the number of additional bytes that would be required to fully write the value. Partial results may be written to the buffer when in this state, and the position may be left at whatever point the implementation ran out of space while writing the value. Callers should save the starting position if it is necessary to 'rewind' after a partial write. Callers MUST check that the return value is positive which indicates a successful write, while a negative response a partial write.- Specified by:
writein interfaceTypeStrategy<Double>- Returns:
- number of bytes written
-
compare
public int compare(Object o1, Object o2)
- Specified by:
comparein interfaceComparator<Object>
-
hashCode
public int hashCode(Double o)
- Specified by:
hashCodein interfaceit.unimi.dsi.fastutil.Hash.Strategy<Double>- Specified by:
hashCodein interfaceTypeStrategy<Double>- See Also:
TypeStrategy.groupable()
-
equals
public boolean equals(Double a, Double b)
- Specified by:
equalsin interfaceit.unimi.dsi.fastutil.Hash.Strategy<Double>- Specified by:
equalsin interfaceTypeStrategy<Double>- See Also:
TypeStrategy.groupable()
-
-