@EverythingIsNonnullByDefault

Package org.apache.druid.segment

Interface Summary

Interface	Description
BaseDoubleColumnValueSelector	Double value selecting polymorphic "part" of the ColumnValueSelector interface.
BaseFloatColumnValueSelector	Float value selecting polymorphic "part" of the ColumnValueSelector interface.
BaseLongColumnValueSelector	Long value selecting polymorphic "part" of the ColumnValueSelector interface.
BaseNullableColumnValueSelector	Null value checking polymorphic "part" of the ColumnValueSelector interface for primitive values.
BaseObjectColumnValueSelector<T>	Object value selecting polymorphic "part" of the ColumnValueSelector interface.
CloseableShapeshifter	A CloseableShapeshifter is an interface created to allow Segments to be used from CloseableShapeshifter.as(Class), but also to be able to ensure that any resource used by the object returned from the CloseableShapeshifter.as(Class) method have proper management of their lifecycle.
ColumnInspector
ColumnProcessorFactory<T>	Class that encapsulates knowledge about how to create "column processors", which are...
ColumnSelector
ColumnSelectorFactory	Factory class for MetricSelectors
ColumnValueSelector<T>	Base type for interfaces that manage column value selection, e.g.
Cursor	Cursor is an interface for iteration over a range of data points, used during query execution.
CursorFactory	Interface extended by StorageAdapter, which gives them the power to create cursors.
DictionaryEncodedColumnMerger.ExtendedIndexesMerger	Specifies any additional per value indexes which should be constructed when DictionaryEncodedColumnMerger.writeIndexes(List) is called, on top of the standard bitmap index created with DictionaryEncodedColumnMerger.mergeBitmaps(java.util.List<java.nio.IntBuffer>, org.apache.druid.collections.bitmap.BitmapFactory, org.apache.druid.segment.DictionaryEncodedColumnMerger.IndexSeeker[], int)
DictionaryEncodedColumnMerger.IndexSeeker
DimensionDictionarySelector	Interface containing dictionary-related methods common to DimensionSelector, SingleValueDimensionVectorSelector, and MultiValueDimensionVectorSelector.
DimensionHandler<EncodedType extends Comparable<EncodedType>,EncodedKeyComponentType,ActualType extends Comparable<ActualType>>	Processing related interface A DimensionHandler is an object that encapsulates indexing, column merging/building, and querying operations for a given dimension type (e.g., dict-encoded String, Long).
DimensionHandlerProvider<EncodedType extends Comparable<EncodedType>,EncodedKeyComponentType,ActualType extends Comparable<ActualType>>
DimensionIndexer<EncodedType extends Comparable<EncodedType>,EncodedKeyComponentType,ActualType extends Comparable<ActualType>>	Processing related interface A DimensionIndexer is a per-dimension stateful object that encapsulates type-specific operations and data structures used during the in-memory ingestion process (i.e., work done by IncrementalIndex).
DimensionMerger	Processing related interface A DimensionMerger is a per-dimension stateful object that encapsulates type-specific operations and data structures used during the segment merging process (i.e., work done by IndexMerger).
DimensionMergerV9	Processing related interface DimensionMerger subclass to be used with IndexMergerV9.
DimensionSelector	Selector for a string-typed column, either single- or multi-valued.
DoubleColumnSelector	This interface is convenient for implementation of "double-sourcing" ColumnValueSelectors, it provides default implementations for all ColumnValueSelector's methods except BaseDoubleColumnValueSelector.getDouble().
FloatColumnSelector	This interface is convenient for implementation of "float-sourcing" ColumnValueSelectors, it provides default implementations for all ColumnValueSelector's methods except BaseFloatColumnValueSelector.getFloat().
GenericColumnSerializer<T>	GenericColumnSerializer can be implemented in custom aggregator extensions that would like to take full control of column serialization.
IdLookup	"Mixin" for DimensionSelector.
IndexableAdapter	An adapter to an index
IndexMerger
LongColumnSelector	This interface is convenient for implementation of "long-sourcing" ColumnValueSelectors, it provides default implementations for all ColumnValueSelector's methods except BaseLongColumnValueSelector.getLong().
ProgressIndicator
QueryableIndex	Direct interface to memory mapped segments.
ReferenceCountedObject	Interface for an object that may have a reference acquired in the form of a Closeable.
RowAdapter<RowType>	An adapter between arbitrary types and the needs of callers that want to read specific columns out of those types (treating them as rows).
RowIdSupplier	Returned by ColumnSelectorFactory.getRowIdSupplier().
RowIterator	Extension of TimeAndDimsIterator, specialized for RowPointer instead of TimeAndDimsPointer.
Segment	The difference between this class and DataSegment is that DataSegment contains the segment metadata only, while this class represents the actual body of segment data, queryable.
SegmentLazyLoadFailCallback
SegmentReference	A Segment with a associated references, such as ReferenceCountingSegment where the reference is the segment itself, and HashJoinSegment which wraps a ReferenceCountingSegment and also includes the associated list of JoinableClause
SegmentWrangler	Utility for creating Segment objects for concrete datasources.
StorageAdapter
TimeAndDimsIterator	TimeAndDimsIterator (in conjunction with TimeAndDimsPointer) is an Iterator-like abstraction, designed for allocation-free transformation, merging, combining and iteration over a stream of data points.
TransformableRowIterator	TransformableRowIterator tightens RowIterator.getPointer() contract, that allows to transform iterated rows without allocations on each iterations, and reuse the mechanics of the underlying iterator.
VectorColumnProcessorFactory<T>	Class that encapsulates knowledge about how to create vector column processors.
VirtualColumn	Virtual columns are "views" created over a ColumnSelectorFactory or ColumnSelector.

Class Summary

Class	Description
AbstractDimensionSelector	An abstract class that provides an implementation of AbstractDimensionSelector.getObject().
AbstractSegment	Deprecated. use Segment directly as this does nothing
ArrayListSegment<RowType>	A Segment that is based on a stream of objects.
AutoTypeColumnIndexer
AutoTypeColumnMerger	Column merger for AutoTypeColumnIndexer to eventually produce some form of NestedCommonFormatColumn.
AutoTypeColumnMerger.ArrayDictionaryMergingIterator
AutoTypeColumnMerger.IdLookupArrayIterator
AutoTypeColumnSchema	Common DimensionSchema for ingestion of 'standard' Druid built-in ColumnType datatypes.
BaseProgressIndicator
BaseSingleValueDimensionSelector
BitmapOffset
ColumnCache
ColumnProcessors	Creates "column processors", which are objects that wrap a single input column and provide some functionality on top of it.
ColumnSelectorColumnIndexSelector
ComparatorDimensionDictionary<T>	Comparator based DimensionDictionary there are a lot of unused methods in here for now since the only thing this is used for is to build up the unsorted dictionary and then it is converted to a ComparatorSortedDimensionDictionary, but leaving the unused methods in place for now to be basically compatible with the other implementation.
ComparatorSortedDimensionDictionary<T>	Comparator based SortedDimensionDictionary There are a number of unused methods, because nested columns don't merge bitmap indexes during the merge phase, rather they are created when serializing the column, but leaving for now for compatibility with the other implementation
CompressedPools
ConstantDimensionSelector
ConstantExprEvalSelector
ConstantMultiValueDimensionSelector
DataSegmentsWithSchemas	This immutable class encapsulates segments metadata and corresponding schema.
DataSegmentWithMetadata	Immutable wrapper class for segment and schema.
DefaultColumnFormatConfig
DeprecatedQueryableIndexColumnSelector	Deprecated.
DictionaryEncodedColumnIndexer<KeyType,ActualType extends Comparable<ActualType>>	Basic structure for indexing dictionary encoded columns
DictionaryEncodedColumnMerger<T extends Comparable<T>>	Base structure for merging dictionary encoded columns
DictionaryEncodedColumnMerger.ConvertingBitmapValues
DictionaryEncodedColumnMerger.IndexSeekerWithConversion	Get old dictId from new dictId, and only support access in order
DictionaryEncodedColumnMerger.IndexSeekerWithoutConversion
DictionaryMergingIterator<T extends Comparable<T>>	Iterator for merging dictionaries for some comparable type into a single sorted dictionary, useful when merging dictionary encoded columns
DimensionDictionary<T extends Comparable<T>>	Buildable dictionary for some comparable type.
DimensionHandlerUtils
DimensionSelector.NullDimensionSelectorHolder	This class not a public API.
DimensionSelectorUtils
DoubleColumnSerializer
DoubleColumnSerializerV2	Column Serializer for double column.
DoubleDimensionHandler
DoubleDimensionIndexer
DoubleDimensionMergerV9
DoubleWrappingDimensionSelector
EncodedKeyComponent<K>	Represents the encoded component of a row key corresponding to a single dimension.
FilteredOffset
FilteredStorageAdapter
FloatColumnSerializer
FloatColumnSerializerV2	Column Serializer for float column.
FloatDimensionHandler
FloatDimensionIndexer
FloatDimensionMergerV9
FloatWrappingDimensionSelector
ForwardingRowIterator	Implementation of TransformableRowIterator that just delegates all methods to some baseIterator (adapter pattern).
IdMapping	Map some set of dictionary id to a smaller set of dictionaryIds (or...
IdMapping.Builder
IncrementalIndexSegment
IndexableAdapter.NestedColumnMergable
IndexIO
IndexIO.DefaultIndexIOHandler
IndexMergerV9
IndexMergerV9Factory
IndexSpec	IndexSpec defines segment storage format options to be used at indexing time, such as bitmap type, and column compression formats.
IndexSpec.Builder
IntIteratorUtils
IntListUtils
LongColumnSerializer	Unsafe for concurrent use from multiple threads.
LongColumnSerializerV2	Column Serializer for long column.
LongDimensionHandler
LongDimensionIndexer
LongDimensionMergerV9
LongWrappingDimensionSelector
Metadata
MetricHolder
MMappedIndex
NestedCommonFormatColumnHandler
NestedDataColumnHandlerV4
NestedDataColumnIndexerV4
NestedDataColumnMergerV4
NestedDataColumnSchema	Nested column DimensionSchema.
NilColumnValueSelector	Represents "absent" column.
NumericDimensionMergerV9	Common base of LongDimensionMergerV9, DoubleDimensionMergerV9 and FloatDimensionMergerV9.
ObjectBasedColumnSelector<T>	Object based column selector.
ObjectColumnSelector<T>	Restricts selector usage to only allow BaseObjectColumnValueSelector.getObject().
QueryableIndexColumnSelectorFactory	The basic implementation of ColumnSelectorFactory over a historical segment (i.
QueryableIndexCursorSequenceBuilder
QueryableIndexCursorSequenceBuilder.AscendingTimestampCheckingOffset
QueryableIndexCursorSequenceBuilder.DescendingTimestampCheckingOffset
QueryableIndexCursorSequenceBuilder.TimestampCheckingOffset
QueryableIndexIndexableAdapter
QueryableIndexSegment
QueryableIndexStorageAdapter
ReferenceCountingCloseableObject<BaseObject extends Closeable>	ReferenceCountingCloseableObject implements something like automatic reference count-based resource management, backed by a Phaser.
ReferenceCountingSegment	Segment that is also a ReferenceCountingSegment, allowing query engines that operate directly on segments to track references so that dropping a Segment can be done safely to ensure there are no in-flight queries.
RowAdapters	Utility class for creating RowAdapter.
RowBasedColumnSelectorFactory<T>	A ColumnSelectorFactory that is based on an object supplier and a RowAdapter for that type of object.
RowBasedCursor<RowType>	A Cursor that is based on a stream of objects.
RowBasedSegment<RowType>	A Segment that is based on a stream of objects.
RowBasedStorageAdapter<RowType>	A StorageAdapter that is based on a stream of objects.
RowNumCounter	Could be used as a simple "row number supplier" for RowPointer implementations.
RowPointer	Extension of TimeAndDimsPointer, that keeps "row number" of the current data point in some collection of data points, that actually makes this data point to be called "row", and the collection, thus, "collection of rows".
RowWalker<T>	Used by RowBasedStorageAdapter and RowBasedCursor to walk through rows.
SchemaPayload	Representation of schema payload, includes information like RowSignature and aggregator factories.
SchemaPayloadPlus	Wrapper over SchemaPayload to include numRows information.
SegmentMetadata	Encapsulates segment level information like numRows, schema fingerprint.
SegmentSchemaMapping	Compact representation of segment schema for multiple segments.
SegmentUtils	Utility methods useful for implementing deep storage extensions.
SimpleAscendingOffset
SimpleDescendingOffset
SimpleDictionaryMergingIterator<T extends Comparable<T>>	Use a PriorityQueue to merge sorted Indexed based value-lookups using PeekingIterator
SimpleQueryableIndex
SimpleSettableOffset
SingleScanTimeDimensionSelector	A special DimensionSelector for projected time columns - it assumes time values are scanned once and values are grouped together (i.e.
SortedDimensionDictionary<T extends Comparable<T>>	Creates a sorted dictionary given some existing dictionary, storing a mapping of both sorted id to unsorted id and unsorted id to sorted id
StringDimensionDictionary	DimensionDictionary for String dimension values.
StringDimensionHandler
StringDimensionIndexer
StringDimensionMergerV9
TimeAndDimsPointer	TimeAndDimsPointer is used in conjunction with TimeAndDimsIterator, it's an _immutable_ object that points to different logical data points, as TimeAndDimsIterator.moveToNext() is called.
UnnestColumnValueSelectorCursor	The cursor to help unnest MVDs without dictionary encoding and ARRAY type selectors.
UnnestDimensionCursor	The cursor to help unnest MVDs with dictionary encoding.
UnnestStorageAdapter	This class serves as the Storage Adapter for the Unnest Segment and is responsible for creating the cursors If the column is dictionary encoded it creates UnnestDimensionCursor else UnnestColumnValueSelectorCursor These cursors help navigate the segments for these cases
VirtualColumns	Class allowing lookup and usage of virtual columns.
VirtualColumns.JsonIncludeFilter	JsonInclude filter for getVirtualColumns().
WrappedSegmentReference	This class is used as a wrapper for other classes that just want to modify the storage adapter for a datasource.

Enum Summary

Enum	Description
MetricHolder.MetricType

Exception Summary

Exception	Description
SegmentMissingException
SegmentValidationException