org.apache.druid.segment.column

Class ColumnCapabilitiesImpl

java.lang.Object

org.apache.druid.segment.column.ColumnCapabilitiesImpl

All Implemented Interfaces:

ColumnCapabilities, TypeSignature<ValueType>

public class ColumnCapabilitiesImpl
extends Object
implements ColumnCapabilities

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.druid.segment.column.ColumnCapabilities

ColumnCapabilities.Capable, ColumnCapabilities.CoercionLogic

Constructor Summary

Constructors

Constructor and Description
ColumnCapabilitiesImpl()

Method Summary

Modifier and Type	Method and Description
ColumnCapabilities.Capable	areDictionaryValuesSorted() If the column is dictionary encoded, are those values sorted? Useful to know for optimizations that can defer looking up values and allowing sorting with the dictionary ids directly
ColumnCapabilities.Capable	areDictionaryValuesUnique() If the column is dictionary encoded, is there a 1:1 mapping of dictionary ids to values? If this is true, it unlocks optimizations such as allowing for things like grouping directly on dictionary ids and deferred value lookup
static ColumnCapabilitiesImpl	copyOf(ColumnCapabilities other)
static ColumnCapabilitiesImpl	createDefault() Creates a ColumnCapabilitiesImpl where all ColumnCapabilities.Capable that default to unknown instead are coerced to true or false
static ColumnCapabilitiesImpl	createSimpleArrayColumnCapabilities(TypeSignature<ValueType> valueType) Similar to createSimpleNumericColumnCapabilities(org.apache.druid.segment.column.TypeSignature<org.apache.druid.segment.column.ValueType>) except hasNulls is not set
static ColumnCapabilitiesImpl	createSimpleNumericColumnCapabilities(TypeSignature<ValueType> valueType) Create a no frills, simple column with ValueType set and everything else false
static ColumnCapabilitiesImpl	createSimpleSingleValueStringColumnCapabilities() Simple, single valued, non dictionary encoded string without bitmap index or anything fancy
String	getComplexTypeName()
TypeSignature<ValueType>	getElementType()
ValueType	getType() Column type, good to know so caller can know what to expect and which optimal selector to use
boolean	hasBitmapIndexes() Does the column have an inverted index bitmap for each value? If so, these may be employed to 'pre-filter' the column by examining if the values match the filter and intersecting the bitmaps, to avoid having to scan and evaluate if every row matches the filter
ColumnCapabilities.Capable	hasMultipleValues() String columns are sneaky, and might have multiple values, this is to allow callers to know and appropriately prepare themselves
ColumnCapabilities.Capable	hasNulls() Does this column contain null values? If so, callers, especially for primitive numeric columns, will need to check for null value rows and act accordingly
boolean	hasSpatialIndexes() Does the column have spatial indexes available to allow use with spatial filtering?
ColumnCapabilities.Capable	isDictionaryEncoded() Is the column dictionary encoded? If so, a DimensionDictionarySelector may be used instead of using a value selector, allowing algorithms to operate on primitive integer dictionary ids rather than the looked up dictionary values
boolean	isFilterable() All Druid primitive columns support filtering, maybe with or without indexes, but by default complex columns do not support direct filtering, unless provided by through a custom implementation.
ColumnCapabilitiesImpl	setDictionaryEncoded(boolean dictionaryEncoded)
ColumnCapabilitiesImpl	setDictionaryValuesSorted(boolean dictionaryValuesSorted)
ColumnCapabilitiesImpl	setDictionaryValuesUnique(boolean dictionaryValuesUnique)
ColumnCapabilitiesImpl	setFilterable(boolean filterable)
ColumnCapabilitiesImpl	setHasBitmapIndexes(boolean hasInvertedIndexes)
ColumnCapabilitiesImpl	setHasMultipleValues(boolean hasMultipleValues)
ColumnCapabilitiesImpl	setHasNulls(boolean hasNulls)
ColumnCapabilitiesImpl	setHasNulls(ColumnCapabilities.Capable hasNulls)
ColumnCapabilitiesImpl	setHasSpatialIndexes(boolean hasSpatialIndexes)
ColumnCapabilitiesImpl	setType(ColumnType type)
ColumnCapabilitiesImpl	setType(TypeSignature<ValueType> type)
static ColumnCapabilitiesImpl	snapshot(ColumnCapabilities capabilities, ColumnCapabilities.CoercionLogic coerce) Copy a ColumnCapabilities and coerce all ColumnCapabilities.Capable.UNKNOWN to ColumnCapabilities.Capable.TRUE or ColumnCapabilities.Capable.FALSE as specified by ColumnCapabilities.CoercionLogic

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.druid.segment.column.ColumnCapabilities

getStrategy, toColumnType

Methods inherited from interface org.apache.druid.segment.column.TypeSignature

anyOf, asTypeString, getNullableStrategy, is, isArray, isNumeric, isPrimitive

Constructor Detail

ColumnCapabilitiesImpl

public ColumnCapabilitiesImpl()

Method Detail

copyOf

public static ColumnCapabilitiesImpl copyOf(@Nullable
                                            ColumnCapabilities other)

snapshot

@Nullable
public static ColumnCapabilitiesImpl snapshot(@Nullable
                                                        ColumnCapabilities capabilities,
                                                        ColumnCapabilities.CoercionLogic coerce)

Copy a ColumnCapabilities and coerce all ColumnCapabilities.Capable.UNKNOWN to ColumnCapabilities.Capable.TRUE or ColumnCapabilities.Capable.FALSE as specified by ColumnCapabilities.CoercionLogic

createDefault

public static ColumnCapabilitiesImpl createDefault()

Creates a ColumnCapabilitiesImpl where all ColumnCapabilities.Capable that default to unknown instead are coerced to true or false

createSimpleNumericColumnCapabilities

public static ColumnCapabilitiesImpl createSimpleNumericColumnCapabilities(TypeSignature<ValueType> valueType)

Create a no frills, simple column with ValueType set and everything else false

createSimpleSingleValueStringColumnCapabilities

public static ColumnCapabilitiesImpl createSimpleSingleValueStringColumnCapabilities()

Simple, single valued, non dictionary encoded string without bitmap index or anything fancy

createSimpleArrayColumnCapabilities

public static ColumnCapabilitiesImpl createSimpleArrayColumnCapabilities(TypeSignature<ValueType> valueType)

Similar to createSimpleNumericColumnCapabilities(org.apache.druid.segment.column.TypeSignature<org.apache.druid.segment.column.ValueType>) except hasNulls is not set

getType

@Nullable
public ValueType getType()

Description copied from interface: ColumnCapabilities

Column type, good to know so caller can know what to expect and which optimal selector to use

Specified by:

getType in interface ColumnCapabilities

Specified by:

getType in interface TypeSignature<ValueType>

getComplexTypeName

@Nullable
public String getComplexTypeName()

Specified by:

getComplexTypeName in interface ColumnCapabilities

Specified by:

getComplexTypeName in interface TypeSignature<ValueType>

getElementType

@Nullable
public TypeSignature<ValueType> getElementType()

Specified by:

getElementType in interface ColumnCapabilities

Specified by:

getElementType in interface TypeSignature<ValueType>

setType

public ColumnCapabilitiesImpl setType(ColumnType type)

setType

public ColumnCapabilitiesImpl setType(TypeSignature<ValueType> type)

isDictionaryEncoded

public ColumnCapabilities.Capable isDictionaryEncoded()

Description copied from interface: ColumnCapabilities

Is the column dictionary encoded? If so, a DimensionDictionarySelector may be used instead of using a value selector, allowing algorithms to operate on primitive integer dictionary ids rather than the looked up dictionary values

Specified by:

isDictionaryEncoded in interface ColumnCapabilities

setDictionaryEncoded

public ColumnCapabilitiesImpl setDictionaryEncoded(boolean dictionaryEncoded)

areDictionaryValuesSorted

public ColumnCapabilities.Capable areDictionaryValuesSorted()

Description copied from interface: ColumnCapabilities

If the column is dictionary encoded, are those values sorted? Useful to know for optimizations that can defer looking up values and allowing sorting with the dictionary ids directly

Specified by:

areDictionaryValuesSorted in interface ColumnCapabilities

setDictionaryValuesSorted

public ColumnCapabilitiesImpl setDictionaryValuesSorted(boolean dictionaryValuesSorted)

areDictionaryValuesUnique

public ColumnCapabilities.Capable areDictionaryValuesUnique()

Description copied from interface: ColumnCapabilities

If the column is dictionary encoded, is there a 1:1 mapping of dictionary ids to values? If this is true, it unlocks optimizations such as allowing for things like grouping directly on dictionary ids and deferred value lookup

Specified by:

areDictionaryValuesUnique in interface ColumnCapabilities

setDictionaryValuesUnique

public ColumnCapabilitiesImpl setDictionaryValuesUnique(boolean dictionaryValuesUnique)

hasBitmapIndexes

public boolean hasBitmapIndexes()

Description copied from interface: ColumnCapabilities

Does the column have an inverted index bitmap for each value? If so, these may be employed to 'pre-filter' the column by examining if the values match the filter and intersecting the bitmaps, to avoid having to scan and evaluate if every row matches the filter

Specified by:

hasBitmapIndexes in interface ColumnCapabilities

setHasBitmapIndexes

public ColumnCapabilitiesImpl setHasBitmapIndexes(boolean hasInvertedIndexes)

hasSpatialIndexes

public boolean hasSpatialIndexes()

Description copied from interface: ColumnCapabilities

Does the column have spatial indexes available to allow use with spatial filtering?

Specified by:

hasSpatialIndexes in interface ColumnCapabilities

setHasSpatialIndexes

public ColumnCapabilitiesImpl setHasSpatialIndexes(boolean hasSpatialIndexes)

hasMultipleValues

public ColumnCapabilities.Capable hasMultipleValues()

Description copied from interface: ColumnCapabilities

String columns are sneaky, and might have multiple values, this is to allow callers to know and appropriately prepare themselves

Specified by:

hasMultipleValues in interface ColumnCapabilities

setHasMultipleValues

public ColumnCapabilitiesImpl setHasMultipleValues(boolean hasMultipleValues)

hasNulls

public ColumnCapabilities.Capable hasNulls()

Description copied from interface: ColumnCapabilities

Does this column contain null values? If so, callers, especially for primitive numeric columns, will need to check for null value rows and act accordingly

Specified by:

hasNulls in interface ColumnCapabilities

setHasNulls

public ColumnCapabilitiesImpl setHasNulls(boolean hasNulls)

setHasNulls

public ColumnCapabilitiesImpl setHasNulls(ColumnCapabilities.Capable hasNulls)

isFilterable

public boolean isFilterable()

Description copied from interface: ColumnCapabilities

All Druid primitive columns support filtering, maybe with or without indexes, but by default complex columns do not support direct filtering, unless provided by through a custom implementation.

Specified by:

isFilterable in interface ColumnCapabilities

setFilterable

public ColumnCapabilitiesImpl setFilterable(boolean filterable)