org.apache.druid.segment

Class DimensionHandlerUtils

java.lang.Object

org.apache.druid.segment.DimensionHandlerUtils

public final class DimensionHandlerUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static ColumnCapabilities	DEFAULT_STRING_CAPABILITIES
static Double	ZERO_DOUBLE
static Float	ZERO_FLOAT
static Long	ZERO_LONG

Method Summary

Modifier and Type	Method and Description
static int	compareObjectsAsType(Object lhs, Object rhs, ValueType type)
static Function<Object,Comparable<?>>	converterFromTypeToType(ValueType fromType, ValueType toType)
static Double	convertObjectToDouble(Object valObj)
static Double	convertObjectToDouble(Object valObj, boolean reportParseExceptions)
static Float	convertObjectToFloat(Object valObj)
static Float	convertObjectToFloat(Object valObj, boolean reportParseExceptions)
static Long	convertObjectToLong(Object valObj)
static Long	convertObjectToLong(Object valObj, boolean reportParseExceptions)
static String	convertObjectToString(Object valObj)
static Comparable<?>	convertObjectToType(Object obj, ValueType type)
static Comparable<?>	convertObjectToType(Object obj, ValueType type, boolean reportParseExceptions)
static <Strategy extends ColumnSelectorStrategy> ColumnSelectorPlus<Strategy>	createColumnSelectorPlus(ColumnSelectorStrategyFactory<Strategy> strategyFactory, DimensionSpec dimensionSpec, ColumnSelectorFactory cursor) Convenience function equivalent to calling createColumnSelectorPluses(ColumnSelectorStrategyFactory, List, ColumnSelectorFactory) with a singleton list of dimensionSpecs and then retrieving the only element in the returned array.
static <Strategy extends ColumnSelectorStrategy> ColumnSelectorPlus<Strategy>[]	createColumnSelectorPluses(ColumnSelectorStrategyFactory<Strategy> strategyFactory, List<DimensionSpec> dimensionSpecs, ColumnSelectorFactory columnSelectorFactory) Creates an array of ColumnSelectorPlus objects, selectors that handle type-specific operations within query processing engines, using a strategy factory provided by the query engine.
static Long	getExactLongFromDecimalString(String decimalStr) Convert a string representing a decimal value to a long.
static DimensionHandler<?,?,?>	getHandlerFromCapabilities(String dimensionName, ColumnCapabilities capabilities, DimensionSchema.MultiValueHandling multiValueHandling)
static List<ValueType>	getValueTypesFromDimensionSpecs(List<DimensionSpec> dimSpecs)
static <T> T	makeVectorProcessor(DimensionSpec dimensionSpec, VectorColumnProcessorFactory<T> strategyFactory, VectorColumnSelectorFactory selectorFactory) Creates "vector processors", which are objects that wrap a single vectorized input column and provide some functionality on top of it.
static <T> T	makeVectorProcessor(String column, VectorColumnProcessorFactory<T> strategyFactory, VectorColumnSelectorFactory selectorFactory) Equivalent to calling makeVectorProcessor(DefaultDimensionSpec.of(column), strategyFactory, selectorFactory).
static Double	nullToZero(Double number)
static Float	nullToZero(Float number)
static Long	nullToZero(Long number)

Methods inherited from class java.lang.Object

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

Field Detail

ZERO_DOUBLE

public static final Double ZERO_DOUBLE

ZERO_FLOAT

public static final Float ZERO_FLOAT

ZERO_LONG

public static final Long ZERO_LONG

DEFAULT_STRING_CAPABILITIES

public static final ColumnCapabilities DEFAULT_STRING_CAPABILITIES

Method Detail

getHandlerFromCapabilities

public static DimensionHandler<?,?,?> getHandlerFromCapabilities(String dimensionName,
                                                                 @Nullable
                                                                 ColumnCapabilities capabilities,
                                                                 @Nullable
                                                                 DimensionSchema.MultiValueHandling multiValueHandling)

getValueTypesFromDimensionSpecs

public static List<ValueType> getValueTypesFromDimensionSpecs(List<DimensionSpec> dimSpecs)

createColumnSelectorPlus

public static <Strategy extends ColumnSelectorStrategy> ColumnSelectorPlus<Strategy> createColumnSelectorPlus(ColumnSelectorStrategyFactory<Strategy> strategyFactory,
                                                                                                              DimensionSpec dimensionSpec,
                                                                                                              ColumnSelectorFactory cursor)

Convenience function equivalent to calling createColumnSelectorPluses(ColumnSelectorStrategyFactory, List, ColumnSelectorFactory) with a singleton list of dimensionSpecs and then retrieving the only element in the returned array.

Type Parameters:

Strategy - The strategy type created by the provided strategy factory.

Parameters:

strategyFactory - A factory provided by query engines that generates type-handling strategies

dimensionSpec - column to generate a ColumnSelectorPlus object for

cursor - Used to create value selectors for columns.

Returns:

A ColumnSelectorPlus object

See Also:

which may replace this in the future

createColumnSelectorPluses

public static <Strategy extends ColumnSelectorStrategy> ColumnSelectorPlus<Strategy>[] createColumnSelectorPluses(ColumnSelectorStrategyFactory<Strategy> strategyFactory,
                                                                                                                  List<DimensionSpec> dimensionSpecs,
                                                                                                                  ColumnSelectorFactory columnSelectorFactory)

Creates an array of ColumnSelectorPlus objects, selectors that handle type-specific operations within query processing engines, using a strategy factory provided by the query engine. One ColumnSelectorPlus will be created for each column specified in dimensionSpecs. The ColumnSelectorPlus provides access to a type strategy (e.g., how to group on a float column) and a value selector for a single column. A caller should define a strategy factory that provides an interface for type-specific operations in a query engine. See GroupByStrategyFactory for a reference.

Type Parameters:

Strategy - The strategy type created by the provided strategy factory.

Parameters:

strategyFactory - A factory provided by query engines that generates type-handling strategies

dimensionSpecs - The set of columns to generate ColumnSelectorPlus objects for

columnSelectorFactory - Used to create value selectors for columns.

Returns:

An array of ColumnSelectorPlus objects, in the order of the columns specified in dimensionSpecs

See Also:

which may replace this in the future

makeVectorProcessor

public static <T> T makeVectorProcessor(String column,
                                        VectorColumnProcessorFactory<T> strategyFactory,
                                        VectorColumnSelectorFactory selectorFactory)

Equivalent to calling makeVectorProcessor(DefaultDimensionSpec.of(column), strategyFactory, selectorFactory).

See Also:

makeVectorProcessor(DimensionSpec, VectorColumnProcessorFactory, VectorColumnSelectorFactory), the non-vectorized version

makeVectorProcessor

public static <T> T makeVectorProcessor(DimensionSpec dimensionSpec,
                                        VectorColumnProcessorFactory<T> strategyFactory,
                                        VectorColumnSelectorFactory selectorFactory)

Creates "vector processors", which are objects that wrap a single vectorized input column and provide some functionality on top of it. Used by things like query engines and filter matchers. Supports the basic types STRING, LONG, DOUBLE, and FLOAT.

Parameters:

dimensionSpec - dimensionSpec for the input to the processor

strategyFactory - object that encapsulates the knowledge about how to create processors

selectorFactory - column selector factory used for creating the vector processor

See Also:

the non-vectorized version

convertObjectToString

@Nullable
public static String convertObjectToString(@Nullable
                                                     Object valObj)

convertObjectToLong

@Nullable
public static Long convertObjectToLong(@Nullable
                                                 Object valObj)

convertObjectToLong

@Nullable
public static Long convertObjectToLong(@Nullable
                                                 Object valObj,
                                                 boolean reportParseExceptions)

convertObjectToFloat

@Nullable
public static Float convertObjectToFloat(@Nullable
                                                   Object valObj)

convertObjectToFloat

@Nullable
public static Float convertObjectToFloat(@Nullable
                                                   Object valObj,
                                                   boolean reportParseExceptions)

convertObjectToType

@Nullable
public static Comparable<?> convertObjectToType(@Nullable
                                                          Object obj,
                                                          ValueType type,
                                                          boolean reportParseExceptions)

compareObjectsAsType

public static int compareObjectsAsType(@Nullable
                                       Object lhs,
                                       @Nullable
                                       Object rhs,
                                       ValueType type)

convertObjectToType

@Nullable
public static Comparable<?> convertObjectToType(@Nullable
                                                          Object obj,
                                                          ValueType type)

converterFromTypeToType

public static Function<Object,Comparable<?>> converterFromTypeToType(ValueType fromType,
                                                                     ValueType toType)

convertObjectToDouble

@Nullable
public static Double convertObjectToDouble(@Nullable
                                                     Object valObj)

convertObjectToDouble

@Nullable
public static Double convertObjectToDouble(@Nullable
                                                     Object valObj,
                                                     boolean reportParseExceptions)

getExactLongFromDecimalString

@Nullable
public static Long getExactLongFromDecimalString(String decimalStr)

Convert a string representing a decimal value to a long. If the decimal value is not an exact integral value (e.g. 42.0), or if the decimal value is too large to be contained within a long, this function returns null.

Parameters:

decimalStr - string representing a decimal value

Returns:

long equivalent of decimalStr, returns null for non-integral decimals and integral decimal values outside of the values representable by longs

nullToZero

public static Double nullToZero(@Nullable
                                Double number)

nullToZero

public static Long nullToZero(@Nullable
                              Long number)

nullToZero

public static Float nullToZero(@Nullable
                               Float number)