Package org.apache.druid.query.extraction

Class StringFormatExtractionFn

java.lang.Object

org.apache.druid.query.extraction.DimExtractionFn

org.apache.druid.query.extraction.StringFormatExtractionFn

All Implemented Interfaces:

Cacheable, ExtractionFn

public class StringFormatExtractionFn
extends DimExtractionFn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringFormatExtractionFn.NullHandling

Nested classes/interfaces inherited from interface org.apache.druid.query.extraction.ExtractionFn

ExtractionFn.ExtractionType

Constructor Summary

Constructors

Constructor	Description
StringFormatExtractionFn(String format)
StringFormatExtractionFn(String format, StringFormatExtractionFn.NullHandling nullHandling)

Method Summary

Modifier and Type	Method	Description
String	apply(String value)	The "extraction" function.
boolean	equals(Object o)
byte[]	getCacheKey()	Get a byte array used as a cache key.
ExtractionFn.ExtractionType	getExtractionType()	A dim extraction can be of one of two types, renaming or rebucketing.
String	getFormat()
StringFormatExtractionFn.NullHandling	getNullHandling()
int	hashCode()
boolean	preservesOrdering()	Offers information on whether the extraction will preserve the original ordering of the values.
String	toString()

Methods inherited from class org.apache.druid.query.extraction.DimExtractionFn

apply, apply

Methods inherited from class java.lang.Object

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

Constructor Detail

StringFormatExtractionFn

public StringFormatExtractionFn(String format,
                                StringFormatExtractionFn.NullHandling nullHandling)

StringFormatExtractionFn

public StringFormatExtractionFn(String format)

Method Detail

getFormat

public String getFormat()

getNullHandling

public StringFormatExtractionFn.NullHandling getNullHandling()

getCacheKey

public byte[] getCacheKey()

Description copied from interface: Cacheable

Get a byte array used as a cache key.

Returns:

a cache key

apply

@Nullable
public String apply(@Nullable
                    String value)

Description copied from interface: ExtractionFn

The "extraction" function. This should map a String value into some other String value.

Like ExtractionFn.apply(Object), the empty string is considered invalid output for this method and it should instead return null.

Parameters:

value - the original value of the dimension

Returns:

a value that should be used instead of the original

preservesOrdering

public boolean preservesOrdering()

Description copied from interface: ExtractionFn

Offers information on whether the extraction will preserve the original ordering of the values.

Some optimizations of queries is possible if ordering is preserved. Null values *do* count towards ordering.

Returns:

true if ordering is preserved, false otherwise

getExtractionType

public ExtractionFn.ExtractionType getExtractionType()

Description copied from interface: ExtractionFn

A dim extraction can be of one of two types, renaming or rebucketing. In the `ONE_TO_ONE` case, a unique values is modified into another unique value. In the `MANY_TO_ONE` case, there is no longer a 1:1 relation between old dimension value and new dimension value

Returns:

ExtractionFn.ExtractionType declaring what kind of manipulation this function does

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object