Package org.apache.druid.segment.nested

Class ScalarNestedCommonFormatColumnSerializer<T>

java.lang.Object

org.apache.druid.segment.nested.NestedCommonFormatColumnSerializer

org.apache.druid.segment.nested.ScalarNestedCommonFormatColumnSerializer<T>

All Implemented Interfaces:

GenericColumnSerializer<StructuredData>, Serializer

Direct Known Subclasses:

ScalarDoubleColumnSerializer, ScalarLongColumnSerializer, ScalarStringColumnSerializer

public abstract class ScalarNestedCommonFormatColumnSerializer<T>
extends NestedCommonFormatColumnSerializer

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	closedForWrite
protected final Closer	closer
protected final NestedCommonFormatColumnFormatSpec	columnFormatSpec
protected ByteBuffer	columnNameBytes
protected DictionaryIdLookup	dictionaryIdLookup
protected boolean	dictionarySerialized
protected DictionaryWriter<T>	dictionaryWriter
protected boolean	hasNulls
protected FixedIndexedIntWriter	intermediateValueWriter
protected static final Logger	log
protected final String	name
protected final SegmentWriteOutMedium	segmentWriteOutMedium
protected boolean	writeDictionary

Fields inherited from class org.apache.druid.segment.nested.NestedCommonFormatColumnSerializer

NESTED_FIELD_PREFIX, RAW_FILE_NAME, V0

Constructor Summary

Constructors

Constructor	Description
ScalarNestedCommonFormatColumnSerializer(String name, NestedCommonFormatColumnFormatSpec columnFormatSpec, SegmentWriteOutMedium segmentWriteOutMedium, Closer closer)

Method Summary

Modifier and Type	Method	Description
abstract int	getCardinality()
String	getColumnName()
DictionaryIdLookup	getDictionaryIdLookup()
long	getSerializedSize()	Returns the number of bytes, that this Serializer will write to the output _channel_ (not smoosher) on a Serializer.writeTo(java.nio.channels.WritableByteChannel, org.apache.druid.segment.file.SegmentFileBuilder) call.
boolean	hasNulls()
void	open()
protected abstract void	openValueColumnSerializer()	Called during open() to allow opening any separate type specific value column serializers
protected abstract int	processValue(Object rawValue)	Called during serialize(ColumnValueSelector) to convert value to dictionary id.
void	serialize(ColumnValueSelector<? extends StructuredData> selector)
void	setDictionaryIdLookup(DictionaryIdLookup dictionaryIdLookup)
protected abstract void	writeDictionaryFile(SegmentFileBuilder fileBuilder)
void	writeTo(WritableByteChannel channel, SegmentFileBuilder fileBuilder)	Writes the serialized form of this object.
protected abstract void	writeValueColumn(SegmentFileBuilder fileBuilder)	Called during Serializer.writeTo(WritableByteChannel, SegmentFileBuilder) to allow any type specific value column serializers to use the SegmentFileBuilder to write stuff to places.

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

computeFilenameBytes, copyFromTempSmoosh, openDictionaryWriter, serializeDictionaries, serializeFields, writeInternal, writeV0Header

Methods inherited from class java.lang.Object

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

Field Details

log

protected static final Logger log

name

protected final String name

segmentWriteOutMedium

protected final SegmentWriteOutMedium segmentWriteOutMedium

columnFormatSpec

protected final NestedCommonFormatColumnFormatSpec columnFormatSpec

closer

protected final Closer closer

dictionaryIdLookup

protected DictionaryIdLookup dictionaryIdLookup

dictionaryWriter

protected DictionaryWriter<T> dictionaryWriter

closedForWrite

protected boolean closedForWrite

dictionarySerialized

protected boolean dictionarySerialized

intermediateValueWriter

protected FixedIndexedIntWriter intermediateValueWriter

columnNameBytes

protected ByteBuffer columnNameBytes

hasNulls

protected boolean hasNulls

writeDictionary

protected boolean writeDictionary

Constructor Details

ScalarNestedCommonFormatColumnSerializer

public ScalarNestedCommonFormatColumnSerializer(String name,
 NestedCommonFormatColumnFormatSpec columnFormatSpec,
 SegmentWriteOutMedium segmentWriteOutMedium,
 Closer closer)

Method Details

processValue

protected abstract int processValue(@Nullable
 Object rawValue)
                             throws IOException

Called during serialize(ColumnValueSelector) to convert value to dictionary id.

Implementations may optionally also serialize the value to a type specific value column if they opened one with openValueColumnSerializer(), or do whatever else is useful to do while handling a single row value.

Throws:

IOException

openValueColumnSerializer

protected abstract void openValueColumnSerializer()
                                           throws IOException

Called during open() to allow opening any separate type specific value column serializers

Throws:

IOException

writeValueColumn

protected abstract void writeValueColumn(SegmentFileBuilder fileBuilder)
                                  throws IOException

Called during Serializer.writeTo(WritableByteChannel, SegmentFileBuilder) to allow any type specific value column serializers to use the SegmentFileBuilder to write stuff to places.

Throws:

IOException

writeDictionaryFile

protected abstract void writeDictionaryFile(SegmentFileBuilder fileBuilder)
                                     throws IOException

Throws:

IOException

getCardinality

public abstract int getCardinality()

getColumnName

public String getColumnName()

Specified by:

getColumnName in class NestedCommonFormatColumnSerializer

getDictionaryIdLookup

public DictionaryIdLookup getDictionaryIdLookup()

Specified by:

getDictionaryIdLookup in class NestedCommonFormatColumnSerializer

setDictionaryIdLookup

public void setDictionaryIdLookup(DictionaryIdLookup dictionaryIdLookup)

Specified by:

setDictionaryIdLookup in class NestedCommonFormatColumnSerializer

hasNulls

public boolean hasNulls()

Specified by:

hasNulls in class NestedCommonFormatColumnSerializer

open

public void open()
          throws IOException

Throws:

IOException

serialize

public void serialize(ColumnValueSelector<? extends StructuredData> selector)
               throws IOException

Throws:

IOException

getSerializedSize

public long getSerializedSize()

Description copied from interface: Serializer

Returns the number of bytes, that this Serializer will write to the output _channel_ (not smoosher) on a Serializer.writeTo(java.nio.channels.WritableByteChannel, org.apache.druid.segment.file.SegmentFileBuilder) call.

writeTo

public void writeTo(WritableByteChannel channel,
 SegmentFileBuilder fileBuilder)
             throws IOException

Description copied from interface: Serializer

Writes the serialized form of this object. The entire object may be written to the provided channel, or the object may be split over the provided channel and files added to the {@link SegmentFileBuilder], where additional channels can be created via SegmentFileBuilder.addWithChannel(String, long). The latter approach is useful when the serialized form of the object is too large for a single smoosh container. At the time this javadoc was written, the max smoosh container size is limit to the max ByteBuffer size.

Throws:

IOException