Package org.apache.druid.frame.segment

Class FrameSegment

java.lang.Object

org.apache.druid.frame.segment.FrameSegment

All Implemented Interfaces:

Closeable, AutoCloseable, Segment

public class FrameSegment
extends Object
implements Segment

A Segment implementation based on a single Frame. This class is used for both columnar and row-based frames.

Constructor Summary

Constructors

Constructor	Description
FrameSegment(Frame frame, FrameReader frameReader)

Method Summary

Modifier and Type	Method	Description
<T> T	as(Class<T> clazz)	Request an implementation of a particular interface.
void	close()
org.joda.time.Interval	getDataInterval()
SegmentId	getId()	Returns the SegmentId of this segment, if it is backed by a real table, otherwise returns null.

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.Segment

getDebugString, isTombstone, validateOrElseThrow

Constructor Details

FrameSegment

public FrameSegment(Frame frame,
 FrameReader frameReader)

Method Details

getId

public SegmentId getId()

Description copied from interface: Segment

Returns the SegmentId of this segment, if it is backed by a real table, otherwise returns null.

Specified by:

getId in interface Segment

getDataInterval

public org.joda.time.Interval getDataInterval()

Specified by:

getDataInterval in interface Segment

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

as

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

Description copied from interface: Segment

Request an implementation of a particular interface.

All implementations of this method should be able to provide a CursorFactory. Other interfaces are only expected to be requested by callers that have specific knowledge of extra features provided by specific segment types. For example, an extension might provide a custom Segment type that can offer both CursorFactory and some new interface. That extension can also offer a Query that uses that new interface.

Implementations which accept classes other than known built-in interfaces such as CursorFactory are limited to using those classes within the extension. This means that one extension cannot rely on the `Segment.as` behavior of another extension.

Specified by:

as in interface Segment

Type Parameters:

T - desired interface

Parameters:

clazz - desired interface

Returns:

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

• CursorFactory, to make cursors to run queries. Never null.
• QueryableIndex, index object, if this is a memory-mapped regular segment.
• IndexedTable, table object, if this is a joinable indexed table.
• TimeBoundaryInspector, inspector for min/max timestamps, if supported by this segment.
• PhysicalSegmentInspector, inspector for physical segment details, if supported by this segment.
• MaxIngestedEventTimeInspector, inspector for DataSourceMetadataResultValue.getMaxIngestedEventTime()
• TopNOptimizationInspector, inspector containing information for topN specific optimizations
• CloseableShapeshifter, stepping stone to RowsAndColumns.
• BypassRestrictedSegment, a policy-aware segment, converted from a policy-enforced segment.