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) Decorate a DimensionSelector, allowing custom transformation of underlying behavior (e.g.
default MultiValueDimensionVectorSelector	decorate(MultiValueDimensionVectorSelector selector) Vectorized analog of #decorate(DimensionSelector) for {@link MultiValueDimensionVectorSelector}, most likely produced with {@link org.apache.druid.segment.vector.VectorColumnSelectorFactory#makeMultiValueDimensionSelector(DimensionSpec)} Decoration allows a {@link DimensionSpec} to customize the behavior of the underlying selector, for example transforming or filtering values.
default SingleValueDimensionVectorSelector	decorate(SingleValueDimensionVectorSelector selector) Vectorized analog of decorate(DimensionSelector) for SingleValueDimensionVectorSelector, most likely produced with VectorColumnSelectorFactory.makeSingleValueDimensionSelector(DimensionSpec) Decoration allows a DimensionSpec to customize the behavior of the underlying selector, for example transforming or filtering values.
String	getDimension()
ExtractionFn	getExtractionFn() Deprecated.
String	getOutputName()
ColumnType	getOutputType()
boolean	mustDecorate() Does this DimensionSpec require that decorate() be called to produce correct results?
boolean	preservesOrdering() If the decorate(org.apache.druid.segment.DimensionSelector) methods alter the underlying behavior of the dimension selector, does this alteration preserve the original ordering?
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

ColumnType getOutputType()

getExtractionFn

@Deprecated
 @Nullable
ExtractionFn getExtractionFn()

Deprecated.

decorate

DimensionSelector decorate(DimensionSelector selector)

Decorate a DimensionSelector, allowing custom transformation of underlying behavior (e.g. performing extraction functions in the case of ExtractionDimensionSpec, regex filtering in the case of RegexFilteredDimensionSpec, and so on).

decorate

default SingleValueDimensionVectorSelector decorate(SingleValueDimensionVectorSelector selector)

Vectorized analog of decorate(DimensionSelector) for SingleValueDimensionVectorSelector, most likely produced with VectorColumnSelectorFactory.makeSingleValueDimensionSelector(DimensionSpec) Decoration allows a DimensionSpec to customize the behavior of the underlying selector, for example transforming or filtering values.

decorate

default MultiValueDimensionVectorSelector decorate(MultiValueDimensionVectorSelector selector)

Vectorized analog of #decorate(DimensionSelector) for {@link MultiValueDimensionVectorSelector}, most likely produced with {@link org.apache.druid.segment.vector.VectorColumnSelectorFactory#makeMultiValueDimensionSelector(DimensionSpec)} Decoration allows a {@link DimensionSpec} to customize the behavior of the underlying selector, for example transforming or filtering values.

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()

If the decorate(org.apache.druid.segment.DimensionSelector) methods alter the underlying behavior of the dimension selector, does this alteration preserve the original ordering?

withDimension

DimensionSpec withDimension(String newDimension)

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