org.apache.druid.query.dimension

Interface DimensionSpec

All Superinterfaces:

Cacheable

All Known Implementing Classes:

BaseFilteredDimensionSpec, DefaultDimensionSpec, ExtractionDimensionSpec, LegacyDimensionSpec, ListFilteredDimensionSpec, LookupDimensionSpec, PrefixFilteredDimensionSpec, RegexFilteredDimensionSpec

@SubclassesMustOverrideEqualsAndHashCode
public interface DimensionSpec
extends Cacheable

Provides information about a dimension for a grouping query, like topN or groupBy. Note that this is not annotated with PublicApi, since it is not meant to be stable for usage by non-built-in queries.

Method Summary

Modifier and Type	Method and Description
default boolean	canVectorize() Does this DimensionSpec have working decorate(SingleValueDimensionVectorSelector) and decorate(MultiValueDimensionVectorSelector) methods?
DimensionSelector	decorate(DimensionSelector selector)
default MultiValueDimensionVectorSelector	decorate(MultiValueDimensionVectorSelector selector)
default SingleValueDimensionVectorSelector	decorate(SingleValueDimensionVectorSelector selector)
String	getDimension()
ExtractionFn	getExtractionFn() Deprecated.
String	getOutputName()
ValueType	getOutputType()
boolean	mustDecorate() Does this DimensionSpec require that decorate() be called to produce correct results?
boolean	preservesOrdering()
DimensionSpec	withDimension(String newDimension) Returns a copy of this DimensionSpec with the underlying dimension (the value of getDimension()) replaced by "newDimension".

Methods inherited from interface org.apache.druid.java.util.common.Cacheable

getCacheKey

Method Detail

getDimension

String getDimension()

getOutputName

String getOutputName()

getOutputType

ValueType getOutputType()

getExtractionFn

@Deprecated
 @Nullable
ExtractionFn getExtractionFn()

Deprecated.

decorate

DimensionSelector decorate(DimensionSelector selector)

decorate

default SingleValueDimensionVectorSelector decorate(SingleValueDimensionVectorSelector selector)

decorate

default MultiValueDimensionVectorSelector decorate(MultiValueDimensionVectorSelector selector)

mustDecorate

boolean mustDecorate()

Does this DimensionSpec require that decorate() be called to produce correct results?

canVectorize

default boolean canVectorize()

Does this DimensionSpec have working decorate(SingleValueDimensionVectorSelector) and decorate(MultiValueDimensionVectorSelector) methods?

preservesOrdering

boolean preservesOrdering()

withDimension

DimensionSpec withDimension(String newDimension)

Returns a copy of this DimensionSpec with the underlying dimension (the value of getDimension()) replaced by "newDimension".