Package org.apache.druid.segment.column

Interface ComplexColumn

All Superinterfaces:

AutoCloseable, BaseColumn, Closeable, SelectableColumn

All Known Implementing Classes:

CompressedComplexColumn, CompressedNestedDataComplexColumn, GenericIndexedBasedComplexColumn, NestedDataColumnV3, NestedDataColumnV4, NestedDataColumnV5, NestedDataComplexColumn, SerializablePairLongDoubleComplexColumn, SerializablePairLongFloatComplexColumn, SerializablePairLongLongComplexColumn, SerializablePairLongStringComplexColumn, UnknownTypeComplexColumn

public interface ComplexColumn
extends BaseColumn

This interface represents a complex column and can be implemented by druid extension writer of a custom column with arbitrary serialization instead of a custom column that serializes rows of objects serialized using GenericIndexed class which is default implementation of "writeToXXX" methods in ComplexColumnSerializer. In that case GenericIndexedBasedComplexColumn should be used.

Method Summary

Modifier and Type	Method	Description
void	close()	Close and release any resources associated with this column.
Class<?>	getClazz()
int	getLength()
Object	getRowValue(int rowNum)	Return rows in the column.
String	getTypeName()
default ColumnValueSelector<?>	makeColumnValueSelector(ReadableOffset offset)	Optionally overridden when complex column serialization is not based on default serialization based on GenericIndexed in ComplexColumnSerializer.
default VectorObjectSelector	makeVectorObjectSelector(ReadableVectorOffset offset)

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

makeVectorValueSelector

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

as

Method Details

getClazz

Class<?> getClazz()

Returns:

Class of objects returned on calls to getRowValue(int) .

getTypeName

String getTypeName()

Returns:

Typename associated with this column.

getRowValue

@Nullable
Object getRowValue(int rowNum)

Return rows in the column.

Parameters:

rowNum - the row number

Returns:

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

getLength

int getLength()

Returns:

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

close

void close()

Close and release any resources associated with this column.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

makeColumnValueSelector

default ColumnValueSelector<?> makeColumnValueSelector(ReadableOffset offset)

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

Specified by:

makeColumnValueSelector in interface BaseColumn

Parameters:

offset - object to retrieve row number

Returns:

the ColumnValueSelector object

makeVectorObjectSelector

default VectorObjectSelector makeVectorObjectSelector(ReadableVectorOffset offset)

Specified by:

makeVectorObjectSelector in interface BaseColumn