Package org.apache.druid.segment.nested

Class CompressedNestedDataComplexColumn<TKeyDictionary extends Indexed<ByteBuffer>,TStringDictionary extends Indexed<ByteBuffer>>

java.lang.Object

org.apache.druid.segment.nested.NestedDataComplexColumn

org.apache.druid.segment.nested.CompressedNestedDataComplexColumn<TKeyDictionary,TStringDictionary>

All Implemented Interfaces:

Closeable, AutoCloseable, BaseColumn, ComplexColumn, SelectableColumn, NestedColumnIndexSupplier, NestedColumnSelectorFactory, NestedColumnTypeInspector, NestedCommonFormatColumn, NestedVectorColumnSelectorFactory

Direct Known Subclasses:

NestedDataColumnV3, NestedDataColumnV4, NestedDataColumnV5

public abstract class CompressedNestedDataComplexColumn<TKeyDictionary extends Indexed<ByteBuffer>,TStringDictionary extends Indexed<ByteBuffer>>
extends NestedDataComplexColumn
implements NestedCommonFormatColumn

Implementation of NestedDataComplexColumn which uses a CompressedVariableSizedBlobColumn for the 'raw' StructuredData values and provides selectors for nested field columns specified by ordered lists of NestedPathPart.

The list of available nested paths is stored in fieldsSupplier, and their associated types stored in fieldInfo which can be accessed by the index of the field in fieldsSupplier.

In the case that the nested column has only a single field, and that field is the 'root' path, specified by rootFieldPath, the selectors created for the complex column itself will use the 'root' path selectors instead.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.druid.segment.nested.NestedCommonFormatColumn

NestedCommonFormatColumn.Format

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.druid.segment.nested.CompressedNestedDataComplexColumn.IntTypeStrategy	INT_TYPE_STRATEGY

Constructor Summary

Constructors

Constructor

Description

CompressedNestedDataComplexColumn(String columnName, ColumnType logicalType, ColumnConfig columnConfig, CompressedVariableSizedBlobColumnSupplier compressedRawColumnSupplier, ImmutableBitmap nullValues, com.google.common.base.Supplier<TKeyDictionary> fieldsSupplier, FieldTypeInfo fieldInfo, com.google.common.base.Supplier<TStringDictionary> stringDictionary, com.google.common.base.Supplier<FixedIndexed<Long>> longDictionarySupplier, com.google.common.base.Supplier<FixedIndexed<Double>> doubleDictionarySupplier, com.google.common.base.Supplier<FrontCodedIntArrayIndexed> arrayDictionarySupplier, SegmentFileMapper fileMapper, NestedCommonFormatColumnFormatSpec formatSpec, ByteOrder byteOrder, String rootFieldPath)

Method Summary

Modifier and Type	Method	Description
<T> T	as(Class<T> clazz)	Request an implementation of a particular interface.
void	close()	Close and release any resources associated with this column.
Indexed<Object[]>	getArrayDictionary()
BaseColumnHolder	getColumnHolder(List<NestedPathPart> path)	Get a BaseColumnHolder for a nested field column to retrieve metadata, the column itself, or indexes.
ColumnIndexSupplier	getColumnIndexSupplier(List<NestedPathPart> path)	Make a ColumnIndexSupplier for a nested field column.
Indexed<Double>	getDoubleDictionary()
abstract String	getField(List<NestedPathPart> path)
abstract String	getFieldFileName(String fileNameBase, String field, int fieldIndex)
ColumnType	getFieldLogicalType(List<NestedPathPart> path)	Reduces NestedColumnTypeInspector.getFieldTypes(List) for the nested field column using ColumnType.leastRestrictiveType(ColumnType, ColumnType)
SortedMap<String,FieldTypeInfo.MutableTypeSet>	getFieldTypeInfo()
Set<ColumnType>	getFieldTypes(List<NestedPathPart> path)	Get all ColumnType for the nested field column
int	getLength()
ColumnType	getLogicalType()
Indexed<Long>	getLongDictionary()
List<List<NestedPathPart>>	getNestedFields()	Get list of fields represented as a sequence of NestedPathPart
ImmutableBitmap	getNullValues()
Object	getRowValue(int rowNum)	Return rows in the column.
Indexed<String>	getStringDictionary()
TStringDictionary	getUtf8BytesDictionary()
boolean	isNumeric(List<NestedPathPart> path)	Shortcut to check if a nested field column is TypeSignature.isNumeric(), useful when broadly choosing the type of vector selector to be used when dealing with the path
ColumnValueSelector<?>	makeColumnValueSelector(List<NestedPathPart> path, ColumnSelectorFactory selectorFactory, ReadableOffset readableOffset)	Create a selector for a nested path.
ColumnValueSelector<?>	makeColumnValueSelector(ReadableOffset offset)	Optionally overridden when complex column serialization is not based on default serialization based on GenericIndexed in ComplexColumnSerializer.
DimensionSelector	makeDimensionSelector(List<NestedPathPart> path, ExtractionFn extractionFn, ColumnSelectorFactory selectorFactory, ReadableOffset readableOffset)	Create a selector for a nested path.
SingleValueDimensionVectorSelector	makeSingleValueDimensionVectorSelector(List<NestedPathPart> path, VectorColumnSelectorFactory selectorFactory, ReadableVectorOffset readableOffset)	Make a SingleValueDimensionVectorSelector for a nested field column
VectorObjectSelector	makeVectorObjectSelector(List<NestedPathPart> path, VectorColumnSelectorFactory selectorFactory, ReadableVectorOffset readableOffset)	Create a selector for a nested path.
VectorObjectSelector	makeVectorObjectSelector(ReadableVectorOffset offset)
VectorValueSelector	makeVectorValueSelector(List<NestedPathPart> path, VectorColumnSelectorFactory selectorFactory, ReadableVectorOffset readableOffset)	Create a selector for a nested path.
VectorValueSelector	makeVectorValueSelector(ReadableVectorOffset offset)
abstract List<NestedPathPart>	parsePath(String path)

Methods inherited from class org.apache.druid.segment.nested.NestedDataComplexColumn

getClazz, getTypeName

Methods inherited from class java.lang.Object

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

Field Details

INT_TYPE_STRATEGY

public static final org.apache.druid.segment.nested.CompressedNestedDataComplexColumn.IntTypeStrategy INT_TYPE_STRATEGY

Constructor Details

CompressedNestedDataComplexColumn

public CompressedNestedDataComplexColumn(String columnName,
 ColumnType logicalType,
 ColumnConfig columnConfig,
 @Nullable
 CompressedVariableSizedBlobColumnSupplier compressedRawColumnSupplier,
 ImmutableBitmap nullValues,
 com.google.common.base.Supplier<TKeyDictionary> fieldsSupplier,
 FieldTypeInfo fieldInfo,
 com.google.common.base.Supplier<TStringDictionary> stringDictionary,
 com.google.common.base.Supplier<FixedIndexed<Long>> longDictionarySupplier,
 com.google.common.base.Supplier<FixedIndexed<Double>> doubleDictionarySupplier,
 @Nullable
 com.google.common.base.Supplier<FrontCodedIntArrayIndexed> arrayDictionarySupplier,
 SegmentFileMapper fileMapper,
 NestedCommonFormatColumnFormatSpec formatSpec,
 ByteOrder byteOrder,
 String rootFieldPath)

Method Details

parsePath

public abstract List<NestedPathPart> parsePath(String path)

getField

public abstract String getField(List<NestedPathPart> path)

getFieldFileName

public abstract String getFieldFileName(String fileNameBase,
 String field,
 int fieldIndex)

getFieldTypeInfo

public SortedMap<String,FieldTypeInfo.MutableTypeSet> getFieldTypeInfo()

Specified by:

getFieldTypeInfo in interface NestedCommonFormatColumn

getLogicalType

public ColumnType getLogicalType()

Specified by:

getLogicalType in interface NestedCommonFormatColumn

getNestedFields

public List<List<NestedPathPart>> getNestedFields()

Description copied from interface: NestedColumnTypeInspector

Get list of fields represented as a sequence of NestedPathPart

Specified by:

getNestedFields in interface NestedColumnTypeInspector

getUtf8BytesDictionary

public TStringDictionary getUtf8BytesDictionary()

getStringDictionary

public Indexed<String> getStringDictionary()

Specified by:

getStringDictionary in interface NestedCommonFormatColumn

getLongDictionary

public Indexed<Long> getLongDictionary()

Specified by:

getLongDictionary in interface NestedCommonFormatColumn

getDoubleDictionary

public Indexed<Double> getDoubleDictionary()

Specified by:

getDoubleDictionary in interface NestedCommonFormatColumn

getArrayDictionary

public Indexed<Object[]> getArrayDictionary()

Specified by:

getArrayDictionary in interface NestedCommonFormatColumn

getNullValues

public ImmutableBitmap getNullValues()

getRowValue

@Nullable
public Object getRowValue(int rowNum)

Description copied from interface: ComplexColumn

Return rows in the column.

Specified by:

getRowValue in interface ComplexColumn

Parameters:

rowNum - the row number

Returns:

row object of type same as ComplexColumn.getClazz() } at row number "rowNum" .

makeColumnValueSelector

public ColumnValueSelector<?> makeColumnValueSelector(ReadableOffset offset)

Description copied from interface: ComplexColumn

Optionally overridden when complex column serialization is not based on default serialization based on GenericIndexed in ComplexColumnSerializer.

Specified by:

makeColumnValueSelector in interface BaseColumn

Specified by:

makeColumnValueSelector in interface ComplexColumn

Parameters:

offset - object to retrieve row number

Returns:

the ColumnValueSelector object

makeVectorObjectSelector

public VectorObjectSelector makeVectorObjectSelector(ReadableVectorOffset offset)

Specified by:

makeVectorObjectSelector in interface BaseColumn

Specified by:

makeVectorObjectSelector in interface ComplexColumn

makeVectorValueSelector

public VectorValueSelector makeVectorValueSelector(ReadableVectorOffset offset)

Specified by:

makeVectorValueSelector in interface BaseColumn

getLength

public int getLength()

Specified by:

getLength in interface ComplexColumn

Returns:

serialized size (in bytes) of this column. -1 for unknown

close

public void close()

Description copied from interface: ComplexColumn

Close and release any resources associated with this column.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ComplexColumn

makeDimensionSelector

public DimensionSelector makeDimensionSelector(List<NestedPathPart> path,
 ExtractionFn extractionFn,
 ColumnSelectorFactory selectorFactory,
 ReadableOffset readableOffset)

Create a selector for a nested path.

Specified by:

makeDimensionSelector in interface NestedColumnSelectorFactory

Parameters:

path - the path

selectorFactory - unused

readableOffset - offset for the selector

extractionFn - extraction fn to apply in the selector

makeColumnValueSelector

public ColumnValueSelector<?> makeColumnValueSelector(List<NestedPathPart> path,
 ColumnSelectorFactory selectorFactory,
 ReadableOffset readableOffset)

Create a selector for a nested path.

Specified by:

makeColumnValueSelector in interface NestedColumnSelectorFactory

Parameters:

path - the path

selectorFactory - unused

readableOffset - offset for the selector

makeSingleValueDimensionVectorSelector

public SingleValueDimensionVectorSelector makeSingleValueDimensionVectorSelector(List<NestedPathPart> path,
 VectorColumnSelectorFactory selectorFactory,
 ReadableVectorOffset readableOffset)

Description copied from interface: NestedVectorColumnSelectorFactory

Make a SingleValueDimensionVectorSelector for a nested field column

Specified by:

makeSingleValueDimensionVectorSelector in interface NestedVectorColumnSelectorFactory

Parameters:

path - nested path, or empty list to read the root

selectorFactory - factory for underlying selectors, if needed

readableOffset - offset for the selector

makeVectorObjectSelector

public VectorObjectSelector makeVectorObjectSelector(List<NestedPathPart> path,
 VectorColumnSelectorFactory selectorFactory,
 ReadableVectorOffset readableOffset)

Create a selector for a nested path.

Specified by:

makeVectorObjectSelector in interface NestedVectorColumnSelectorFactory

Parameters:

path - the path

selectorFactory - unused

readableOffset - offset for the selector

makeVectorValueSelector

public VectorValueSelector makeVectorValueSelector(List<NestedPathPart> path,
 VectorColumnSelectorFactory selectorFactory,
 ReadableVectorOffset readableOffset)

Create a selector for a nested path.

Specified by:

makeVectorValueSelector in interface NestedVectorColumnSelectorFactory

Parameters:

path - the path

selectorFactory - unused

readableOffset - offset for the selector

getFieldTypes

@Nullable
public Set<ColumnType> getFieldTypes(List<NestedPathPart> path)

Description copied from interface: NestedColumnTypeInspector

Get all ColumnType for the nested field column

Specified by:

getFieldTypes in interface NestedColumnTypeInspector

getFieldLogicalType

@Nullable
public ColumnType getFieldLogicalType(List<NestedPathPart> path)

Description copied from interface: NestedColumnTypeInspector

Reduces NestedColumnTypeInspector.getFieldTypes(List) for the nested field column using ColumnType.leastRestrictiveType(ColumnType, ColumnType)

Specified by:

getFieldLogicalType in interface NestedColumnTypeInspector

getColumnHolder

@Nullable
public BaseColumnHolder getColumnHolder(List<NestedPathPart> path)

Description copied from class: NestedDataComplexColumn

Get a BaseColumnHolder for a nested field column to retrieve metadata, the column itself, or indexes.

Specified by:

getColumnHolder in class NestedDataComplexColumn

getColumnIndexSupplier

@Nullable
public ColumnIndexSupplier getColumnIndexSupplier(List<NestedPathPart> path)

Description copied from interface: NestedColumnIndexSupplier

Make a ColumnIndexSupplier for a nested field column. Returns null if the field does not exist. Returns NoIndexesColumnIndexSupplier.getInstance() if the field exists but has no indexes.

Specified by:

getColumnIndexSupplier in interface NestedColumnIndexSupplier

isNumeric

public boolean isNumeric(List<NestedPathPart> path)

Description copied from interface: NestedColumnTypeInspector

Shortcut to check if a nested field column is TypeSignature.isNumeric(), useful when broadly choosing the type of vector selector to be used when dealing with the path

Specified by:

isNumeric in interface NestedColumnTypeInspector

as

@Nullable
public <T> T as(Class<T> clazz)

Description copied from interface: SelectableColumn

Request an implementation of a particular interface. Physical nested columns, and virtual columns that act as a nested column, should implement:

• NestedColumnTypeInspector, required.
• NestedColumnSelectorFactory, required.
• NestedVectorColumnSelectorFactory, required.
• NestedColumnIndexSupplier, if the column has indexes.

Specified by:

as in interface SelectableColumn

Overrides:

as in class NestedDataComplexColumn

Type Parameters:

T - desired interface

Parameters:

clazz - desired interface

Returns:

instance of clazz, or null if the interface is not supported by this segment