Package org.apache.druid.query.dimension

Class ExtractionDimensionSpec

java.lang.Object

org.apache.druid.query.dimension.ExtractionDimensionSpec

All Implemented Interfaces:

Cacheable, DimensionSpec

public class ExtractionDimensionSpec
extends Object
implements DimensionSpec

Constructor Summary

Constructors

Constructor	Description
ExtractionDimensionSpec(String dimension, String outputName, ExtractionFn extractionFn)
ExtractionDimensionSpec(String dimension, String outputName, ColumnType outputType, ExtractionFn extractionFn)
ExtractionDimensionSpec(String dimension, String outputName, ColumnType outputType, ExtractionFn extractionFn, ExtractionFn dimExtractionFn)

Method Summary

Modifier and Type	Method	Description
DimensionSelector	decorate(DimensionSelector selector)	Decorate a DimensionSelector, allowing custom transformation of underlying behavior (e.g.
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?
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

Methods inherited from interface org.apache.druid.query.dimension.DimensionSpec

canVectorize, decorate, decorate

Constructor Details

ExtractionDimensionSpec

public ExtractionDimensionSpec(String dimension,
 String outputName,
 ColumnType outputType,
 ExtractionFn extractionFn,
 @Deprecated
 ExtractionFn dimExtractionFn)

ExtractionDimensionSpec

public ExtractionDimensionSpec(String dimension,
 String outputName,
 ExtractionFn extractionFn)

ExtractionDimensionSpec

public ExtractionDimensionSpec(String dimension,
 String outputName,
 ColumnType outputType,
 ExtractionFn extractionFn)

Method Details

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

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