Package org.apache.druid.query.dimension

Class DefaultDimensionSpec

java.lang.Object

org.apache.druid.query.dimension.DefaultDimensionSpec

All Implemented Interfaces:

Cacheable, DimensionSpec

Direct Known Subclasses:

LegacyDimensionSpec

public class DefaultDimensionSpec
extends Object
implements DimensionSpec

Constructor Summary

Constructors

Constructor	Description
DefaultDimensionSpec(String dimension, String outputName)
DefaultDimensionSpec(String dimension, String outputName, ColumnType outputType)

Method Summary

Modifier and Type	Method	Description
boolean	canVectorize()	Does this DimensionSpec have working DimensionSpec.decorate(SingleValueDimensionVectorSelector) and DimensionSpec.decorate(MultiValueDimensionVectorSelector) methods?
DimensionSelector	decorate(DimensionSelector selector)	Decorate a DimensionSelector, allowing custom transformation of underlying behavior (e.g.
MultiValueDimensionVectorSelector	decorate(MultiValueDimensionVectorSelector selector)	Vectorized analog of invalid input: '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.'
SingleValueDimensionVectorSelector	decorate(SingleValueDimensionVectorSelector selector)	Vectorized analog of DimensionSpec.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.
boolean	equals(Object o)
byte[]	getCacheKey()	Get a byte array used as a cache key.
String	getDimension()
ExtractionFn	getExtractionFn()
String	getOutputName()
ColumnType	getOutputType()
int	hashCode()
boolean	mustDecorate()	Does this DimensionSpec require that decorate() be called to produce correct results?
static DefaultDimensionSpec	of(String dimensionName)
static DefaultDimensionSpec	of(String dimensionName, ColumnType columnType)
boolean	preservesOrdering()	If the DimensionSpec.decorate(org.apache.druid.segment.DimensionSelector) methods alter the underlying behavior of the dimension selector, does this alteration preserve the original ordering?
String	toString()
DimensionSpec	withDimension(String newDimension)	Returns a copy of this DimensionSpec with the underlying dimension (the value of DimensionSpec.getDimension()) replaced by "newDimension".

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DefaultDimensionSpec

public DefaultDimensionSpec(String dimension,
 @Nullable
 String outputName,
 @Nullable
 ColumnType outputType)

DefaultDimensionSpec

public DefaultDimensionSpec(String dimension,
 String outputName)

Method Details

of

public static DefaultDimensionSpec of(String dimensionName)

of

public static DefaultDimensionSpec of(String dimensionName,
 ColumnType columnType)

getDimension

public String getDimension()

Specified by:

getDimension in interface DimensionSpec

getOutputName

public String getOutputName()

Specified by:

getOutputName in interface DimensionSpec

getOutputType

public ColumnType getOutputType()

Specified by:

getOutputType in interface DimensionSpec

getExtractionFn

public ExtractionFn getExtractionFn()

Specified by:

getExtractionFn in interface DimensionSpec

decorate

public DimensionSelector decorate(DimensionSelector selector)

Description copied from interface: DimensionSpec

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

Specified by:

decorate in interface DimensionSpec

decorate

public SingleValueDimensionVectorSelector decorate(SingleValueDimensionVectorSelector selector)

Description copied from interface: DimensionSpec

Vectorized analog of DimensionSpec.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.

Specified by:

decorate in interface DimensionSpec

decorate

public MultiValueDimensionVectorSelector decorate(MultiValueDimensionVectorSelector selector)

Description copied from interface: DimensionSpec

Vectorized analog of invalid input: '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.'

Specified by:

decorate in interface DimensionSpec

canVectorize

public boolean canVectorize()

Description copied from interface: DimensionSpec

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

Specified by:

canVectorize in interface DimensionSpec

mustDecorate

public boolean mustDecorate()

Description copied from interface: DimensionSpec

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

Specified by:

mustDecorate in interface DimensionSpec

getCacheKey

public byte[] getCacheKey()

Description copied from interface: Cacheable

Get a byte array used as a cache key.

Specified by:

getCacheKey in interface Cacheable

Returns:

bytes to be used as cache key - or null if this object should not be cached.

preservesOrdering

public boolean preservesOrdering()

Description copied from interface: DimensionSpec

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

Specified by:

preservesOrdering in interface DimensionSpec

withDimension

public DimensionSpec withDimension(String newDimension)

Description copied from interface: DimensionSpec

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

Specified by:

withDimension in interface DimensionSpec

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object